Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amaui-org/amaui-request
Request
https://github.com/amaui-org/amaui-request
amaui back-end backend browser front-end frontend http https javascript js node nodejs request requests typescript utils web
Last synced: about 2 months ago
JSON representation
Request
- Host: GitHub
- URL: https://github.com/amaui-org/amaui-request
- Owner: amaui-org
- License: mit
- Created: 2022-02-03T16:05:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T22:27:37.000Z (9 months ago)
- Last Synced: 2024-04-30T01:43:02.764Z (8 months ago)
- Topics: amaui, back-end, backend, browser, front-end, frontend, http, https, javascript, js, node, nodejs, request, requests, typescript, utils, web
- Language: TypeScript
- Homepage: https://docs.amaui.me/library/request
- Size: 224 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
amaui Request
Request
MIT license
Production ready
UMD 18.1kb gzipped
100% test cov
Browser and Nodejs
Very simple code
Modern code
Junior friendly
Typescript
Made with :yellow_heart:
## Getting started
### Add
```sh
yarn add @amaui/request
```
### Use
```javascript
import AmauiRequest from '@amaui/request';
// Make a new AmauiRequest instance
const amauiRequest = new AmauiRequest();
await amauiRequest.get('https://jsonplaceholder.typicode.com/posts/4');
// or as a static method without a new instance
await AmauiRequest.get('https://jsonplaceholder.typicode.com/posts/4');
// {
// response: {
// userId: 1,
// id: 4,
// title: 'eum et est occaecati',
// body: 'ullam et saepe reiciendis voluptatem adipisci\nsit amet autem assumenda provident rerum culpa\nquis hic commodi nesciunt rem tenetur doloremque ipsam iure\nquis sunt voluptatem rerum illo velit'
// },
// status: 200,
// headers: {
// cache-control: 'max-age=43200',
// content-type: 'application/json; charset=utf-8',
// expires: -1,
// pragma: 'no-cache'
// },
// request: {
// headers: {
// Accept: 'application/json, text/plain, */*'
// }
// },
// options: {
// method: 'GET',
// url: 'https://jsonplaceholder.typicode.com/posts/4',
// request: {
// headers: {
// Accept: 'application/json, text/plain, */*'
// },
// csrf: {
// cookie: 'CSRF-TOKEN',
// headers: 'X-CSRF-TOKEN'
// }
// },
// response: {
// resolveOnError: true,
// type: 'json',
// parse: {
// json: true
// }
// }
// }
// }
```
### Dev
Install
```sh
yarn
```
Test
```sh
yarn test
```
### Prod
Build
```sh
yarn build
```