https://github.com/simov/purest-docs

Documentation for the Purest module
https://github.com/simov/purest-docs

Last synced: 8 months ago
JSON representation

Documentation for the Purest module

• Host: GitHub
• URL: https://github.com/simov/purest-docs
• Owner: simov
• License: mit
• Created: 2016-07-08T12:19:03.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-07-17T17:34:55.000Z (over 9 years ago)
• Last Synced: 2025-02-26T09:41:51.311Z (11 months ago)
• Homepage: https://simov.gitbooks.io/purest
• Size: 11.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# Purest

[![NPM Package Version](https://img.shields.io/npm/v/purest.svg?style=flat-square)](https://www.npmjs.com/package/purest) [![Build Status - Travis CI](https://img.shields.io/travis/simov/purest/master.svg?style=flat-square)](https://travis-ci.org/simov/purest) [![Test Coverage - Coveralls](https://img.shields.io/coveralls/simov/purest.svg?style=flat-square)](https://coveralls.io/r/simov/purest?branch=master) [![Test Coverage - Codecov](https://img.shields.io/codecov/c/github/simov/purest.svg?style=flat-square)](https://codecov.io/github/simov/purest?branch=master)

Purest is a generic REST API client library that can be used with *any* REST API, *any* HTTP client library and *any* Promise implementation:

```js

var request = require('request')

var promise = require('bluebird')

var purest = require('purest')({request, promise})

var config = require('@purest/providers')

var google = purest({provider: 'google', config})

var req = google

  .query('youtube')

  .select('channels')

  .where({forUsername: 'CaseyNeistat'})

  .auth('[ACCESS_TOKEN]')

  .request()

req

  .catch((err) => {})

  .then((result) => {})

```

  [npm-version]: https://img.shields.io/npm/v/purest.svg?style=flat-square (NPM Package Version)

  [travis-ci]: https://img.shields.io/travis/simov/purest/master.svg?style=flat-square (Build Status - Travis CI)

  [coveralls-status]: https://img.shields.io/coveralls/simov/purest.svg?style=flat-square (Test Coverage - Coveralls)

  [codecov-status]: https://img.shields.io/codecov/c/github/simov/purest.svg?style=flat-square (Test Coverage - Codecov)

  [npm]: https://www.npmjs.com/package/purest

  [travis]: https://travis-ci.org/simov/purest

  [coveralls]: https://coveralls.io/r/simov/purest?branch=master

  [codecov]: https://codecov.io/github/simov/purest?branch=master