TriggerClient: constructor

The TriggerClient() constructor creates a new TriggerClient object.

Parameters

options · object · required

Hide properties

id · string · required

The id property is used to uniquely identify the client.

apiKey · string

The apiKey property is the API Key for your Trigger.dev environment. We recommend using an environment variable to store your API Key.

apiUrl · string

The apiUrl property is an optional property that specifies the API URL. You only need to specify this if you are not using Trigger.dev Cloud and are running your own Trigger.dev instance.

logLevel · log | error | warn | info | debug

The logLevel property is an optional property that specifies the level of logging for the TriggerClient. The level is inherited by all Jobs that use this Client, unless they also specify a logLevel.

• log - logs only essential messages
• error - logs error messages
• warn - logs errors and warning messages
• info - logs errors, warnings and info messages
• debug - logs everything with full verbosity

verbose · boolean

Very verbose log messages, default to false.

ioLogLocalEnabled · boolean

Default is false. If set to true it will log to the server’s console as well as the Trigger.dev platform

Returns

TriggerClient instance · TriggerClient

Example

export const client = new TriggerClient({
  id: "my-webapp",
  apiKey: process.env.TRIGGER_API_KEY!,
  logLevel: "debug",
});