drupal-org-api

JavaScript client for Drupal.org

Usage no npm install needed!

<script type="module">
  import drupalOrgApi from 'https://cdn.skypack.dev/drupal-org-api';
</script>

README

Drupal.org HTTP API

A wrapper for the Drupal.org HTTP API. For more information and some available filtering options see the official documentation.

Setup

yarn install drupal-org-api

Usage

const DrupalAPI = require('drupal-org-api');
const drupalapi = new DrupalAPI();

`exports.node(filterOptions)`

Parameters

filterOptions: Object, Query string filter options

Returns: Promise, Pending issueRequest promise.

`exports.user(filterOptions)`

Parameters

filterOptions: Object, Query string filter options

Returns: Promise, Pending issueRequest promise.

`exports.comment(filterOptions)`

Parameters

filterOptions: Object, Query string filter options

Returns: Promise, Pending issueRequest promise.

`exports.file(fileID)`

Parameters

fileID: String, The ID of the file.

Returns: Promise, Pending issueRequest promise.

`exports.maintainers(projectID)`

Parameters

projectID: String, The ID of the project, ie. Drupal

Returns: Promise, Pending issueRequest promise.

`exports.ci(filterOptions)`

Parameters

filterOptions: Object, Query string filter options

Returns: Promise, Pending issueRequest promise.

`exports.taxonomyTerm(filterOptions)`

Parameters

filterOptions: Object, Query string filter options

Returns: Promise, Pending issueRequest promise.

`exports.getRelatedTaxonomyTerms(taxonomyTermIds)`

Parameters

taxonomyTermIds: Array, Array of Taxonomy Terms Ids

Returns: Promise, Pending issueRequest promise.

`exports.getRelatedComments(commentIds)`

Parameters

commentIds: Array, Array of Comment Ids

Returns: Promise, Pending issueRequest promise.

License

MIT