GithubHelp home page GithubHelp logo

apithen.js's Introduction

ApiThen

RESTful Api Promise Chain Module

"Our greatest weakness lies in giving up. The most certain way to succeed is always to try just one more time." - Edison

Author: Trevor Clarke

Why?

This module is a study in the simplification of common API/module/REST needs for most apps. I have found many times a need for a module that wraps xhr interactions, gives easy chainable & readable methods, and returns an A+ promise. The goal is a polymorphic, configurable & framework independent module.


Project Setup

Initializing The Project

npm install

Commands:

npm run dev - Builds continuously (TODO:)

npm start - runs the local dev server

Usage & Examples

BASIC EXAMPLE:
let Api = new ApiThen
Api.get().users().list(20, 0).then((res) => {
 console.log("Api.users paginated", res)
}, (err) => {
 console.error(err)
})
QUICK SETUP:
  1. Store the instance somewhere, wherever you need baseline params/options to begin with.

    global.Api = new ApiThen({ headers: {} })

  2. Use the methods like you assume you should ;)

    Api.get().users(123456789).then(() => {})

ADDITIONAL OPTIONS:
  1. Change headers/options any time, or per query.

    Api.options({ headers: {} })

API

TBD: Check back :)

apithen.js's People

Contributors

trevorjtclarke avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.