Skip to content

docs: updating type docs to clarify default overrides #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 19, 2025
Merged

docs: updating type docs to clarify default overrides #367

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
828e6de
docs: updating type docs to clarify default overrides
joker23 Nov 19, 2025
ae15c0c
chore: switching to re-exporting the interface
joker23 Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
import { LDClient, LDContext, LDFlagSet, LDOptions } from 'launchdarkly-js-client-sdk';
import { LDClient, LDContext, LDFlagSet, LDOptions as CommonLDOptions } from 'launchdarkly-js-client-sdk';
import * as React from 'react';
import defaultReactContext from './context';

export interface LDOptions extends CommonLDOptions {
/**
* Whether analytics events should be sent only when you call variation (true), or also when you
* call allFlags (false).
*
* By default, this is true.
*/
sendEventsOnlyForVariation?: boolean
}

/**
* Initialization options for the LaunchDarkly React SDK. These are in addition to the options exposed
* by [[LDOptions]] which are common to both the JavaScript and React SDKs.
* by {@link LDOptions} which are common to both the JavaScript and React SDKs.
*/
export interface LDReactOptions {
/**
Expand Down