Skip to content

Commit

Permalink
fix: nodejs yarn install doc (#586)
Browse files Browse the repository at this point in the history 
* fix: nodejs yarn install doc

* fix: update typescript doc links

* fix: switch all TS types refrences to code searches
  • Loading branch information
@jonathannorris
jonathannorris authored Mar 26, 2024
1 parent f4a8aa1 commit 8bb3ae0
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions docs/sdk/client-side-sdks/javascript/javascript-gettingstarted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| ----------------- | ------- | --------------------------------------------------------------------------------------------------------------- |
Expand All @@ -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 |
| ---------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/client-side-sdks/nextjs/nextjs-usage-app.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|-----------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/client-side-sdks/nextjs/nextjs-usage-pages.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|------------------------------|---------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/client-side-sdks/react-native/react-native-gettingstarted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export default withDevCycleProvider({ sdkKey: '<DEVCYCLE_CLIENT_SDK_KEY>' })(

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 |
| -------- | ------------------------------------------------------------------------------------------ | ---------------------- |
Expand All @@ -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 |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/client-side-sdks/react/react-gettingstarted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| -------- | ------------------------------------------------------------------------------------------ | ---------------------- |
Expand All @@ -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 |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/nestjs/nestjs-gettingstarted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/node/node-gettingstarted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/node/node-install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ npm install --save @devcycle/nodejs-server-sdk
#### Yarn

```bash
yarn add @openfeature/server-sdk
yarn add @devcycle/nodejs-server-sdk
```
8 changes: 4 additions & 4 deletions docs/sdk/server-side-sdks/node/node-usage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down Expand Up @@ -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`.

Expand All @@ -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)
Expand All @@ -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 = {
Expand Down

0 comments on commit 8bb3ae0

Please sign in to comment.