Package Exports

bugzilla-readable-status

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bugzilla-readable-status) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Bugzilla Readable Status Messages

Generate readable, english language, status messages from properties of bugs in bugzilla.mozilla.org.

The module exposes a single method, readable, which can be called in a variety of ways:

an object whos properties correspond to a bugs properties.
the id of a bug (to be implemented)
an array of objects containing bug properties
an array of bug ids (to be implemented)

Install

Clone repo to local.

npm install; npm test; npm run demo

Usage

var readable = import('bugzilla-readable-status').readable;

var status = readable({ id: NNNNNN, status: 'NEW', … });

// => 'BUG STATUS'

var statuses = readable([
        { id: NNNNNN, status: 'FIXED' … }.
        { id: MMMMMM, status: 'NEW' … },
        …
    ]);

// => { "statuses": [
        { "id": NNNNNN, "status": "BUG STATUS" },
        { "id": MMMMMM, "status": "BUG STATUS" },
        …
    ]}

var emptyArray = readable([]);

// => { "result": [] }

Errors

Errors are returned as objects:

{ "error": "ERROR STRING" }

No Data

If there are no usable properties or the module can't generate, "NO_STRING_FOR_BUG"

Errors in Requests for Multiple Bugs

If multiple bugs are requested, and errors are found, the errors are included in the reponse object:

{ "statuses": [
        { "id": "BUG ID", 
          "status": "BUG STATUS" },
        …
        { "id": "BUG ID WITH ERROR",
          "error": "ERROR MESSAGE" }
        …
    ]}