@immomio/api-library

Immomio library to access the immomio-API

Stats

StarsIssuesVersionUpdatedCreatedSize
@immomio/api-library
1.3.14 years ago4 years agoMinified + gzip package size for @immomio/api-library in KB

Readme

[![Node.js version][nodejs-badge]][nodejs] [![NPM version][npm-badge]][npm]

Tested API-Connection for Immomio-Backend

  • [TypeScript][typescript] [2.5][typescript-25] to ES6 transpilation
  • [TSLint][tslint] 5.x
  • [Jest][jest] unit testing and code coverage
  • Type definitions for Node.js v6.x (LTS) and Jest
  • .editorconfig for consistent file format

Available scripts

  • clean - remove coverage data, Jest cache and transpiled files,
  • build - transpile TypeScript to ES6,
  • watch - interactive watch mode to automatically transpile source files,
  • lint - lint source files and tests,
  • test - run tests,
  • test:watch - interactive watch mode to automatically re-run tests

Changes

Changes should include tests for all changes first. Try to leave the code coverage at 100%.

[nodejs-badge]: https://img.shields.io/badge/node->=%208.2.1-blue.svg [nodejs]: https://nodejs.org/dist/latest-v8.x/docs/api/ [npm-badge]: https://img.shields.io/badge/npm->=%205.4.0-blue.svg [npm]: https://docs.npmjs.com/ [typescript]: https://www.typescriptlang.org/ [typescript-25]: https://github.com/Microsoft/TypeScript/wiki/What's-new-in-TypeScript#typescript-25 [jest]: https://facebook.github.io/jest/ [tslint]: https://palantir.github.io/tslint/

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.