@launchdarkly/observability + @launchdarkly/session-replay
    Preparing search index...

    Interface Record

    interface Record {
        addSessionProperties: (properties: { [key: string]: any }) => void;
        getRecordingState: () => "NotRecording" | "Recording";
        getSession: () => null | SessionDetails;
        snapshot: (element: HTMLCanvasElement) => Promise<void>;
        start: (options?: StartOptions) => Promise<void>;
        stop: () => void;
        getHooks(metadata: LDPluginEnvironmentMetadata): Hook[];
        register(
            client: LDClient,
            environmentMetadata: LDPluginEnvironmentMetadata,
        ): void;
    }

    Implemented by

    Index

    Properties

    addSessionProperties getRecordingState getSession snapshot start stop

    Methods

    getHooks? register

    Properties

    addSessionProperties: (properties: { [key: string]: any }) => void

    Add custom session-level properties. These are attached to the current session and are searchable, but do not create timeline Track events.

    getRecordingState: () => "NotRecording" | "Recording"
    getSession: () => null | SessionDetails
    snapshot: (element: HTMLCanvasElement) => Promise<void>

    Snapshot an HTML element in WebGL manual snapshotting mode. See https://www.highlight.io/docs/getting-started/browser/replay-configuration/canvas#manual-snapshotting for more information.

    start: (options?: StartOptions) => Promise<void>

    Start the session when running in manualStart mode. Can be used to force start a new session. Can safely be called before the SDK has initialized (e.g. before the plugin registers): the call resolves once the SDK is attached and started, without throwing.

    Type declaration

      • (options?: StartOptions): Promise<void>

      • Parameters

        Returns Promise<void>

    stop: () => void

    Stop the session recording. Can safely be called before the SDK has initialized; before start() it cancels a pending start instead of throwing.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods