node-destiny-2

node-destiny-2

:new_moon: A zero dependency Destiny 2 API Wrapper written in Node.js

Note

The Destiny 2 API is also still being worked on, so some of the endpoints may not work correctly.

Getting Started

Super simple to set up.

// Getting API Manifest Example
const Destiny2API = require('node-destiny-2');

const destiny = new Destiny2API({
  key: 'your-api-key'
});

Get Destiny Manifest Example:

With .then()/.catch():

destiny.getManifest()
  .then(res => console.log(`Manifest: ${res.Response}`))
  .catch(err => console.log(`Error: ${err}`));

With async/await:

try {
    const res = await destiny.getManifest();
    console.log(`Manifest: ${res.Response}`);
} catch (err) {
    console.log(`Error: ${err}`);
    throw err;
}

Installation

Install from NPM with:

npm install node-destiny-2

Or you can build from source via the releases.

Examples

See examples folder for basic function calls. Planning on adding more detailed ones (see issues if you want to help)

Documentation

For general JSDoc documentation see each file in the lib folder. More specifically, destiny-2-api.js has fairly detailed documentation for each method call.

For further reading on the API documentation see the Official Destiny 2 API Documentation.

See issues if you are interested in helping improve the available documentation. (I am planning on eventually adding some documentation generator based on JSDoc).

Contributing

If you see a feature that may need to be added, feel free to send a pull request. Also, feel free to fix or file an issue of your own. I will set up a CONTRIBUTING.md eventually for code style and a little more information on creating pull requests.

License

The code in this repository is licensed under the MIT License. Unless otherwise specified by 3rd party software.