Skip to content

Commit 7de4bab

Browse files
Fix mistakes in Vue.js SDK documentation. (#704)
* Fix: wrong pollInterval property. * Fix: Additional mistakes
1 parent 538990a commit 7de4bab

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

  • website
    • docs/sdk-reference/community
    • versioned_docs/version-V1/sdk-reference/community

website/docs/sdk-reference/community/vue.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const VueSchema = require('@site/src/schema-markup/sdk-reference/communit
99
<script type="application/ld+json" dangerouslySetInnerHTML={{ __html: JSON.stringify(VueSchema) }}></script>
1010

1111
:::caution
12-
As this is a community-maintained package, ConfigCat can't guarantee its stability, and safety and can't provide official customer support.
12+
As this is a community-maintained package, ConfigCat can't guarantee its stability and safety, and can't provide official customer support.
1313
:::
1414

1515
<a href="https://github.com/codedbychavez/configcat-vue" target="_blank">ConfigCat SDK for Vue.js on GitHub</a>
@@ -91,7 +91,7 @@ Optionally, the `FeatureWrapper` component also provides an `#else` and `#loadin
9191

9292
### Specifying a polling mode
9393

94-
Polling modes are used to control how often ConfigCat's SDK client downloads the values of feature flags from ConfigCat's servers. The default polling mode is `AutoPoll`. Auto Polling fetches the latest feature flag values every 60 seconds by default. To change this, Specify a polling mode and set the polling interval (in seconds) via the `pollingIntervalInSeconds` property.
94+
Polling modes are used to control how often ConfigCat's SDK client downloads the values of feature flags from ConfigCat's servers. The default polling mode is `AutoPoll`. Auto Polling fetches the latest feature flag values every 60 seconds by default. To change this, Specify a polling mode and set the polling interval (in seconds) via the `pollIntervalSeconds` property.
9595

9696
Import:
9797

@@ -103,7 +103,7 @@ Add `pollingMode` to the `ConfigCatPlugin` options and set the polling interval
103103

104104
```js
105105
app.use(ConfigCatPlugin, {
106-
sdkKey: "YOUR-CONFIGCAT-SDKKEY-GOES-HERE",
106+
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE",
107107
pollingMode: PollingMode.AutoPoll, // Optional. Default is AutoPoll
108108
clientOptions: {
109109
pollIntervalSeconds: 5 // Optional. Specify the polling interval in seconds. The default is 60 seconds.
@@ -121,7 +121,7 @@ You may want to log the actions of the underlying ConfigCat SDK client. To do th
121121

122122
> See documentation [here](../js/browser.mdx#logging).
123123
124-
Add `createConsoleLogger`, and `LoggerLevel` to your import:
124+
Add `createConsoleLogger`, and `LogLevel` to your import:
125125

126126
```js
127127
import { createConsoleLogger, LogLevel } from "configcat-vue";
@@ -135,7 +135,7 @@ Use the logger in `clientOptions`:
135135

136136
```js
137137
app.use(ConfigCatPlugin, {
138-
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE", // // sdkKey is required
138+
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE", // sdkKey is required
139139
clientOptions: { // clientOptions is optional
140140
// ...
141141
logger: createConsoleLogger(LogLevel.Info),

website/versioned_docs/version-V1/sdk-reference/community/vue.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const VueSchema = require('@site/src/schema-markup/sdk-reference/communit
99
<script type="application/ld+json" dangerouslySetInnerHTML={{ __html: JSON.stringify(VueSchema) }}></script>
1010

1111
:::caution
12-
As this is a community-maintained package, ConfigCat can't guarantee its stability, and safety and can't provide official customer support.
12+
As this is a community-maintained package, ConfigCat can't guarantee its stability and safety, and can't provide official customer support.
1313
:::
1414

1515
<a href="https://github.com/codedbychavez/configcat-vue" target="_blank">ConfigCat SDK for Vue.js on GitHub</a>
@@ -91,7 +91,7 @@ Optionally, the `FeatureWrapper` component also provides an `#else` and `#loadin
9191

9292
### Specifying a polling mode
9393

94-
Polling modes are used to control how often ConfigCat's SDK client downloads the values of feature flags from ConfigCat's servers. The default polling mode is `AutoPoll`. Auto Polling fetches the latest feature flag values every 60 seconds by default. To change this, Specify a polling mode and set the polling interval (in seconds) via the `pollingIntervalInSeconds` property.
94+
Polling modes are used to control how often ConfigCat's SDK client downloads the values of feature flags from ConfigCat's servers. The default polling mode is `AutoPoll`. Auto Polling fetches the latest feature flag values every 60 seconds by default. To change this, Specify a polling mode and set the polling interval (in seconds) via the `pollIntervalSeconds` property.
9595

9696
Import:
9797

@@ -103,7 +103,7 @@ Add `pollingMode` to the `ConfigCatPlugin` options and set the polling interval
103103

104104
```js
105105
app.use(ConfigCatPlugin, {
106-
sdkKey: "YOUR-CONFIGCAT-SDKKEY-GOES-HERE",
106+
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE",
107107
pollingMode: PollingMode.AutoPoll, // Optional. Default is AutoPoll
108108
clientOptions: {
109109
pollIntervalSeconds: 5 // Optional. Specify the polling interval in seconds. The default is 60 seconds.
@@ -121,7 +121,7 @@ You may want to log the actions of the underlying ConfigCat SDK client. To do th
121121

122122
> See documentation [here](../js.mdx#logging).
123123
124-
Add `createConsoleLogger`, and `LoggerLevel` to your import:
124+
Add `createConsoleLogger`, and `LogLevel` to your import:
125125

126126
```js
127127
import { createConsoleLogger, LogLevel } from "configcat-vue";
@@ -135,7 +135,7 @@ Use the logger in `clientOptions`:
135135

136136
```js
137137
app.use(ConfigCatPlugin, {
138-
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE", // // sdkKey is required
138+
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE", // sdkKey is required
139139
clientOptions: { // clientOptions is optional
140140
// ...
141141
logger: createConsoleLogger(LogLevel.Info),

0 commit comments

Comments
 (0)