From 5813d24844f61bb0d998e2d72b2fb0fca99cf0df Mon Sep 17 00:00:00 2001 From: ademarCardoso Date: Wed, 21 Jun 2023 10:15:47 -0300 Subject: [PATCH] chore(int-926): update cache information and remove unused docs for proxy --- README.md | 24 ++---------------------- 1 file changed, 2 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index da364b64..73f12ce4 100755 --- a/README.md +++ b/README.md @@ -147,7 +147,8 @@ We added retro-compatibility when using `resolve_assets: 1` parameter under V2. The Storyblok client comes with a caching mechanism. When initializing the Storyblok client you can define a cache provider for caching the requests in memory. -To clear the cache you can call `Storyblok.flushCache()` or activate the automatic clear with clear: 'auto'. + +The default behavior of the cache is `clear: 'manual'`, that is, if you need to clear the cache, you need to call `Storyblok.flushCache()` or activate the automatic clear with `clear: 'auto'`, as in the example below. ```javascript let Storyblok = new StoryblokClient({ @@ -554,27 +555,6 @@ let getStories = (page) => { getStories(1); ``` -#### Initialize with a proxy server - -```javascript -const proxy = { - host: host, - port: port, - auth: { - username: 'username', - password: 'password' - } -} - -const storyblok = new StoryblokClient({ - ... - https: false, - proxy: proxy -}) -``` - -Read more about proxy settings in axios [documentation](https://github.com/axios/axios) - #### How to define a custom schema for the RichTextRenderer To define how to add some classes to specific html attributes rendered by the rich text renderer, you need your own schema definition. With this new schema, you can pass it as the `richTextSchema` option when instantiate the `StoryblokClient` class. You **must** follow the [default schema](https://github.com/storyblok/storyblok-js-client/blob/main/src/schema.ts) to do this.