bzrest (alpha)

A modern promise base wrapper for the bugzilal rest api.

Installation

 npm i bzrest --save

Setup

import bz from 'bzrest';

This will allow you to make api calls which do not require authorization such as reading public bugs.

In order to use authenticated routes, you need to specify a api key. This can be set alone, or along with other configuration options.

bz.setApiKey('example_api_key');

bzrest defaults to using the Mozilla bugzilla. You can specify other bugzilla installations using bz.setConfig.

Documentation

TODO! Formal documentation is underway. The module is almost 100% TypeDoc'd and include typescript definitions for almost all function parameters.

Examples

Search for bugs tagged as 'easy' and 'beginner' with the substring 'bug' in the title.

let bugs = await bz.bugs.search({ summary: 'bug', tags: ['easy', 'beginner'] });

Get bug using array of Id's.

let b: Array<Bug> = await bz.bugs.get([1128878, 1219113, 909822]);
b.forEach(bug => {
    console.log(bug.summary);
});

Post a new comment on a bug with id 1128878 and set the comment to use markdown.

bz.bugs.comments.create(1128878, { comment: '# Wow, what a interesting bug!', is_markdown: true })

Update the tags for comment 213321 with 'fantastic'.

bz.bugs.comments.updateTags(213321, { add: ['fantastic'] });

Functionality

Working

• Bugs
• Comments
• Products
• Components
• Users*

todo

• Attachments
• Bugzilla Infomation
• Groups

*= not fully complete