Giter VIP home page Giter VIP logo

alks.js's Introduction

alks.js

Build Status Coverage Status Requirements Status File Size npm version

JavaScript client for the ALKS API, usable in both modern browsers and node.js

It provides a lightweight wrapper around the ALKS REST API, with the following features:

  • No dependencies in browser, only one dependency in node.js
  • Implemented with promises, leveraging fetch instead of XMLHttpRequest
  • Promises reject with ALKS-provided status messages when available
  • Each method returns only the appropriate data from the API response
  • Fully documented with JSDoc
  • Works with no polyfills in latest Chrome, Firefox and Safari

For browser usage, it expects fetch (and Promises) to be available. If they're not, you'll need to polyfill them.

Documentation

View the API documentation

To update the API documentation from the source, run npm run docs

Tests

Run both node.js and browser tests with npm test (must have Chrome installed)

alks.js's People

Contributors

pofallon avatar americk0 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.