npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

@code.gov/code-gov-integrations

1.1.1 • Public • Published

Code.gov Integrations

CircleCI Maintainability Test Coverage

Small module to house Code.gov integrations with third party services.

How to use this module

All integrations found in the libs folder are accesible when requiring this package.

const { github } = require('@code.gov/code-gov-integrations');
 
const githubClientParams = {
    type: 'token',
    token: '[your-gh-token]'
};
const client = github.getClient(githubClientParams)
 
github.getData('gsa', 'code-gov-integrations', client)
    .then(data => console.log(data))
    .catch(error => console.error(error));

For more examples take a looks at our examples folder.

How to add a module / integration

All you have to do is add a folder with an index.js file that exports your integration's API. The folder name will the the name used to export the integration.

libs
  |- new_integration
    |- index.js

The included integration(s) export an object with a getData function. We recomend following the same pattern with your integrations.

Contributing integrations to this module must follow the pattern mentioned for it to be considered for inclusion.

install

npm i @code.gov/code-gov-integrations

Downloadsweekly downloads

2

version

1.1.1

license

CC0-1.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability