tiny-json-http

Depending on how you call the API, the response format differs:

Using Callbacks If a callback is provided, it receives two arguments:

1. err: A JavaScript Error object if the request failed.
2. data: An object containing the response headers and body.

Using Promises If no callback is provided, the method returns a Promise that resolves to the same data object ({ headers, body }) or rejects with an err.

Install the tiny-json-http package via npm to use it as a minimalist HTTP client for JSON payloads. It has zero dependencies, making it suitable for environments like AWS Lambda.

npm i tiny-json-http --save

To use the traditional Node-style callback API, pass a function as the second argument to the method. The function follows the (err, result) signature.

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)
  }
})

To use the Promise-based API, omit the callback argument and use await within an async function. Wrap the call in a try/catch block to handle errors.

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)
  }
})();

The library provides methods for both reading and writing data. If you do not provide a callback function, the methods return a Promise, allowing for async/await syntax. Otherwise, they follow the Node-style error-first callback pattern.

// 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])

Pass an options object to any tiny method to configure the request.

• url (required): The target endpoint.
• data: For write methods (post, put, patch, del), this provides form variables. For get, this provides query string variables.
• headers: A key/value map for request headers (supports multipart/form-data for file uploads).
• buffer: If set to true, the response body is returned as a buffer instead of a parsed JSON object.

// Example configuration object
{
  url: 'http://example.com',
  data: { key: 'value' },
  headers: { 'Authorization': 'Bearer token' },
  buffer: true
}

The tiny-json-http module provides a set of high-level functions for performing standard HTTP methods. It distinguishes between read operations (GET, HEAD, OPTIONS) and write operations (POST, PUT, PATCH, DELETE).

• Read methods: get(), head(), and options() are used to retrieve data or metadata without modifying the resource.
• Write methods: post(), put(), patch(), del(), and delete() are used to create, update, or remove resources.

const http = require('tiny-json-http');

// Example usage (conceptual):
// http.get(url)
// http.post(url, data)
// http.del(url)

The following methods are exported by the module to handle specific HTTP verbs:

get: _read.bind({}, 'GET'),
head: _read.bind({}, 'HEAD'),
options: _read.bind({}, 'OPTIONS'),
post: _write.bind({}, 'POST'),
put: _write.bind({}, 'PUT'),
patch: _write.bind({}, 'PATCH'),
del: _write.bind({}, 'DELETE'),
delete: _write.bind({}, 'DELETE')