Neolithic Psychedelic Mushrooms
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

storyblok-node-client

1.0.2 • Public • Published

Official Storyblok Node.js client

This client will provide you some helpers for the Storyblok publishing API.

This repository has been inspired by https://github.com/schornio/node-storyblok. Big thanks to Thomas Schorn for this awesome package.

Install

npm install storyblok-node-client

Usage

Class Storyblok

Parameters

  • config Object
    • privateToken String, The private token you can find in your space dashboard at https://app.storyblok.com
    • cache Object
      • type String, filesystem or memory
      • path String, required if you use filesystem as type
  • (endpoint optional)

Example

// 1. Require the Storyblok node client
const StoryblokClient = require('storyblok-node-client');
 
// 2. Initialize the client with the private key 
// from your space dashboard at https://app.storyblok.com
let Storyblok = new StoryblokClient({
  privateToken: 'xf5dRMMjltLzKOcNgMaU9Att'
});

Activating request cache

The Storyblok nodejs client comes with a caching mechanism. When initializing the Storyblok client you can define a cache provider for caching the requests on the filesystem or in memory. To clear the cache you can call Storyblok.flushCache();.

// For a filesystem cache the path parameter is mandatory
let Storyblok = new StoryblokClient({
  privateToken: 'xf5dRMMjltLzKOcNgMaU9Att',
  cache: {
    type: 'filesystem',
    path: './public/datastorage/'
  }
});
 
// For the memory cache only the type paramter is required
let Storyblok = new StoryblokClient({
  privateToken: 'xf5dRMMjltLzKOcNgMaU9Att',
  cache: {
    type: 'memory'
  }
});

Method Storyblok#get

Parameters

  • [return] Promise, Object response
  • path String, Path (can be stories, stories/*, tags, datasources, links)
  • options Object, Options can be found in the API documentation.

Example

Storyblok
  .get('stories/home', {
    version: 'draft'
  })
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.log(error);
  });

Method Storyblok#flushCache

Parameters

  • [return] Object, returns the Storyblok client

Example

Storyblok.flushCache();

Contribution

Fork me on Github

Keywords

Install

npm i storyblok-node-client

DownloadsWeekly Downloads

16

Version

1.0.2

License

MIT

Unpacked Size

7.02 kB

Total Files

5

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar