targetprocess-rest-api v1.0.0

targetprocess

TypeScript API wrapper for Targetprocess

Installation

npm install targetprocess-rest-api

Usage

import { Targetprocess } from "targetprocess-rest-api";

// initialise the API
const api = new Targetprocess("subdomain", "yourusername", "yourpassword");

// get a user story
const userStory = await getUserStory(123);

// get a task
const task = await getTask(456);

// get a bug
const bug = await getBug(789);

// add a time entry to an entity
const time = await addTime(456, 0.75, 4.25, new Date('2018-09-01'), "Integration testing");

// get a custom value for a project
const value = await getCustomValueForProject(123, "Some Custom Value");

Errors

getUserStory, getTask, getBug and addTime can all throw an error with the following format:

{
    statusCode: number;
    message: string;
}

License

Made with :sparkling_heart: by NewOrbit in Oxfordshire, and licensed under the MIT Licence