storyblok-node-client
v1.0.2
Published
Storyblok API interface for Node.js (4+)
Downloads
10
Maintainers
Keywords
Readme
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
ObjectprivateToken
String, The private token you can find in your space dashboard at https://app.storyblok.comcache
Objecttype
String,filesystem
ormemory
path
String, required if you usefilesystem
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, Objectresponse
path
String, Path (can bestories
,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