Interface LDPlugin

Interface for plugins to the LaunchDarkly SDK.

interface LDPlugin {
    getHooks?(metadata): Hook[];
    getMetadata(): LDPluginMetadata;
    register(client, environmentMetadata): void;
}

Index

Methods

getHooks? getMetadata register

Methods

`Optional` getHooks

getHooks(metadata): Hook[]
Gets a list of hooks that the plugin wants to register.

This method will be called once during SDK initialization before the register method is called.

If the plugin does not need to register any hooks, this method doesn't need to be implemented.
Parameters
- metadata: LDPluginEnvironmentMetadata
Returns Hook[]
- Defined in typings.d.ts:365

getMetadata

getMetadata(): LDPluginMetadata
Get metadata about the plugin.

Returns LDPluginMetadata
- Defined in typings.d.ts:344

register

register(client, environmentMetadata): void
Registers the plugin with the SDK. Called once during SDK initialization.

The SDK initialization will typically not have been completed at this point, so the plugin should take appropriate actions to ensure the SDK is ready before sending track events or evaluating flags.
Parameters
- client: LDClientBase
  The SDK client instance.
- environmentMetadata: LDPluginEnvironmentMetadata
  Information about the environment where the plugin is running.
Returns void
- Defined in typings.d.ts:355