node-directus-client

Directus API JavaScript Client

A JavaScript client for the Directus API

This library is under active development. Breaking changes can occur at every patch.

Purpose

This libraries abstracts the interaction with the Directus CMS API. It enables your Node.js app to request specific resources from a Directus instance.

Installation

To use the library, install it with npm: npm install --save node-directus-client

Then require it in your application script: const DirectusSDKClient = require('node-directus-client')

Usage

The module is a class, so you'll have to create a new instance of the client bound to the endpoint and access token of your Directus instance. This can either be a self-hosted Directus installation or a hosted Directus instance.

Self-hosted

const client = new DirectusSDKClient('apiKey-12345', {
  baseURL: 'http://yoursite.com/api/'
});

Hosted

const client = new DirectusSDKClient('apiKey-12345', {
  instanceKey: 'instance_key'
});

Every method (see below) is asynchronous and can be used with callbacks as well as promises.

client.getTables()
  .then((res) => {
    console.log(res);
  });

client.getTables(function(err, res) {
  console.log(res);
});

Methods (endpoints)

The options object will be converted to query params in the api request. Check the official Directus API endpoints docs for all available options.

getTables

client.getTables([_obj_ options, _fn_ callback])

Get all available tables.

getColumns

client.getColumns(_string_ table, [_obj_ options, _fn_ callback])

Get all columns from a single table.

getEntry

client.getEntry(_string_ table, _int_ id, [_obj_ options, _fn_ callback])

Get a single item from a table

getEntries

client.getEntries(_string_ table, [_obj_ options, _fn_ callback])

Get multiple items from a table

getUser

client.getUser(_int_ id, [_obj_ options, _fn_ callback])

Get a single user

getUsers

client.getUsers([_obj_ options, _fn_ callback])

Get all users

More methods will be added over time, including methods to update and post entries