@becomes/cms-client v3.0.0-alpha.4

Becomes CMS client library

This library was written to enable easy connectivity with Becomes CMS.

How to use

1. Install package from NPM: npm i --save @becomes/cms-client
2. Create new Client instance and make a request to CMS:

// Import Client class.
import { BCMSClient } from '@becomes/cms-client';

async function main() {
  // Create new instance of a Client.
  const client = BCMSClient({
    cmsOrigin: process.env.API_ORIGIN,
    key: {
      id: process.env.API_KEY,
      secret: process.env.API_SECRET,
    },
  });
  // Get all Entries in specified Template.
  const query = await client.entry.getAll('__TEMPLATE_ID__');
  // Print query result
  console.log(query);
}

API

Get Template

const query = await client.template.get('__TEMPLATE_ID__');

Get Entry

const query = await client.entry.get({
  templateId: '__TEMPLATE_ID__',
  entryId: '__ENTRY_ID__',
});

Get all Entries

const query = await client.entry.getAll('__TEMPLATE_ID__');

Get all Media

const query = await client.media.getAll();

Get Media

const query = await client.media.get('__MEDIA_ID__');

Get Media binary data

const query = await client.media.get('__MEDIA_ID__');
const bin = await query.bin();