cfapi-client

A JS wrapper around the CFAPI that works in node & the browser.

Learn more about CFAPI at the docs and at the repo.

Install

npm install --save cfapi-client

Use in the browser with browserify.

Usage

var cfapi = require('cfapi-client');

cfapi.projects([options, ]callback);

Request projects from the API.

The options object is optional and accepts these properties:

• per_page: String
  • The number of features to return on each page.
• name: String
  • Filter on the name the feature.
• categories: String
  • Filter on the category of the feature
• type: String
  • Filter on the type of the feature.
• organization_name: String
  • Filter on the organization's name.
• organization_type: String
  • Filter on organization's type.

Example usage:

cfapi.projects({ per_page: 5 }, function (err, res, body) {
  console.log(body);
});

Learn more about the projects endpoint at the docs.

cfapi.orgs([options, ]callback);

Request organizations (mostly Code for America brigades) from the API.

The options object is optional and accepts these properties:

• per_page: Integer
  • The number of features to return on each page.
• name: String
  • Filter on the name the feature.
• type: String
  • Will return organizations of that type, such as Brigade or Code for All

Example usage:

cfapi.orgs({ per_page: 1, type: 'brigade' }, function (err, res, body) {
  console.log(body);
});

Learn more about the organizations endpoint at the docs.

cfapi.organizations()

Alias to cfapi.orgs().

cfapi.issues([options, ], callback);

Request issues from the CfAPI.

The options object is optional and accepts these properties:

• per_page: Integer
  • The number of features to return on each page.
• labels: String
  • Only return Issues that have these labels

Example usage:

cfapi.issues({ labels: "help wanted", per_page: 1 }, function (err, res, body) {
  console.log(body);
});

Contributing

• Fork this repo
• Make a branch for your changes
• Install dependencies: npm install
• Add/edit tests for changes if applicable
  • Run tests: npm test
• Add/edit documentation if applicable
• Send pull request with brief explanation of changes

License

MIT