Skip to content

Commit

Permalink
docs(@nf-team/fetch): docs에 문서 누락 세팅 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
saseungmin committed Sep 20, 2024
1 parent 35d6e12 commit 4580a3c
Show file tree
Hide file tree
Showing 11 changed files with 199 additions and 36 deletions.
16 changes: 8 additions & 8 deletions apps/docs/docs/core/modules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: "modules"
title: "@nf-team/core - v2.0.2"
title: "@nf-team/core - v2.1.0"
sidebar_label: "Exports"
sidebar_position: 0.5
custom_edit_url: null
Expand Down Expand Up @@ -30,7 +30,7 @@ custom_edit_url: null

#### Defined in

[utils.ts:44](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/core/src/utils.ts#L44)
[utils.ts:44](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/core/src/utils.ts#L44)

___

Expand All @@ -50,7 +50,7 @@ ___

#### Defined in

[utils.ts:26](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/core/src/utils.ts#L26)
[utils.ts:26](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/core/src/utils.ts#L26)

___

Expand All @@ -71,7 +71,7 @@ ___

#### Defined in

[utils.ts:34](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/core/src/utils.ts#L34)
[utils.ts:34](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/core/src/utils.ts#L34)

___

Expand All @@ -91,7 +91,7 @@ ___

#### Defined in

[utils.ts:64](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/core/src/utils.ts#L64)
[utils.ts:64](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/core/src/utils.ts#L64)

___

Expand All @@ -117,7 +117,7 @@ ___

#### Defined in

[utils.ts:52](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/core/src/utils.ts#L52)
[utils.ts:52](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/core/src/utils.ts#L52)

___

Expand Down Expand Up @@ -153,7 +153,7 @@ console.log(result); // 'newValue';

#### Defined in

[utils.ts:14](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/core/src/utils.ts#L14)
[utils.ts:14](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/core/src/utils.ts#L14)

___

Expand All @@ -173,4 +173,4 @@ ___

#### Defined in

[utils.ts:36](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/core/src/utils.ts#L36)
[utils.ts:36](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/core/src/utils.ts#L36)
2 changes: 1 addition & 1 deletion apps/docs/docs/fetch/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
label: "@nf-team/fetch"
position: 5
position: 4
2 changes: 1 addition & 1 deletion apps/docs/docs/fetch/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ custom_edit_url: null
[Issues](https://github.com/mbti-nf-team/frontend-libraries/issues)

## 🔒 LICENSE
This libraries is [MIT licensed](https://github.com/mbti-nf-team/frontend-libraries/blob/main/packages/core/LICENSE).
This libraries is [MIT licensed](https://github.com/mbti-nf-team/frontend-libraries/blob/main/packages/fetch/LICENSE).
63 changes: 63 additions & 0 deletions apps/docs/docs/fetch/interfaces/FetchApiRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
id: "FetchApiRequest"
title: "Interface: FetchApiRequest<K>"
sidebar_label: "FetchApiRequest"
sidebar_position: 0
custom_edit_url: null
---

## Type parameters

| Name | Type |
| :------ | :------ |
| `K` | `unknown` |

## Properties

### body

`Optional` **body**: `unknown`

#### Defined in

[fetch.ts:19](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/fetch/src/fetch.ts#L19)

___

### config

`Optional` **config**: `Omit`\<`RequestInit`, ``"method"`` \| ``"body"``\>

#### Defined in

[fetch.ts:20](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/fetch/src/fetch.ts#L20)

___

### method

`Optional` **method**: [`Method`](../modules.md#method)

#### Defined in

[fetch.ts:18](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/fetch/src/fetch.ts#L18)

___

### params

`Optional` **params**: `K`

#### Defined in

[fetch.ts:17](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/fetch/src/fetch.ts#L17)

___

### url

**url**: `string`

#### Defined in

[fetch.ts:16](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/fetch/src/fetch.ts#L16)
2 changes: 2 additions & 0 deletions apps/docs/docs/fetch/interfaces/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
label: "Interfaces"
position: 4
74 changes: 74 additions & 0 deletions apps/docs/docs/fetch/modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
id: "modules"
title: "@nf-team/fetch - v0.0.0"
sidebar_label: "Exports"
sidebar_position: 0.5
custom_edit_url: null
---

## Interfaces

- [FetchApiRequest](interfaces/FetchApiRequest.md)

## Type Aliases

### Method

Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"``

#### Defined in

[fetch.ts:3](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/fetch/src/fetch.ts#L3)

## Functions

### fetchApi

**fetchApi**\<`T`, `K`\>(`«destructured»`): `Promise`\<`T`\>

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | `T` |
| `K` | `unknown` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `«destructured»` | [`FetchApiRequest`](interfaces/FetchApiRequest.md)\<`K`\> |

#### Returns

`Promise`\<`T`\>

#### Defined in

[fetch.ts:28](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/fetch/src/fetch.ts#L28)

___

### paramsSerializer

**paramsSerializer**\<`T`\>(`params`): `string`

#### Type parameters

| Name |
| :------ |
| `T` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `params` | `T` |

#### Returns

`string`

#### Defined in

[fetch.ts:23](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/fetch/src/fetch.ts#L23)
2 changes: 1 addition & 1 deletion apps/docs/docs/react/modules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: "modules"
title: "@nf-team/react - v2.5.0"
title: "@nf-team/react - v2.7.1"
sidebar_label: "Exports"
sidebar_position: 0.5
custom_edit_url: null
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/docs/react/modules/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ function ClintOnlyComponent() {

#### Defined in

[packages/react/src/components/ClientOnly.tsx:22](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/components/ClientOnly.tsx#L22)
[packages/react/src/components/ClientOnly.tsx:22](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/components/ClientOnly.tsx#L22)

___

Expand All @@ -64,7 +64,7 @@ ___

#### Defined in

[packages/react/src/components/DelayRenderComponent.tsx:12](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/components/DelayRenderComponent.tsx#L12)
[packages/react/src/components/DelayRenderComponent.tsx:12](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/components/DelayRenderComponent.tsx#L12)

___

Expand Down Expand Up @@ -108,4 +108,4 @@ function SampleComponent() {

#### Defined in

[packages/react/src/components/GlobalPortal.tsx:34](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/components/GlobalPortal.tsx#L34)
[packages/react/src/components/GlobalPortal.tsx:34](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/components/GlobalPortal.tsx#L34)
30 changes: 15 additions & 15 deletions apps/docs/docs/react/modules/hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ custom_edit_url: null

#### Defined in

[packages/react/src/hooks/useActionKeyEvent.ts:6](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useActionKeyEvent.ts#L6)
[packages/react/src/hooks/useActionKeyEvent.ts:6](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useActionKeyEvent.ts#L6)

___

Expand Down Expand Up @@ -62,7 +62,7 @@ const [isOpen, openModal, closeModal, toggleModal] = useBoolean();

#### Defined in

[packages/react/src/hooks/useBoolean.ts:13](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useBoolean.ts#L13)
[packages/react/src/hooks/useBoolean.ts:13](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useBoolean.ts#L13)

___

Expand All @@ -89,7 +89,7 @@ ___

#### Defined in

[packages/react/src/hooks/useDebounce.ts:3](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useDebounce.ts#L3)
[packages/react/src/hooks/useDebounce.ts:3](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useDebounce.ts#L3)

___

Expand All @@ -109,7 +109,7 @@ ___

#### Defined in

[packages/react/src/hooks/useEffectOnce.ts:3](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useEffectOnce.ts#L3)
[packages/react/src/hooks/useEffectOnce.ts:3](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useEffectOnce.ts#L3)

___

Expand All @@ -123,7 +123,7 @@ ___

#### Defined in

[packages/react/src/hooks/useGeolocation.ts:15](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useGeolocation.ts#L15)
[packages/react/src/hooks/useGeolocation.ts:15](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useGeolocation.ts#L15)

___

Expand All @@ -137,7 +137,7 @@ ___

#### Defined in

[packages/react/src/hooks/useIsFirstRender.ts:3](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useIsFirstRender.ts#L3)
[packages/react/src/hooks/useIsFirstRender.ts:3](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useIsFirstRender.ts#L3)

___

Expand Down Expand Up @@ -169,7 +169,7 @@ useEffect(() => {

#### Defined in

[packages/react/src/hooks/useIsMounted.ts:18](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useIsMounted.ts#L18)
[packages/react/src/hooks/useIsMounted.ts:18](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useIsMounted.ts#L18)

___

Expand All @@ -196,11 +196,11 @@ Accepts a function that contains imperative, possibly effectful code.

**`See`**

https://react.dev/reference/react/useEffect
[https://react.dev/reference/react/useEffect](https://react.dev/reference/react/useEffect)

#### Defined in

node_modules/@types/react/index.d.ts:1095
node_modules/@types/react/index.d.ts:2031

___

Expand All @@ -221,7 +221,7 @@ ___

#### Defined in

[packages/react/src/hooks/useLessThenScrollY.ts:5](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useLessThenScrollY.ts#L5)
[packages/react/src/hooks/useLessThenScrollY.ts:5](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useLessThenScrollY.ts#L5)

___

Expand Down Expand Up @@ -251,7 +251,7 @@ function SampleComponent() {

#### Defined in

[packages/react/src/hooks/useResizeViewportHeight.ts:17](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useResizeViewportHeight.ts#L17)
[packages/react/src/hooks/useResizeViewportHeight.ts:17](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useResizeViewportHeight.ts#L17)

___

Expand Down Expand Up @@ -291,7 +291,7 @@ ___

#### Defined in

[packages/react/src/hooks/useThrottleCallback.ts:3](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useThrottleCallback.ts#L3)
[packages/react/src/hooks/useThrottleCallback.ts:3](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useThrottleCallback.ts#L3)

___

Expand All @@ -312,7 +312,7 @@ ___

#### Defined in

[packages/react/src/hooks/useTimeout.ts:5](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useTimeout.ts#L5)
[packages/react/src/hooks/useTimeout.ts:5](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useTimeout.ts#L5)

___

Expand All @@ -332,7 +332,7 @@ ___

#### Defined in

[packages/react/src/hooks/useUnmount.ts:5](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useUnmount.ts#L5)
[packages/react/src/hooks/useUnmount.ts:5](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useUnmount.ts#L5)

___

Expand All @@ -353,4 +353,4 @@ ___

#### Defined in

[packages/react/src/hooks/useUpdateEffect.ts:5](https://github.com/mbti-nf-team/frontend-libraries/blob/5614e38/packages/react/src/hooks/useUpdateEffect.ts#L5)
[packages/react/src/hooks/useUpdateEffect.ts:5](https://github.com/mbti-nf-team/frontend-libraries/blob/35d6e12/packages/react/src/hooks/useUpdateEffect.ts#L5)
Loading

0 comments on commit 4580a3c

Please sign in to comment.