Class BaseClient<O>`Abstract`

Base implementation for all JavaScript SDK clients.

Call the constructor with the corresponding options specific to the client subclass. To access these options later, use getOptions.

If a Dsn is specified in the options, it will be parsed and stored. Use getDsn to retrieve the Dsn at any moment. In case the Dsn is invalid, the constructor will throw a SentryException. Note that without a valid Dsn, the SDK will not send any events to Sentry.

Before sending an event, it is passed through _prepareEvent to add SDK information and scope data (breadcrumbs and context). To add more custom information, override this method and extend the resulting prepared event.

To issue automatically created events (e.g. via instrumentation), use captureEvent. It will prepare the event and pass it through the callback lifecycle. To issue auto-breadcrumbs, use Client.addBreadcrumb.

Example

class NodeClient extends BaseClient<NodeOptions> {
  public constructor(options: NodeOptions) {
    super(options);
  }

  // ...
}

Type Parameters

O extends ClientOptions

Hierarchy

BaseClient

Implements

Client<O>

Constructors

`Protected` constructor

new BaseClient<O>(options): BaseClient<O>
Initializes this client instance.
Type Parameters
- O extends ClientOptions<BaseTransportOptions, O>
Parameters
- options: O
  
  Options for the client.
Returns BaseClient<O>
- Defined in core/src/baseclient.ts:115

Properties

`Protected` `Optional` `Readonly` _dsn

_dsn?: DsnComponents

The client Dsn, if specified in options. Without this Dsn, the SDK will be disabled.

`Protected` _integrations

_integrations: IntegrationIndex = {}

Array of set up integrations.

`Protected` _integrationsInitialized

_integrationsInitialized: boolean = false

Indicates whether this client's integrations have been set up.

`Protected` _numProcessing

_numProcessing: number = 0

Number of calls being processed

`Protected` `Readonly` _options

_options: O

Options passed to the SDK.

Methods

`Protected` _captureEvent

_captureEvent(event, hint?, scope?): PromiseLike<undefined | string>
Processes the event and logs an error in case of rejection
Parameters
- event: Event
- hint: EventHint = {}
- Optional scope: Scope
Returns PromiseLike<undefined | string>
- Defined in core/src/baseclient.ts:550

`Protected` _clearOutcomes

_clearOutcomes(): Outcome[]
Clears outcomes on this client and returns them.

Returns Outcome[]
- Defined in core/src/baseclient.ts:705

`Protected` _isClientDoneProcessing

_isClientDoneProcessing(timeout?): PromiseLike<boolean>
Determine if the client is finished processing. Returns a promise because it will wait timeout ms before saying "no" (resolving to false) in order to give the client a chance to potentially finish first.
Parameters
- Optional timeout: number
  
  The time, in ms, after which to resolve to false if the client is still busy. Passing 0 (or not passing anything) will make the promise wait as long as it takes for processing to finish before resolving to true.
Returns PromiseLike<boolean>
A promise which will resolve to true if processing is already done or finishes before the timeout, and false otherwise
- Defined in core/src/baseclient.ts:467

`Protected` _isEnabled

_isEnabled(): boolean
Determines whether this SDK is enabled and a valid Dsn is present.

Returns boolean
- Defined in core/src/baseclient.ts:488

`Protected` _prepareEvent

_prepareEvent(event, hint, scope?): PromiseLike<null | Event>
Adds common information to events.

The information includes release and environment from options, breadcrumbs and context (extra, tags and user) from the scope.

Information that is already present in the event is never overwritten. For nested objects, such as the context, keys are merged.
Parameters
- event: Event
  
  The original event.
- hint: EventHint
  
  May contain additional information about the original exception.
- Optional scope: Scope
  
  A scope containing event metadata.
Returns PromiseLike<null | Event>
A new event with more information.
- Defined in core/src/baseclient.ts:506

`Protected` _process

_process<T>(promise): void
Occupies the client with processing and event
Type Parameters
- T
Parameters
- promise: PromiseLike<T>
Returns void
- Defined in core/src/baseclient.ts:673

`Protected` _processEvent

_processEvent(event, hint, scope?): PromiseLike<Event>
Processes an event (either error or message) and sends it to Sentry.

This also adds breadcrumbs and context information to the event. However, platform specific meta data (such as the User's IP address) must be added by the SDK implementor.
Parameters
- event: Event
  
  The event to send to Sentry.
- hint: EventHint
  
  May contain additional information about the original exception.
- Optional scope: Scope
  
  A scope containing event metadata.
Returns PromiseLike<Event>
A SyncPromise that resolves with the event or rejects in case event was/will not be send.
- Defined in core/src/baseclient.ts:584

`Protected` _sendEnvelope

_sendEnvelope(envelope): void | PromiseLike<void | TransportMakeRequestResponse>
Parameters
- envelope: Envelope
Returns void | PromiseLike<void | TransportMakeRequestResponse>

Inherit Doc
- Defined in core/src/baseclient.ts:690

`Protected` _updateSessionFromEvent

_updateSessionFromEvent(session, event): void
Updates existing session based on the provided event
Parameters
- session: Session
- event: Event
Returns void
- Defined in core/src/baseclient.ts:425

addIntegration

addIntegration(integration): void
Add an integration to the client. This can be used to e.g. lazy load integrations. In most cases, this should not be necessary, and you're better off just passing the integrations via integrations: [] at initialization time. However, if you find the need to conditionally load & add an integration, you can use addIntegration to do so.

TODO (v8): Make this a required method.
Parameters
- integration: Integration
Returns void
Implementation of Client.addIntegration
- Defined in core/src/baseclient.ts:312

captureEvent

captureEvent(event, hint?, scope?): undefined | string
Captures a manually created event and sends it to Sentry.
Parameters
- event: Event
  
  The event to send to Sentry.
- Optional hint: EventHint
  
  May contain additional information about the original exception.
- Optional scope: Scope
  
  An optional scope containing event metadata.
Returns undefined | string
The event id
Implementation of Client.captureEvent
- Defined in core/src/baseclient.ts:188

captureException

captureException(exception, hint?, scope?): undefined | string
Captures an exception event and sends it to Sentry.
Parameters
- exception: any
  
  An exception-like object.
- Optional hint: EventHint
  
  May contain additional information about the original exception.
- Optional scope: Scope
  
  An optional scope containing event metadata.
Returns undefined | string
The event id
Implementation of Client.captureException
- Defined in core/src/baseclient.ts:138

captureMessage

captureMessage(message, level?, hint?, scope?): undefined | string
Captures a message event and sends it to Sentry.
Parameters
- message: string
  
  The message to send to Sentry.
- Optional level: Severity | SeverityLevel
  
  Define the level of the message.
- Optional hint: EventHint
  
  May contain additional information about the original exception.
- Optional scope: Scope
  
  An optional scope containing event metadata.
Returns undefined | string
The event id
Implementation of Client.captureMessage
- Defined in core/src/baseclient.ts:161

captureSession

captureSession(session): void
Captures a session
Parameters
- session: Session
  
  Session to be delivered
Returns void
Implementation of Client.captureSession
- Defined in core/src/baseclient.ts:209

close

close(timeout?): PromiseLike<boolean>
Flush the event queue and set the client to enabled = false. See flush.
Parameters
- Optional timeout: number
  
  Maximum time in ms the client should wait before shutting down. Omitting this parameter will cause the client to wait until all events are sent before disabling itself.
Returns PromiseLike<boolean>
A promise which resolves to true if the flush completes successfully before the timeout, or false if it doesn't.
Implementation of Client.close
- Defined in core/src/baseclient.ts:271

emit

emit(hook, transaction): void
Fire a hook event for transaction start and finish. Expects to be given a transaction as the second argument.
Parameters
- hook: "startTransaction" | "finishTransaction"
- transaction: Transaction
Returns void
Implementation of Client.emit
- Defined in core/src/baseclient.ts:402
emit(hook, envelope): void
Fire a hook for when a breadcrumb is added. Expects the breadcrumb as second argument.
Parameters
- hook: "beforeEnvelope"
- envelope: Envelope
Returns void
Implementation of Client.emit
- Defined in core/src/baseclient.ts:405
emit(hook, event, sendResponse): void
Fire a hook for when a DSC (Dynamic Sampling Context) is created. Expects the DSC as second argument.
Parameters
- hook: "afterSendEvent"
- event: Event
- sendResponse: void | TransportMakeRequestResponse
Returns void
Implementation of Client.emit
- Defined in core/src/baseclient.ts:408
emit(hook, breadcrumb, hint?): void
Parameters
- hook: "beforeAddBreadcrumb"
- breadcrumb: Breadcrumb
- Optional hint: BreadcrumbHint
Returns void

Inherit Doc
Implementation of Client.emit
- Defined in core/src/baseclient.ts:411
emit(hook, dsc): void
Parameters
- hook: "createDsc"
- dsc: DynamicSamplingContext
Returns void

Inherit Doc
Implementation of Client.emit
- Defined in core/src/baseclient.ts:414

`Abstract` eventFromException

eventFromException(_exception, _hint?): PromiseLike<Event>
Creates an Event from all inputs to captureException and non-primitive inputs to captureMessage.
Parameters
- _exception: any
- Optional _hint: EventHint
Returns PromiseLike<Event>
Implementation of Client.eventFromException
- Defined in core/src/baseclient.ts:722

`Abstract` eventFromMessage

eventFromMessage(_message, _level?, _hint?): PromiseLike<Event>
Creates an Event from primitive inputs to captureMessage.
Parameters
- _message: string
- Optional _level: Severity | SeverityLevel
- Optional _hint: EventHint
Returns PromiseLike<Event>
Implementation of Client.eventFromMessage
- Defined in core/src/baseclient.ts:727

flush

flush(timeout?): PromiseLike<boolean>
Wait for all events to be sent or the timeout to expire, whichever comes first.
Parameters
- Optional timeout: number
  
  Maximum time in ms the client should wait for events to be flushed. Omitting this parameter will cause the client to wait until all events are sent before resolving the promise.
Returns PromiseLike<boolean>
A promise that will resolve with true if all events are sent before the timeout, or false if there are still events in the queue when the timeout is reached.
Implementation of Client.flush
- Defined in core/src/baseclient.ts:257

getDsn

getDsn(): undefined | DsnComponents
Returns the current Dsn.

Returns undefined | DsnComponents
Implementation of Client.getDsn
- Defined in core/src/baseclient.ts:227

getIntegration

getIntegration<T>(integration): null | T
Returns the client's instance of the given integration class, it any.
Type Parameters
- T extends Integration
Parameters
- integration: IntegrationClass<T>
Returns null | T
Implementation of Client.getIntegration
- Defined in core/src/baseclient.ts:300

getIntegrationById

getIntegrationById(integrationId): undefined | Integration
Gets an installed integration by its id.
Parameters
- integrationId: string
Returns undefined | Integration
The installed integration or undefined if no integration with that id was installed.
- Defined in core/src/baseclient.ts:293

getOptions

getOptions(): O
Returns the current options.

Returns O
Implementation of Client.getOptions
- Defined in core/src/baseclient.ts:234

getSdkMetadata

getSdkMetadata(): undefined | SdkMetadata
Returns undefined | SdkMetadata
The metadata of the SDK

See
SdkMetadata in @sentry/types
Implementation of Client.getSdkMetadata
- Defined in core/src/baseclient.ts:243

getTransport

getTransport(): undefined | Transport
Returns the transport that is used by the client. Please note that the transport gets lazy initialized so it will only be there once the first event has been sent.

Returns undefined | Transport
The transport.
Implementation of Client.getTransport
- Defined in core/src/baseclient.ts:250

on

on(hook, callback): void
Register a callback for transaction start and finish.
Parameters
- hook: "startTransaction" | "finishTransaction"
- callback: ((transaction) => void)
  - - (transaction): void
    - Parameters
      
      transaction: Transaction
      
      Returns void
Returns void
Implementation of Client.on
- Defined in core/src/baseclient.ts:374
on(hook, callback): void
Register a callback for transaction start and finish.
Parameters
- hook: "beforeEnvelope"
- callback: ((envelope) => void)
  - - (envelope): void
    - Parameters
      
      envelope: Envelope
      
      Returns void
Returns void
Implementation of Client.on
- Defined in core/src/baseclient.ts:377
on(hook, callback): void
Register a callback for when an event has been sent.
Parameters
- hook: "afterSendEvent"
- callback: ((event, sendResponse) => void)
  - - (event, sendResponse): void
    - Parameters
      
      event: Event
      
      sendResponse: void | TransportMakeRequestResponse
      
      Returns void
Returns void
Implementation of Client.on
- Defined in core/src/baseclient.ts:380
on(hook, callback): void
Register a callback before a breadcrumb is added.
Parameters
- hook: "beforeAddBreadcrumb"
- callback: ((breadcrumb, hint?) => void)
  - - (breadcrumb, hint?): void
    - Parameters
      
      breadcrumb: Breadcrumb
      
      Optional hint: BreadcrumbHint
      
      Returns void
Returns void
Implementation of Client.on
- Defined in core/src/baseclient.ts:386
on(hook, callback): void
Register a callback whena DSC (Dynamic Sampling Context) is created.
Parameters
- hook: "createDsc"
- callback: ((dsc) => void)
  - - (dsc): void
    - Parameters
      
      dsc: DynamicSamplingContext
      
      Returns void
Returns void
Implementation of Client.on
- Defined in core/src/baseclient.ts:389

recordDroppedEvent

recordDroppedEvent(reason, category, _event?): void
Record on the client that an event got dropped (ie, an event that will not be sent to sentry).
Parameters
- reason: EventDropReason
  
  The reason why the event got dropped.
- category: DataCategory
- Optional _event: Event
  
  The dropped event.
Returns void
Implementation of Client.recordDroppedEvent
- Defined in core/src/baseclient.ts:353

sendEvent

sendEvent(event, hint?): void
Submits the event to Sentry
Parameters
- event: Event
- hint: EventHint = {}
Returns void
Implementation of Client.sendEvent
- Defined in core/src/baseclient.ts:319

sendSession

sendSession(session): void
Submits the session to Sentry
Parameters
- session: Session | SessionAggregates
Returns void
Implementation of Client.sendSession
- Defined in core/src/baseclient.ts:343

setupIntegrations

setupIntegrations(): void
Sets up the integrations

Returns void
Implementation of Client.setupIntegrations
- Defined in core/src/baseclient.ts:281

Class BaseClient<O>Abstract

Example

Type Parameters

O extends ClientOptions

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type Parameters

O extends ClientOptions<BaseTransportOptions, O>

Parameters

options: O

Returns BaseClient<O>

Properties

Protected Optional Readonly _dsn

Protected _integrations

Protected _integrationsInitialized

Protected _numProcessing

Protected Readonly _options

Methods

Protected _captureEvent

Parameters

event: Event

hint: EventHint = {}

Optional scope: Scope

Returns PromiseLike<undefined | string>

Protected _clearOutcomes

Returns Outcome[]

Protected _isClientDoneProcessing

Parameters

Optional timeout: number

Returns PromiseLike<boolean>

Protected _isEnabled

Returns boolean

Protected _prepareEvent

Parameters

event: Event

hint: EventHint

Optional scope: Scope

Returns PromiseLike<null | Event>

Protected _process

Type Parameters

T

Parameters

promise: PromiseLike<T>

Returns void

Protected _processEvent

Parameters

event: Event

hint: EventHint

Optional scope: Scope

Returns PromiseLike<Event>

Protected _sendEnvelope

Parameters

envelope: Envelope

Returns void | PromiseLike<void | TransportMakeRequestResponse>

Inherit Doc

Protected _updateSessionFromEvent

Parameters

session: Session

event: Event

Returns void

addIntegration

Parameters

integration: Integration

Returns void

captureEvent

Parameters

event: Event

Optional hint: EventHint

Optional scope: Scope

Returns undefined | string

captureException

Parameters

exception: any

Optional hint: EventHint

Class BaseClient<O>`Abstract`

`Protected` constructor

`Protected` `Optional` `Readonly` _dsn

`Protected` _integrations

`Protected` _integrationsInitialized

`Protected` _numProcessing

`Protected` `Readonly` _options

`Protected` _captureEvent

`Optional` scope: Scope

`Protected` _clearOutcomes

`Protected` _isClientDoneProcessing

`Optional` timeout: number

`Protected` _isEnabled

`Protected` _prepareEvent

`Optional` scope: Scope

`Protected` _process

`Protected` _processEvent

`Optional` scope: Scope

`Protected` _sendEnvelope

`Protected` _updateSessionFromEvent

`Optional` hint: EventHint

`Optional` scope: Scope

`Optional` hint: EventHint

`Optional` scope: Scope

`Optional` level: Severity | SeverityLevel

`Optional` hint: EventHint

`Optional` scope: Scope

`Optional` timeout: number

`Optional` hint: BreadcrumbHint

`Abstract` eventFromException

`Optional` _hint: EventHint

`Abstract` eventFromMessage

`Optional` _level: Severity | SeverityLevel

`Optional` _hint: EventHint

`Optional` timeout: number