Skip to content

Commit 828e6de

Browse files
committed
docs: updating type docs to clarify default overrides
1 parent a172812 commit 828e6de

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/types.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ import defaultReactContext from './context';
44

55
/**
66
* 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.
7+
* by {@link LDOptions} which are common to both the JavaScript and React SDKs.
8+
*
9+
* @remarks
10+
* This SDK defaults the `sendEventsOnlyForVariation` value from the `LDOptions` to `true`
11+
* due to previous limitations. If you want to send all events, then you should override
12+
* this default.
813
*/
914
export interface LDReactOptions {
1015
/**

0 commit comments

Comments
 (0)