Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
45 lines
1.9 KiB
Plaintext
45 lines
1.9 KiB
Plaintext
import { Client } from '../client';
|
|
import { Event, EventHint } from './event';
|
|
/** Integration interface */
|
|
export interface Integration {
|
|
/**
|
|
* The name of the integration.
|
|
*/
|
|
name: string;
|
|
/**
|
|
* 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.
|
|
*/
|
|
setupOnce?(): void;
|
|
/**
|
|
* 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`.
|
|
*/
|
|
setup?(client: Client): void;
|
|
/**
|
|
* 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.
|
|
*/
|
|
afterAllSetup?(client: Client): void;
|
|
/**
|
|
* An optional hook that allows to preprocess an event _before_ it is passed to all other event processors.
|
|
*/
|
|
preprocessEvent?(event: Event, hint: EventHint | undefined, client: Client): 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.
|
|
*/
|
|
processEvent?(event: Event, hint: EventHint, client: Client): Event | null | PromiseLike<Event | null>;
|
|
}
|
|
/**
|
|
* An integration in function form.
|
|
* This is expected to return an integration.
|
|
*/
|
|
export type IntegrationFn<IntegrationType = Integration> = (...rest: any[]) => IntegrationType;
|
|
//# sourceMappingURL=integration.d.ts.map
|