-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(@nf-team/fetch): docs에 문서 누락 세팅 추가
- Loading branch information
1 parent
35d6e12
commit 4580a3c
Showing
11 changed files
with
199 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
label: "@nf-team/fetch" | ||
position: 5 | ||
position: 4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
label: "Interfaces" | ||
position: 4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.