@financial-times/origami-repo-data-client

1.7.2 • Public • Published

Origami Repo Data Client (Node.js)

A Node.js client for the Origami Repo Data service.

NPM version MIT licensed

const RepoDataClient = require('@financial-times/origami-repo-data-client');

const repoData = new RepoDataClient({
    apiKey: 'xxxXxXxX-XXXX-XXXX-xXXx-xxxXXXxXXXXX',
    apiSecret: 'xxXXXxxXXXXXXXXXxxxxxxxXXXxXxXXXXXXxxXXx'
});

const repos = await repoData.listRepos();

Table Of Contents

Usage

Using this module requires Node.js 6.x and npm. You can install with:

npm install @financial-times/origami-repo-data-client

The full API documentation explains how to use this module.

Contributing

This module has a full suite of unit tests, and is verified with ESLint. You can use the following commands to check your code before opening a pull request:

make verify  # verify JavaScript code with ESLint
make test    # run the unit tests and check coverage

Publishing

New versions of the module are published automatically by CI when a new tag is created matching the pattern /v.*/.

Contact

If you have any questions or comments about this module, or need help using it, please either raise an issue, visit #origami-support or email Origami Support.

Licence

This software is published by the Financial Times under the MIT licence.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.7.2
    6
    • latest

Version History

Package Sidebar

Install

npm i @financial-times/origami-repo-data-client

Weekly Downloads

7

Version

1.7.2

License

MIT

Unpacked Size

1.62 MB

Total Files

58

Last publish

Collaborators

  • robertboulton
  • seraph2000
  • hamza.samih
  • notlee
  • emmalewis
  • aendra
  • the-ft
  • rowanmanning
  • chee
  • alexwilson