Class LogSnag

Wrapper around the LogSnag API for a given project and API token.

Index

Constructors

Methods

getChannel getInsight identify

Constructors

constructor

new LogSnag(options): LogSnag
Parameters
- options: LogSnagOptions
Returns LogSnag
- Defined in logsnag.ts:10

Methods

getChannel

getChannel(name): Channel
Parameters
- name: string
Returns Channel
A Channel with the given name.
- Defined in logsnag.ts:15

getInsight

getInsight(title, defaultIcon?): Insight
Parameters
- title: string
- Optional defaultIcon: string
  The default emoji to use when updating the insight.
Returns Insight
An Insight with the given title.
- Defined in logsnag.ts:23

identify

identify(userId, properties): Promise<void>
Sets properties for the given user.
Parameters
- userId: string
- properties: UserProperties
Returns Promise<void>
A promise that resolves if the request succeeds, or rejects with an error message.

See
https://docs.logsnag.com/api-reference/identify
- Defined in logsnag.ts:32

Generated using TypeDoc