From 8bb3ae059849e54d150ae30731217c3342b3c760 Mon Sep 17 00:00:00 2001 From: Jonathan Norris Date: Tue, 26 Mar 2024 16:51:58 -0400 Subject: [PATCH] fix: nodejs yarn install doc (#586) * fix: nodejs yarn install doc * fix: update typescript doc links * fix: switch all TS types refrences to code searches --- .../javascript/javascript-gettingstarted.md | 4 ++-- docs/sdk/client-side-sdks/nextjs/nextjs-usage-app.md | 2 +- docs/sdk/client-side-sdks/nextjs/nextjs-usage-pages.md | 2 +- .../react-native/react-native-gettingstarted.md | 4 ++-- docs/sdk/client-side-sdks/react/react-gettingstarted.md | 4 ++-- docs/sdk/server-side-sdks/nestjs/nestjs-gettingstarted.md | 2 +- docs/sdk/server-side-sdks/node/node-gettingstarted.md | 2 +- docs/sdk/server-side-sdks/node/node-install.md | 2 +- docs/sdk/server-side-sdks/node/node-usage.md | 8 ++++---- 9 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/sdk/client-side-sdks/javascript/javascript-gettingstarted.md b/docs/sdk/client-side-sdks/javascript/javascript-gettingstarted.md index bb082d9e..03002d32 100644 --- a/docs/sdk/client-side-sdks/javascript/javascript-gettingstarted.md +++ b/docs/sdk/client-side-sdks/javascript/javascript-gettingstarted.md @@ -50,7 +50,7 @@ const devcycleClient = initializeDevCycle( ## DevCycleUser Object -[DevCycleUser Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts) +[DevCycleUser Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleUser+language%3ATypeScript+path%3A*types.ts&type=code) | Property | Type | Description | | ----------------- | ------- | --------------------------------------------------------------------------------------------------------------- | @@ -69,7 +69,7 @@ const devcycleClient = initializeDevCycle( The SDK exposes various initialization options which can be set on the `initialization()` method: -[DevCycleOptions Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L44) +[DevCycleOptions Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleOptions+language%3ATypeScript+path%3A*types.ts&type=code) | DevCycle Option | Type | Description | | ---------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | diff --git a/docs/sdk/client-side-sdks/nextjs/nextjs-usage-app.md b/docs/sdk/client-side-sdks/nextjs/nextjs-usage-app.md index 89778b27..386a1b9c 100644 --- a/docs/sdk/client-side-sdks/nextjs/nextjs-usage-app.md +++ b/docs/sdk/client-side-sdks/nextjs/nextjs-usage-app.md @@ -267,7 +267,7 @@ for more details. The SDK exposes various initialization options which can be set by passing a `DevCycleOptions` object in the setupDevCycle method: -[DevCycleOptions Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L44) +[DevCycleOptions Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleOptions+language%3ATypeScript+path%3A*types.ts&type=code) | DevCycle Option | Type | Description | |-----------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| diff --git a/docs/sdk/client-side-sdks/nextjs/nextjs-usage-pages.md b/docs/sdk/client-side-sdks/nextjs/nextjs-usage-pages.md index 92626dfb..bb937f04 100644 --- a/docs/sdk/client-side-sdks/nextjs/nextjs-usage-pages.md +++ b/docs/sdk/client-side-sdks/nextjs/nextjs-usage-pages.md @@ -101,7 +101,7 @@ However, it omits features that rely on the dynamic request information to work. The SDK exposes various initialization options which can be set by passing a `DevCycleOptions` object in the setupDevCycle method: -[DevCycleOptions Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L44) +[DevCycleOptions Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleOptions+language%3ATypeScript+path%3A*types.ts&type=code) | DevCycle Option | Type | Description | |------------------------------|---------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| diff --git a/docs/sdk/client-side-sdks/react-native/react-native-gettingstarted.md b/docs/sdk/client-side-sdks/react-native/react-native-gettingstarted.md index 5d2a0cc3..3be41fca 100644 --- a/docs/sdk/client-side-sdks/react-native/react-native-gettingstarted.md +++ b/docs/sdk/client-side-sdks/react-native/react-native-gettingstarted.md @@ -66,7 +66,7 @@ export default withDevCycleProvider({ sdkKey: '' })( The `withDevCycleProvider` function accepts a Provider Config object: -[DevCycle ProviderConfig Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/react/src/types.ts#L3) +[DevCycle ProviderConfig Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+type+ProviderConfig+language%3ATypeScript+path%3A*types.ts&type=code) | Property | Type | Description | | -------- | ------------------------------------------------------------------------------------------ | ---------------------- | @@ -78,7 +78,7 @@ The `withDevCycleProvider` function accepts a Provider Config object: The SDK exposes various initialization options which can be set by passing a `DevCycleOptions` object in the Provider Config: -[DevCycleOptions Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L44) +[DevCycleOptions Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleOptions+language%3ATypeScript+path%3A*types.ts&type=code) | DevCycle Option | Type | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | diff --git a/docs/sdk/client-side-sdks/react/react-gettingstarted.md b/docs/sdk/client-side-sdks/react/react-gettingstarted.md index dca208e9..1295974b 100644 --- a/docs/sdk/client-side-sdks/react/react-gettingstarted.md +++ b/docs/sdk/client-side-sdks/react/react-gettingstarted.md @@ -114,7 +114,7 @@ export default withDevCycleProvider({ The `withDevCycleProvider` function accepts a Provider Config object: -[DevCycle ProviderConfig Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/react/src/types.ts#L3) +[DevCycle ProviderConfig Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+type+ProviderConfig+language%3ATypeScript+path%3A*types.ts&type=code) | Property | Type | Description | | -------- | ------------------------------------------------------------------------------------------ | ---------------------- | @@ -126,7 +126,7 @@ The `withDevCycleProvider` function accepts a Provider Config object: The SDK exposes various initialization options which can be set by passing a `DevCycleOptions` object in the Provider Config: -[DevCycleOptions Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L44) +[DevCycleOptions Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleOptions+language%3ATypeScript+path%3A*types.ts&type=code) | DevCycle Option | Type | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | diff --git a/docs/sdk/server-side-sdks/nestjs/nestjs-gettingstarted.md b/docs/sdk/server-side-sdks/nestjs/nestjs-gettingstarted.md index ef1229af..63543a63 100644 --- a/docs/sdk/server-side-sdks/nestjs/nestjs-gettingstarted.md +++ b/docs/sdk/server-side-sdks/nestjs/nestjs-gettingstarted.md @@ -41,7 +41,7 @@ To use the [decorators](/sdk/server-side-sdks/nestjs/nestjs-usage#decorators) pr The `userFactory` is a function which accepts the current `ExecutionContext` as a parameter and returns a DevCycle User object. The user factory will be evaluated as a global interceptor, and the resulting user will be used when evaluating variables with the `@VariableValue` and `@RequireVariableValue` decorators. -[DevCycleUser Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L130) +[DevCycleUser Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleUser+language%3ATypeScript+path%3A*types.ts&type=code) ```typescript import { DevCycleModule } from '@devcycle/nestjs-server-sdk' diff --git a/docs/sdk/server-side-sdks/node/node-gettingstarted.md b/docs/sdk/server-side-sdks/node/node-gettingstarted.md index 5f903830..d2aceba1 100644 --- a/docs/sdk/server-side-sdks/node/node-gettingstarted.md +++ b/docs/sdk/server-side-sdks/node/node-gettingstarted.md @@ -37,7 +37,7 @@ const devcycleClient = await initializeDevCycle( The SDK exposes various initialization options which can be set on the `initialization()` method: -[DevCycleOptions Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L43) +[DevCycleOptions Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleOptions+language%3ATypeScript+path%3A*types.ts&type=code) ```javascript const devcycleClient = await DevCycle.initializeDevCycle( diff --git a/docs/sdk/server-side-sdks/node/node-install.md b/docs/sdk/server-side-sdks/node/node-install.md index 22dc99e8..cb96b40a 100644 --- a/docs/sdk/server-side-sdks/node/node-install.md +++ b/docs/sdk/server-side-sdks/node/node-install.md @@ -19,5 +19,5 @@ npm install --save @devcycle/nodejs-server-sdk #### Yarn ```bash -yarn add @openfeature/server-sdk +yarn add @devcycle/nodejs-server-sdk ``` diff --git a/docs/sdk/server-side-sdks/node/node-usage.md b/docs/sdk/server-side-sdks/node/node-usage.md index ad9a4f4b..485423a9 100644 --- a/docs/sdk/server-side-sdks/node/node-usage.md +++ b/docs/sdk/server-side-sdks/node/node-usage.md @@ -14,7 +14,7 @@ sidebar_custom_props: { icon: material-symbols:toggle-on } The full user data must be passed into every method. The only required field is the `user_id`. The rest are optional and are used by the system for user segmentation into variables and features. -[DevCycleUser Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L130) +[DevCycleUser Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleUser+language%3ATypeScript+path%3A*types.ts&type=code) ```javascript const user = { @@ -43,7 +43,7 @@ if (value) { The default value can be of type string, boolean, number, or object. -If you would like to get the full Variable object defined by [DVCVariable Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L192) +If you would like to get the full Variable object defined by [DVCVariable Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DVCVariable%3C+language%3ATypeScript+path%3A*types.ts&type=code) you can use `devcycleClient.variable()` instead. This contains fields such as: `key`, `value`, `type`, `defaultValue`, `isDefaulted`. @@ -70,7 +70,7 @@ of other DevCycle features such as [Code Usage detection](/integrations/github/f You can fetch all segmented features for a user: -[DVCFeature Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L29) +[DVCFeature Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+%22export+type+DVCFeature%22+language%3ATypeScript+path%3A*types.ts&type=code) ```javascript const features = devcycleClient.allFeatures(user) @@ -84,7 +84,7 @@ Track a custom event for a user, pass in the user and event object. Calling Track will queue the event, which will be sent in batches to the DevCycle servers. -[DevCycleEvent Typescript Schema](https://github.com/DevCycleHQ/js-sdks/blob/main/sdk/js/src/types.ts#L229) +[DevCycleEvent Typescript Schema](https://github.com/search?q=repo%3ADevCycleHQ%2Fjs-sdks+export+interface+DevCycleEvent+language%3ATypeScript+path%3A*types.ts&type=code) ```typescript const event: DevCycleEvent = {