@labdigital/storyblok-js-client
v2.0.0
Published
Universal JavaScript SDK for Storyblok's API
Downloads
1,849
Keywords
Readme
@labdigital/storyblok-js-client
A (hopefully temporary) fork of the official Storyblok JavaScript client without throttling. The throttling severely impacts performance of the client in production use-cases.
Installation
npm install @labdigital/storyblok-js-clientParameters
configObject- (
accessTokenString, optional - The preview token you can find in your space dashboard at https://app.storyblok.com. This is mandatory only if you are using the CDN API.) - (
oauthTokenString, optional - The personal access token you can find in your account at https://app.storyblok.com/#/me/account?tab=token. This is mandatory only if you are using the Management API.) - (
cacheObject, optional)- (
typeString, optional -noneormemory)
- (
- (
responseInterceptorFunction, optional - You can pass a function and return the result. For security reasons, Storyblok client will deal only with the response interceptor.) - (
regionString, optional) - (
httpsBoolean, optional) - (
rateLimitNumber, option - MAPI ratelimit. Only applied whenoauthTokenis set. Limits max req. per second. If left empty, no throttling is applied.) - (
timeoutInteger, optional) API timeout. If no value is set no time out is applied. - (
maxRetriesInteger, optional, defaults to 5) - (
retryDelayInteger, optional) retry delay in ms. Defaults to 300 - (
maxDelayInteger, optional) maximum retry delay. Be aware that retries are done with exponential backoff. Defaults to 2000. - (
richTextSchemaObject, optional - your custom schema for RichTextRenderer) - (
resolveNestedRelationsBoolean, optional - By default is true)
- (
- (
endpointString, optional)
See https://github.com/storyblok/storyblok-js-client/ for more information
