Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve fetch document #53

Merged
merged 5 commits into from
Mar 6, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Reference: https://git-scm.com/docs/git-config/2.6.7#_example
asmanp2012 marked this conversation as resolved.
Show resolved Hide resolved
[core]
autocrlf = input
9 changes: 9 additions & 0 deletions package/fetch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

Enhanced fetch api with timeout, helper methods and types written in tiny TypeScript, ES module.

## Options

`Options` inherited from the `RequestInit`. you can watch all documents of the parameters RequestInit in [`fetch init parameters`](https://developer.mozilla.org/en-US/docs/Web/API/fetch#parameters)

Options have two other parameters:

- `bodyObject`: a json object that convert to string and put on the body.
- `queryParameters`: a json object that convert to url query parames
asmanp2012 marked this conversation as resolved.
Show resolved Hide resolved

## Example usage

```js
Expand Down