Skip to content

Commit 0c1173e

Browse files
authored
docs: updating type docs to clarify default overrides (#367)
This PR will update the typedoc for this repo to clarify default override of the `sendEventsOnlyForVariation` option <img width="942" height="285" alt="image" src="https://github.com/user-attachments/assets/625caa1b-10da-428c-857e-b3bfebf3234f" />
2 parents a172812 + ae15c0c commit 0c1173e

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

src/types.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
1-
import { LDClient, LDContext, LDFlagSet, LDOptions } from 'launchdarkly-js-client-sdk';
1+
import { LDClient, LDContext, LDFlagSet, LDOptions as CommonLDOptions } from 'launchdarkly-js-client-sdk';
22
import * as React from 'react';
33
import defaultReactContext from './context';
44

5+
export interface LDOptions extends CommonLDOptions {
6+
/**
7+
* Whether analytics events should be sent only when you call variation (true), or also when you
8+
* call allFlags (false).
9+
*
10+
* By default, this is true.
11+
*/
12+
sendEventsOnlyForVariation?: boolean
13+
}
14+
515
/**
616
* Initialization options for the LaunchDarkly React SDK. These are in addition to the options exposed
7-
* by [[LDOptions]] which are common to both the JavaScript and React SDKs.
17+
* by {@link LDOptions} which are common to both the JavaScript and React SDKs.
818
*/
919
export interface LDReactOptions {
1020
/**

0 commit comments

Comments
 (0)