Class Client

Hierarchy

Client
- <internal>.default

Constructors

Protected constructor

new Client(): Client

- Defined in node_modules/@bugsnag/core/types/client.d.ts:15
Returns Client

Properties

Breadcrumb

Breadcrumb: typeof Breadcrumb

Event

Event: typeof <internal>.Event

Session

Session: typeof Session

Methods

_notify

_notify(event: <internal>.Event, onError?: OnErrorCallback, cb?: ((err: any, event: <internal>.Event) => void)): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:24
Parameters
- event: <internal>.Event
- Optional onError: OnErrorCallback
- Optional cb: ((err: any, event: <internal>.Event) => void)
  - - (err: any, event: <internal>.Event): void
    - Parameters
      - err: any
      - event: <internal>.Event
      Returns void
Returns void

addFeatureFlag

addFeatureFlag(name: string, variant?: null | string): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:44
Parameters
- name: string
- Optional variant: null | string
Returns void

addFeatureFlags

addFeatureFlags(featureFlags: FeatureFlag[]): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:45
Parameters
- featureFlags: FeatureFlag[]
Returns void

addMetadata

addMetadata(section: string, values: {}): void
addMetadata(section: string, key: string, value: any): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:38
Parameters
- section: string
- values: {}
  - [key: string]: any
Returns void
- Defined in node_modules/@bugsnag/core/types/client.d.ts:39
Parameters
- section: string
- key: string
- value: any
Returns void

addOnBreadcrumb

addOnBreadcrumb(fn: OnBreadcrumbCallback): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:69
Parameters
- fn: OnBreadcrumbCallback
Returns void

addOnError

addOnError(fn: OnErrorCallback): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:63
Parameters
- fn: OnErrorCallback
Returns void

addOnSession

addOnSession(fn: OnSessionCallback): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:66
Parameters
- fn: OnSessionCallback
Returns void

clearFeatureFlag

clearFeatureFlag(name: string): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:46
Parameters
- name: string
Returns void

clearFeatureFlags

clearFeatureFlags(): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:47
Returns void

clearMetadata

clearMetadata(section: string, key?: string): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:41
Parameters
- section: string
- Optional key: string
Returns void

getContext

getContext(): undefined | string

- Defined in node_modules/@bugsnag/core/types/client.d.ts:50
Returns undefined | string

getMetadata

getMetadata(section: string, key?: string): any

- Defined in node_modules/@bugsnag/core/types/client.d.ts:40
Parameters
- section: string
- Optional key: string
Returns any

getPlugin

getPlugin(name: string): any
getPlugin(id: "vue"): undefined | BugsnagPluginVueResult

- Defined in node_modules/@bugsnag/core/types/client.d.ts:73
Parameters
- name: string
Returns any
- Defined in node_modules/@bugsnag/plugin-vue/types/bugsnag-plugin-vue.d.ts:33
Parameters
- id: "vue"
Returns undefined | BugsnagPluginVueResult

getUser

getUser(): <internal>.User

- Defined in node_modules/@bugsnag/core/types/client.d.ts:54
Returns <internal>.User

leaveBreadcrumb

leaveBreadcrumb(message: string, metadata?: {}, type?: BreadcrumbType): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:31
Parameters
- message: string
- Optional metadata: {}
  - [key: string]: any
- Optional type: BreadcrumbType
Returns void

notify

notify(error: NotifiableError, onError?: OnErrorCallback, cb?: ((err: any, event: <internal>.Event) => void)): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:18
Parameters
- error: NotifiableError
- Optional onError: OnErrorCallback
- Optional cb: ((err: any, event: <internal>.Event) => void)
  - - (err: any, event: <internal>.Event): void
    - Parameters
      - err: any
      - event: <internal>.Event
      Returns void
Returns void

pauseSession

pauseSession(): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:59
Returns void

removeOnBreadcrumb

removeOnBreadcrumb(fn: OnBreadcrumbCallback): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:70
Parameters
- fn: OnBreadcrumbCallback
Returns void

removeOnError

removeOnError(fn: OnErrorCallback): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:64
Parameters
- fn: OnErrorCallback
Returns void

removeOnSession

removeOnSession(fn: OnSessionCallback): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:67
Parameters
- fn: OnSessionCallback
Returns void

Optional resetEventCount

resetEventCount(): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:76
Returns void

resumeSession

resumeSession(): Client

- Defined in node_modules/@bugsnag/core/types/client.d.ts:60
Returns Client

setContext

setContext(c: string): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:51
Parameters
- c: string
Returns void

setUser

setUser(id?: string, email?: string, name?: string): void

- Defined in node_modules/@bugsnag/core/types/client.d.ts:55
Parameters
- Optional id: string
- Optional email: string
- Optional name: string
Returns void

startSession

startSession(): Client

- Defined in node_modules/@bugsnag/core/types/client.d.ts:58
Returns Client

Generated using TypeDoc