https://github.com/parro-it/canibekikked-api

API module of canibekikked
https://github.com/parro-it/canibekikked-api

Last synced: about 1 year ago
JSON representation

API module of canibekikked

• Host: GitHub
• URL: https://github.com/parro-it/canibekikked-api
• Owner: parro-it
• License: mit
• Created: 2016-03-25T22:00:42.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-04-02T18:05:22.000Z (about 10 years ago)
• Last Synced: 2025-06-05T11:21:27.349Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 11.7 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

          
# canibekikked-api

> API for [canibekikked](https://github.com/parro-it/canibekikked).

[![Travis Build Status](https://img.shields.io/travis/parro-it/canibekikked-api.svg)](http://travis-ci.org/parro-it/canibekikked-api)

[![NPM module](https://img.shields.io/npm/v/canibekikked-api.svg)](https://npmjs.org/package/canibekikked-api)

[![NPM downloads](https://img.shields.io/npm/dt/canibekikked-api.svg)](https://npmjs.org/package/canibekikked-api)

# Installation

```bash

npm install --save canibekikked-api

```

# Usage

```js

  import canibekikked from 'canibekikked-api';

  const results = canibekikked();

  results.on('package-checking', ({ name }) => {

    // name => name of one package that is being checked

  });

  results.on('package-checked', res => {

    // res => results object of package check if failed, or false

    // is package is not registered

  });

  results.on('end', (passed, failed) => {

    // passed => number of packages not trademarked

    // failed => array of details for trademarked packages

  });

  const checked = results.start();

  // checked => promise resolved on check end

```

# License

The MIT License (MIT)

Copyright (c) 2016 parro-it