@crazyfactory/tinka

A dependency-free library to gracefully handle fetch requests.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
533Jun 10, 2021Sep 27, 2016Minified + gzip package size for @crazyfactory/tinka in KB

Readme

tinka

npm Build Status codecov dependencies Status devDependencies Status semantic-release Greenkeeper badge npm version

A dependency-free library to gracefully handle fetch requests.

Usage

Tinka can be used as a standalone requirement or better yet as a basis for fully typed API SDKs.

Contribute

Clone this repository and install project dependencies.

  • npm install

Tests

This package is tested using jest, which you can use via CLI or through most IDEs directly.

  • on CLI execute npm test to run the tests.

This will also create a code coverage report at /coverage.

For continuous testing use wallabyjs with our default configuration at ./wallaby.js

Code styles

This project uses tslint to enforce similar code styles across source and test files. Passing tslint validation is a CI requirement. You can run and validate your code style locally.

  • npm run lint lints all typescript files in the project.
  • npm run lint-fix to also fix most common errors automatically.

The project also comes with project based code-style settings for intelliJ-based IDEs like PhpStorm, Webstorm etc. You can safely use their auto cleanup features.

Build and deploy

This package is automatically build and deployed using TravisCI and semantic-release. You can however test the process locally:

  • npm run build compile sources into all desired formats.
  • npm run pack to create the final package.

Note: You'll have to edit package.json to include a version number of your choice. Don't check this in though as the version number is determined by semantic-release.

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.