https://github.com/anytv/cuddle

Cuddle
https://github.com/anytv/cuddle

http javascript node rest-api

Last synced: 24 days ago
JSON representation

Cuddle

• Host: GitHub
• URL: https://github.com/anytv/cuddle
• Owner: anyTV
• License: mit
• Created: 2014-09-25T06:36:32.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-07-16T08:39:17.000Z (over 5 years ago)
• Last Synced: 2024-12-09T19:57:22.842Z (about 1 month ago)
• Topics: http, javascript, node, rest-api
• Language: JavaScript
• Size: 104 KB
• Stars: 5
• Watchers: 21
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cuddle

[![Build Status](https://travis-ci.org/ravenjohn/cuddle.svg?branch=master)](https://travis-ci.org/ravenjohn/cuddle)

[![NPM version](https://img.shields.io/npm/v/cuddle.svg)](https://www.npmjs.com/package/cuddle)

Cuddle is a minimal, chainable, retryable and "readability first" node http client. It's built to use for calling third-party APIs. Just what you need.

```sh

npm i cuddle@latest -S

```

## Use Cases

### Important notes

- Status code < 200 or >= 300 will be classifed as an error.

- Request will not fire unless `.then` or `.end` is called

### Simple

```js

const cudl = require('cuddle');

cudl.post

    .to('http://localhost:8082/api/user/1')

    .set_header('Authorization', 'Token sampletoken')

    .send({

        username: 'rvnjl',

        sex: 'male'

    })

    .then((err, result) => {

        if (err) {

            //handle error

        }

        console.log(result);

    });

```

### Promise:

```js

const cudl = require('cuddle');

cudl.post

    .to('http://localhost:8082/api/user/1')

    .set_header('Authorization', 'Token sampletoken')

    .send({

        username: 'rvnjl',

        sex: 'male'

    })

    .promise()

    .then(success)

    .catch(fail);

```

### Using with generators:

```js

const cudl = require('cuddle');

const co = require('co');

function* foo () {

    let user = yield cudl.get

        .to('http://localhost:8082/api/user/1')

        .set_header('Authorization', 'Token sampletoken')

        .promise();

    console.log(user);

}

co(foo);

```

### Throttling requests

```js

// will only let 50 concurrent requests

cudl.throttle(50);

```

### Easy scoping through args:

```js

const cudl = require('cuddle');

function foo () {

    const users = [

        {id: 1, name: 'jeff'},

        {id: 2, name: 'jenny'},

        {id: 3, name: 'julius'}

    ];

    users.forEach(user => {

        cudl.get

            .to('http://localhost:8082/api/user/' + user.id)

            .args(user)

            //.max_retry(10)    // to set the number of retries

            //.debug()          // to log all

            //.logger(winston)  // to replace the logger (default is console)

            .then(bar);

    });

}

function bar (err, result, request, [user]) {

    if (err) {

        // cuddle will return a different error after reaching maximum retries

        if (err.code >= 500) {

            return request.retry();

        }

        console.error('Error with user ' + user.id + request);

        return;

    }

    user.more_info = result;

    // ...

}

foo();

```