versioneye-api-client

VersionEye API Client Library for node.js

Usage no npm install needed!

<script type="module">
  import versioneyeApiClient from 'https://cdn.skypack.dev/versioneye-api-client';
</script>

README

versioneye-api-client

VersionEye API Client Library for node.js

npm version npm downloads Node.js Version Support Build Status Dependency Status dependencies Status Coverage Status License

Description

See https://www.versioneye.com/api/ for API documents.

Install

npm install versioneye-api-client

Usage

const VersionEye = require('versioneye-api-client');

const apiKey = 'your api token';
const versioneye = new VersionEye(apiKey);
versioneye.me.show().then(json => {
   console.log(json['username']); // print your username 
});

API key

The API key is required to use this API client. There are two types of API key, the personal API key and the organization API key.

You can find the personal API key in your setting page (https://www.versioneye.com/settings/api).

And the organization API key is in organization's setting page (https://www.versioneye.com/organisations/<your organization's name>/apikey). With this APIkey, you can create, read, update and delete projects in the organization through the VersionEye's API. This API key is only visible for the members of the "Owners" team.

Promises

The API methods will return Promises. The response json object will be passed to then method when the request succeeds. The Error object, with the Response object of the Fetch API as the message, will be passed to catch method when the request fails.

Contribution

  1. Fork
  2. Create a feature branch
  3. Commit your changes
  4. Rebase your local changes against the master branch
  5. Run npm test
  6. Create new Pull Request

License

MIT

Author

miyajan: Jumpei Miyata miyajan777@gmail.com