teamwork-api
v1.3.0
Published
A wrapper around teamwork api making it easier to perform requests.
Downloads
28
Readme
Teamwork Api
A wrapper around teamwork api making it easier to perform requests.
Installation
$ npm install teamwork-apiGetting Started
The api key and sub-domain are required to connect to teamwork's api, provide these as environment variables like so:
process.env.TW_API = '1234567890'
process.env.TW_SUB = 'subdomain'
const tw = require('teamwork-api')()Alternatively pass them in as function arguments
const tw = require('teamwork-api')('1234567890', 'subdomain')If your teamwork installation uses a custom domain (ie. https://tw.mycompany.com) pass the custom_domain=true flag.
const tw = require('teamwork-api')('1234567890', 'https://tw.mycompany.com', custom_domain=true)Contributing
I am happy for people to contribute to this project, fix or add new features.
Be sure when adding / modifying methods that the doc blocks are correct.
The documentation is built based on these comments using npm run docs.
Further to this ensure when you commit you are using npm run commit as this will help when semantic versioning the code.
Happy coding 💻...