Skip to content

labd/storyblok-js-client

 
 

Repository files navigation

@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-client

Parameters

  • config Object
    • (accessToken String, 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.)
    • (oauthToken String, 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.)
    • (cache Object, optional)
      • (type String, optional - none or memory)
    • (responseInterceptor Function, optional - You can pass a function and return the result. For security reasons, Storyblok client will deal only with the response interceptor.)
    • (region String, optional)
    • (https Boolean, optional)
    • (rateLimit Number, option - MAPI ratelimit. Only applied when oauthToken is set. Limits max req. per second. If left empty, no throttling is applied.)
    • (timeout Integer, optional) API timeout. If no value is set no time out is applied.
    • (maxRetries Integer, optional, defaults to 5)
    • (retryDelay Integer, optional) retry delay in ms. Defaults to 300
    • (maxDelay Integer, optional) maximum retry delay. Be aware that retries are done with exponential backoff. Defaults to 2000.
    • (richTextSchema Object, optional - your custom schema for RichTextRenderer)
    • (resolveNestedRelations Boolean, optional - By default is true)
  • (endpoint String, optional)

See https://github.com/storyblok/storyblok-js-client/ for more information

About

Universal JavaScript client for Storyblok's API

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 50.5%
  • JavaScript 47.6%
  • Other 1.9%