https://github.com/brianleroux/tiny-json-http

:anchor: Minimalist HTTP client for JSON payloads.
https://github.com/brianleroux/tiny-json-http

Last synced: 13 days ago
JSON representation

:anchor: Minimalist HTTP client for JSON payloads.

• Host: GitHub
• URL: https://github.com/brianleroux/tiny-json-http
• Owner: brianleroux
• Created: 2016-10-30T06:48:27.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2023-03-29T22:14:36.000Z (over 1 year ago)
• Last Synced: 2024-10-29T23:50:02.115Z (13 days ago)
• Language: JavaScript
• Homepage:
• Size: 95.7 KB
• Stars: 172
• Watchers: 12
• Forks: 18
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# tiny-json-http

Minimalist `HTTP` client for `GET`, `POST`, `PUT`, `PATCH` and `DELETE` `JSON` payloads

- Zero dependencies: perfect for AWS Lambda

- Sensible default: assumes buffered JSON responses

- System symmetry: Node style errback API, or Promises for use with Async/Await

```bash

npm i tiny-json-http --save

```

### API

#### Read methods

- `tiny.get(options[, callback])`

- `tiny.head(options[, callback])`

- `tiny.options(options[, callback])`

#### Write methods

- `tiny.post(options[, callback])`

- `tiny.put(options[, callback])`

- `tiny.patch(options[, callback])`

- `tiny.del(options[, callback)]`

_*callback is optional, tiny methods will return a promise if no callback is provided_

### Options

- `url` *required*

- `data` form vars for `tiny.post`, `tiny.put`, `tiny.patch`, and `tiny.delete` otherwise querystring vars for `tiny.get`

- `headers` key/value map used for headers (including support for uploading files with `multipart/form-data`)

- `buffer` if set to `true` the response body is returned as a buffer

### Callback values

- `err` a real javascript `Error` if there was one

- `data` an object with `headers` and `body` keys

### Promises

- if no `callback` is provided to the tiny-json-http methods, a promise is returned

- perfect for use of async/await

## Examples

#### With Async / Await

```javascript

var tiny = require('tiny-json-http')

var url = 'http://www.randomkittengenerator.com'

;(async function _iife() {

  try {

    console.log(await tiny.get({url}))

  } catch (err) {

    console.log('ruh roh!', err)

  }

})();

```

#### With Callback

```javascript

var tiny = require('tiny-json-http')

var url = 'http://www.randomkittengenerator.com'

tiny.get({url}, function _get(err, result) {

  if (err) {

    console.log('ruh roh!', err)

  }

  else {

    console.log(result)

  }

})

```

Check out the tests for more examples! :heart_decoration: