Classes

DruxtClient

The Druxt JSON:API client.

Typedefs

DruxtClientOptions : object

DruxtClient options object.

DruxtClientQuery : string | object

A correctly formatted JSON:API query string or object.

DruxtClient

The Druxt JSON:API client.

Kind: global class

• DruxtClient
  • new DruxtClient(baseUrl, [options])
  • .axios : object
  • .index : object
  • .addHeaders(headers)
  • .buildQueryUrl(url, [query]) ⇒ string
  • .createResource(resource, [prefix]) ⇒ object
  • .error(err)
  • .get(url, options) ⇒ object
  • .getCollection(type, [query], [prefix]) ⇒ object
  • .getCollectionAll(type, [query], [prefix]) ⇒ Array.<object>
  • .getIndex([resource], [prefix]) ⇒ object
  • .getRelated(type, id, related, [query], [prefix]) ⇒ object
  • .getResource(type, id, [query], [prefix]) ⇒ object
  • .updateResource(resource, [prefix]) ⇒ object

new DruxtClient(baseUrl, [options])

DruxtClient constructor.

• Validates module options.
• Sets up Axios instance.
• Sets up options.

Example

const DruxtClient = require('druxt').DruxtCllient
const druxt = new DruxtClient('https://demo-api.druxtjs.org', {})

.axios : object

The Axios instance.

Kind: instance property of DruxtClient
See: https://github.com/axios/axios#instance-methods

.index : object

JSON:API Index.

Kind: instance property of DruxtClient

.addHeaders(headers)

Add headers to the Axios instance.

Kind: instance method of DruxtClient

Example

this.$druxt.addHeaders({ 'Authorization': `Basic ${token}` })

.buildQueryUrl(url, [query]) ⇒ string

Build query URL.

Kind: instance method of DruxtClient
Returns: string - The URL with query string.

Example

const query = new DrupalJsonApiParams()
query.addFilter('status', '1')
const queryUrl = this.$druxt.buildQueryUrl(resourceUrl, query)

.createResource(resource, [prefix]) ⇒ object

Create a JSON:API resource.

Kind: instance method of DruxtClient
Returns: object - The response data

Example

await this.$druxt.createResource(
  {
    type: 'node--page',
    attributes: {},
    relationships: {}
  },
  'en'
)

.error(err)

Throw a formatted error.

Kind: instance method of DruxtClient
Throws:

• Error A formatted error.

.get(url, options) ⇒ object

Execute an Axios GET request, with permission checking and error handling.

Kind: instance method of DruxtClient
Returns: object - The Axios response.

.getCollection(type, [query], [prefix]) ⇒ object

Get a collection of resources from the JSON:API server.

Kind: instance method of DruxtClient
Returns: object - The JSON:API collection response.

Example

const collection = await this.$druxt.getCollection(
  'node--recipe',
  undefined,
  'en'
)

.getCollectionAll(type, [query], [prefix]) ⇒ Array.<object>

Get all resources of a collection.

Kind: instance method of DruxtClient
Returns: Array.<object> - An array of JSON:API collections.

Example

const collections = await this.$druxt.getCollectionAll(
  'node--recipe',
  'fields[node--recipe]=title',
  'en'
)

.getIndex([resource], [prefix]) ⇒ object

Get index of all available resources, or the optionally specified resource.

Kind: instance method of DruxtClient
Returns: object - The resource index object or the specified resource.

Example

const { href } = await this.$druxt.getIndex('node--article', 'en')

.getRelated(type, id, related, [query], [prefix]) ⇒ object

Get the related resources from a specified JSON:API resource.

Kind: instance method of DruxtClient
Returns: object - The related JSON:API resource(s).

Example

const related = this.$druxt.getRelated(
  'node--page',
  id, 'uid',
  undefined,
  'en'
)

.getResource(type, id, [query], [prefix]) ⇒ object

Get a JSON:API resource by type and ID.

Kind: instance method of DruxtClient
Returns: object - The JSON:API resource data.
Todo

• update method to take a context object instead of 4 parameters.

Example

const data = await this.$druxt.getResource(
  'node--article',
  id,
  undefined,
  'en'
)

.updateResource(resource, [prefix]) ⇒ object

Update a JSON:API resource.

Kind: instance method of DruxtClient
Returns: object - The response data

Example

await this.$druxt.updateResource(
  {
    type: 'node--page',
    id,
    attributes: {},
    relationships: {}
  },
  'en'
)

DruxtClientOptions : object

DruxtClient options object.

Kind: global typedef
See: https://github.com/axios/axios#request-config

Example

{
  // Axios instance settings.
  axios: {
    // Set axios headers.
    headers: { 'X-Custom-Header': true },
  },
  // Enable debug console log messages.
  debug: true,
  // JSON:API endpoint.
  endpoint: 'api',
}

DruxtClientQuery : string | object

A correctly formatted JSON:API query string or object.

Kind: global typedef
See: https://www.npmjs.com/package/drupal-jsonapi-params
Example

page[limit]=5&page[offset]=5

Example

new DrupalJsonApiParams().addPageLimit(5)