canibekikked-api v1.1.1

canibekikked-api

API for canibekikked.

Installation

npm install --save canibekikked-api

Usage

  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