Takaro - v0.6.0
    Preparing search index...

    Interface FeatureFlagsIntegration

    interface FeatureFlagsIntegration {
        addFeatureFlag: (name: string, value: unknown) => void;
        name: string;
        afterAllSetup?(client: Client): void;
        preprocessEvent?(
            event: Event,
            hint: EventHint | undefined,
            client: Client,
        ): void;
        processEvent?(
            event: Event,
            hint: EventHint,
            client: Client,
        ): Event | PromiseLike<Event | null> | null;
        setup?(client: Client): void;
        setupOnce?(): void;
    }

    Hierarchy

    • Integration
      • FeatureFlagsIntegration
    Index

    Properties

    addFeatureFlag: (name: string, value: unknown) => void
    name: string

    The name of the integration.

    Methods

    • This hook is triggered after setupOnce() and setup() have been called for all integrations. You can use it if it is important that all other integrations have been run before.

      Parameters

      • client: Client

      Returns void

    • An optional hook that allows to preprocess an event before it is passed to all other event processors.

      Parameters

      Returns void

    • An optional hook that allows to process an event. Return null to drop the event, or mutate the event & return it. This receives the client that the integration was installed for as third argument.

      Parameters

      Returns Event | PromiseLike<Event | null> | null

    • Set up an integration for the given client. Receives the client as argument.

      Whenever possible, prefer this over setupOnce, as that is only run for the first client, whereas setup runs for each client. Only truly global things (e.g. registering global handlers) should be done in setupOnce.

      Parameters

      • client: Client

      Returns void

    • This hook is only called once, even if multiple clients are created. It does not receives any arguments, and should only use for e.g. global monkey patching and similar things.

      Returns void