Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Icaruk/dame
dame is a minimalistic HTTP client for the browser and Node.js
https://github.com/Icaruk/dame
fetch http https request
Last synced: 3 months ago
JSON representation
dame is a minimalistic HTTP client for the browser and Node.js
- Host: GitHub
- URL: https://github.com/Icaruk/dame
- Owner: Icaruk
- Created: 2021-06-16T10:07:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T15:29:35.000Z (almost 2 years ago)
- Last Synced: 2024-07-16T18:51:33.037Z (4 months ago)
- Topics: fetch, http, https, request
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/dame
- Size: 965 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
dame
[](https://packagephobia.now.sh/result?p=dame) [](https://badgen.net/bundlephobia/minzip/dame) [](https://badgen.net/bundlephobia/dependency-count/dame)
[](https://coveralls.io/github/Icaruk/dame?branch=master)
**dame** minimalistic HTTP client for the browser and Node.js
- 🚀 Lightweight
- ⚪️ Zero dependencies.
- 😀 **Easy** to use.
- 🟢 **Node** (http & https) and 💻 **browser** (Fetch).
- 👉 **Promise** API.
- ⌛ Custom **timeout**.
- 📄 Automatic transforms to **JSON** data.
- ⏭ Follows **redirects**.
📃 [Changelog](https://github.com/Icaruk/dame/releases)
# Table of contents
- [Table of contents](#table-of-contents)
- [Import](#import)
- [Basic examples](#basic-examples)
- [Response object](#response-object)
- [Methods](#methods)
- [get](#get)
- [post, put, delete, patch](#post-put-delete-patch)
- [Config](#config)
- [Configuring base instance](#configuring-base-instance)
- [Creating an instance](#creating-an-instance)
- [Examples](#examples)
- [Editing an instance](#editing-an-instance)
- [Special statuses](#special-statuses)
- [dame vs. others](#dame-vs-others)
- [☝ Return to top](#-return-to-top)
# Import
```js
const dame = require("dame");
```
# Basic examples
**GET**
```js
let {response} = dame.get("https://rickandmortyapi.com/api/location/1");
```
**POST**
```js
let {response} = dame.post("https://your.api.com/login", {
username: "Username",
password: "****",
});
```
# Response object
```js
{
isError: false,
code: 200,
status: "OK",
response: {...},
error: null,
redirectCount: 3,
}
```
- **isError** `boolean`: True if code is >= 200 and < 300 (this is configurable).
- **code** `number`: Status code.
- **status** `string`: Status.
- **response** `any`: Response of the request.
- **error** `any`: If there was any error during the request it will be here.
- **redirectCount** `number`: How many redirects have been followed. Not present if there have been no redirects.
The response can be destructured like this:
```js
let {isError, code, status, response} = dame.get("https://rickandmortyapi.com/api/location/1");
```
# Methods
## get
```js
const {response} = dame.get(url, config);
```
- **url** `string`: Full URL or path.
- If you set a `baseUrl`, this `url` will be concatenated to it: `baseUrl + url`.
- If `url` starts with `"http://"` or `"https://"` the `baseUrl` from config will be ignored and url will be treated like a full url.
- **config** `object`: See [Config](#config).
## post, put, delete, patch
```js
const {response} = dame.post(url, body, config);
```
- **url** `string`:See [get](#get).
- **body** `object`: The request body.
- **config** `object`: See [Config](#config).
# Config
- **baseUrl** `string`: Base URL that will be concatenated with the `url` of the requests.
- **headers** `object`: Headers that will be attached to the request.
- **timeout** `number`: Number of miliseconds that must pass before timeout the request.
- **checkIsError** `function`: Function that will receive the status code (`number`) and must return `boolean`. Default `isError = !(code >= 200 && < 300)`.
- Any option that fits on [request](https://nodejs.org/api/https.html#https_https_request_url_options_callback) or [fetch](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch).
- **maxRedirects** `number`: Max redirects to follow. Default 20. Use 0 to disable redirects.
- **responseType** `"arraybuffer" | "stream" | "json" | "text"`: **Browser only**. Default `"json"`. Type of the data that the server will respond with.
# Configuring base instance
Syntax:
```js
dame. = ;
```
- **configKey**: any key from [Config](#config).
- **value**: any value that fits on the config key.
Examples:
```js
dame.baseUrl = "http://localhost:3010";
dame.headers.Authorization = `Bearer abcd.1234`;
dame.timeout = 5000;
```
Then you'll be able to:
```js
dame.get("/protectedRoute");
// url will be → http://localhost:3010/protectedRoute
// headers will be → {Authorization: "Bearer abcd.1234"}
```
# Creating an instance
```js
const dameInstance = dame.new(config, instanceName?);
```
- **config** `object`: See [Config](#config).
- **instanceName** `string`: (optional) If filled, this instance will be saved on `dame.instances.`.
---
Removing a saved instance:
```js
delete dame.instances.
```
## Examples
Set base URL
```js
const yourApi = dame.new({
"baseUrl": "http://localhost:3000",
});
```
Set headers
```js
const yourApi = dame.new({
"headers": {
Authorization: "Bearer abc.123"
}
});
```
## Editing an instance
```js
yourApi.headers.Authorization: "Bearer new.token";
```
# Special statuses
Timeout
```js
{
isError: true,
code: 0,
status: 'Timed out',
response: null
}
```
No response
```js
{
isError: true,
code: -1,
status: "No response from server",
response: null
}
```
Offline
```js
{
isError: true,
code: -2,
status: "No internet connection",
response: null
}
```
# dame vs. others
Package | Browser + Node | Dependencies | Size
:---: | :---: | :---: | :---:
**dame** | ✅ | **0** | [](https://packagephobia.now.sh/result?p=dame)
phin | ❌ |  | [](https://packagephobia.now.sh/result?p=phin)
node-fetch | ❌ |  | [](https://packagephobia.now.sh/result?p=node-fetch)
axios | ✅ |  | [](https://packagephobia.now.sh/result?p=axios)
got | ❌ |  | [](https://packagephobia.now.sh/result?p=got)
superagent | ✅ |  | [](https://packagephobia.now.sh/result?p=superagent)
request | ❌ |  | [](https://packagephobia.now.sh/result?p=request)