directus-sdk-javascript

directus-sdk-javascript

WIP - Directus SDK for JavaScript (Node and Browser)

Work in progress

Install

npm install directus-sdk-javascript

Usage

Directus Hosted

const DirectusSDK = require('directus-sdk-javascript');

const client = new DirectusSDK('user-token', {
  // the sub-domain in your instance url
  instanceKey: 'user--instance'
});

client.getEntries('articles', (err, res) => {
  if(err) throw err;
  res.forEach((article) => {
    console.log(article.title);
  });
});

Own Server

const DirectusSDK = require('directus-sdk-javascript');

const client = new DirectusSDK('user-token', {
  baseUrl: 'http://yoursite.com/api',
  apiVersion: 1 // Optional - default 1
});

client.getEntries('articles', (err, res) => {
  if(err) throw err;
  res.forEach((article) => {
    console.log(article.title);
  });
});

Supported Methods / Endpoints

All methods can be used with either callbacks or promises

For more info on what parameters are supported: check the official Directus API docs

client.getTables([Function callback]);

client.getTable(String table, [Function callback]);

client.getColumns(String table, [Object params, Function callback]);

client.getColumn(String table, String column, [Function callback]);

client.getEntries(String table, [Object params, Function callback]);

client.getEntry(String table, Number id, [Object params, Function callback]);

client.createEntry(String table, Object data, [Function callback]);

client.updateEntry(String table, Number id, Object data, [Function callback]);

client.deleteEntry(String table, Number id, [deleteFromDB: Boolean = false, Function callback]);

client.getUser([Object params, Function callback]);

client.getUser(Number id, [Object params, Function callback]);

client.createUse(Object data, [Function callback]);

client.updateUser(Number id, Object data, [Function callback]);

client.deleteUser(Number id, [deleteFromDB: Boolean = false, Function callback]);

client.getGroup([Object params, Function callback]);

client.getGroup(Number id, [Object params, Function callback]);

client.getGroupPrivileges(Number id, [Function callback]);

client.getFile([Object params, Function callback]);

client.getFile(Number id, Object params, Function callback]);

client.createFile(Object data, [Function callback]);

client.updateFile(Number id, Object data, [Function callback]);

client.deleteFile(Number id, [deleteFromDB: Boolean = false, Function callback]);

client.getSettings([Function callback]);

client.getSettingsByCollection(String collectionName, [Function callback]);