redactString

An easy way to redact sensitive information from a string

These are the docs for Trigger.dev v2 which will be deprecated on January 31st, 2025. You probably want the v3 docs.

redactString is a Tagged template that can be used to redact sensitive information from a string.

It is used internally to redact Bearer tokens in Integrations that use backgroundFetch.

Request

const response = return io.backgroundFetch<CreateCompletionResponseData>(
  "background",
  "https://someapi.com/v1/endpointname",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      //by using `redactString` the apiKey will be redacted in the logs
      Authorization: redactString`Bearer ${auth.apiKey}`,
    },
    body: JSON.stringify(params),
  }
);