README.md

🚚

Aika

A minimal, asynchronous HTTP client for Node.js

This library is not feature complete yet.

Everything is asynchronous.

Progress

• Basic requests
• Bodies and querystrings
• Header Builder
• General middleware
• Tests
• Documentation

Usage

(Some features are planned and not implemented)

const Aika = require('aika')

const aika = new Aika()

// Middleware support (planned)
aika.use(headerBuilder)

// Perform HTTP(S) requests
aika.host('google.com')
    .get('/search', {q: 'horses'})
    .then(res => console.log(res))
    .catch(err => console.log(err))

// Parse JSON response
aika.host('cat-fact.herokuapp.com')
    .get('/facts')
    .then(res => console.log(res.json()))
    .catch(err => console.log(err))

Middleware

A middleware is any object that has a middleware function. The function should take a request object as its only parameter and return it after doing it's thing.

Development

First, clone the repo, and do npm install.

Run tests with npm test.

Run linter with npm run lint

Do not commit directly to master. Preferably, make a branch or fork out of the development branch and make a pull request.

License

MIT © 2019 Sondre Gjellestad