Class Resonate

constructor

• new Resonate(
      options?: {
          encryptor?: Encryptor;
          group?: string;
          logger?: Logger;
          logLevel?: LogLevel;
          network?: Network;
          pid?: string;
          prefix?: string;
          timeout?: number;
          token?: string;
          ttl?: number;
          url?: string;
          verbose?: boolean;
      },
  ): Resonate

  Creates a new Resonate client instance.

  Parameters

  • options: {
        encryptor?: Encryptor;
        group?: string;
        logger?: Logger;
        logLevel?: LogLevel;
        network?: Network;
        pid?: string;
        prefix?: string;
        timeout?: number;
        token?: string;
        ttl?: number;
        url?: string;
        verbose?: boolean;
    } = {}

    Configuration options for the client.

    • Optionalencryptor?: Encryptor

      Payload encryptor. Defaults to NoopEncryptor.

    • Optionalgroup?: string

      Worker group name. Defaults to "default".

    • Optionallogger?: Logger

      Custom logger implementation. Defaults to ConsoleLogger.

    • OptionallogLevel?: LogLevel

      Log level for the default ConsoleLogger. Defaults to "warn". Takes precedence over verbose.

    • Optionalnetwork?: Network

      Custom network implementation. Defaults to undefined.

    • Optionalpid?: string

      Process identifier for the client. Defaults to a random UUID.

    • Optionalprefix?: string

      ID prefix applied to generated IDs. Defaults to process.env.RESONATE_PREFIX when set.

    • Optionaltimeout?: number

      Network request timeout. Passed through to HttpNetwork which falls back to RESONATE_TIMEOUT env var (default: 10s).

    • Optionaltoken?: string

      Bearer token for authentication. Passed through to HttpNetwork which falls back to RESONATE_TOKEN env var.

    • Optionalttl?: number

      Time-to-live (in seconds) for claimed tasks. Defaults to 1 * util.MIN.

    • Optionalurl?: string

      Resonate server URL. Falls back to process.env.RESONATE_URL. If no URL is resolved, a local in-memory network is used.

    • Optionalverbose?: boolean

      Enables verbose logging (shorthand for logLevel: "debug"). Defaults to false.

  Returns Resonate

Readonlypromises

Readonlyschedules

beginRpc

• beginRpc<F extends Func>(
      id: string,
      func: F,
      ...args: [...Params<F>[], Options?],
  ): Promise<ResonateHandle<Return<F>>>

  Type Parameters

  • F extends Func

  Parameters

  • id: string
  • func: F
  • ...args: [...Params<F>[], Options?]

  Returns Promise<ResonateHandle<Return<F>>>

• beginRpc<T>(
      id: string,
      func: string,
      ...args: any[],
  ): Promise<ResonateHandle<T>>

  Type Parameters

  • T

  Parameters

  • id: string
  • func: string
  • ...args: any[]

  Returns Promise<ResonateHandle<T>>

• beginRpc(
      id: string,
      funcOrName: string | Func,
      ...args: any[],
  ): Promise<ResonateHandle<any>>

  Parameters

  • id: string
  • funcOrName: string | Func
  • ...args: any[]

  Returns Promise<ResonateHandle<any>>

beginRun

• beginRun<F extends Func>(
      id: string,
      func: F,
      ...args: [...Params<F>[], Options?],
  ): Promise<ResonateHandle<Return<F>>>

  Type Parameters

  • F extends Func

  Parameters

  • id: string
  • func: F
  • ...args: [...Params<F>[], Options?]

  Returns Promise<ResonateHandle<Return<F>>>

• beginRun<T>(
      id: string,
      func: string,
      ...args: any[],
  ): Promise<ResonateHandle<T>>

  Type Parameters

  • T

  Parameters

  • id: string
  • func: string
  • ...args: any[]

  Returns Promise<ResonateHandle<T>>

• beginRun(
      id: string,
      funcOrName: string | Func,
      ...args: any[],
  ): Promise<ResonateHandle<any>>

  Parameters

  • id: string
  • funcOrName: string | Func
  • ...args: any[]

  Returns Promise<ResonateHandle<any>>

get

• get<T = any>(id: string): Promise<ResonateHandle<T>>

  Type Parameters

  • T = any

  Parameters

  • id: string

  Returns Promise<ResonateHandle<T>>

options

• options(
      opts?: Partial<
          Pick<
              Options,
              "tags"
              | "target"
              | "timeout"
              | "version"
              | "retryPolicy",
          >,
      >,
  ): Options

  Builds a resolved Options object by merging the provided partial options with the client's defaults.

  This is useful for inspecting the effective configuration that would be applied to a run, rpc, or schedule call, or for passing explicit options to the convenience methods on a ResonateFunc handle.

  Parameters

  • opts: Partial<
        Pick<Options, "tags" | "target" | "timeout" | "version" | "retryPolicy">,
    > = {}

    Partial options to merge. Supports tags, target, timeout, version, and retryPolicy.

  Returns Options

  A fully resolved Options object.

register

• register<F extends Func>(
      name: string,
      func: F,
      options?: { version?: number },
  ): ResonateFunc<F>

  Registers a function with Resonate for execution and version control.

  Type Parameters

  • F extends Func

  Parameters

  • name: string
  • func: F
  • Optionaloptions: { version?: number }

  Returns ResonateFunc<F>

• register<F extends Func>(
      func: F,
      options?: { version?: number },
  ): ResonateFunc<F>

  Registers a function with Resonate for execution and version control.

  Type Parameters

  • F extends Func

  Parameters

  • func: F
  • Optionaloptions: { version?: number }

  Returns ResonateFunc<F>

rpc

• rpc<F extends Func>(
      id: string,
      func: F,
      ...args: [...Params<F>[], Options?],
  ): Promise<Return<F>>

  Type Parameters

  • F extends Func

  Parameters

  • id: string
  • func: F
  • ...args: [...Params<F>[], Options?]

  Returns Promise<Return<F>>

• rpc<T>(id: string, name: string, ...args: any[]): Promise<T>

  Type Parameters

  • T

  Parameters

  • id: string
  • name: string
  • ...args: any[]

  Returns Promise<T>

• rpc<T>(id: string, funcOrName: string | Func, ...args: any[]): Promise<T>

  Type Parameters

  • T

  Parameters

  • id: string
  • funcOrName: string | Func
  • ...args: any[]

  Returns Promise<T>

run

• run<F extends Func>(
      id: string,
      func: F,
      ...args: [...Params<F>[], Options?],
  ): Promise<Return<F>>

  Type Parameters

  • F extends Func

  Parameters

  • id: string
  • func: F
  • ...args: [...Params<F>[], Options?]

  Returns Promise<Return<F>>

• run<T>(id: string, name: string, ...args: any[]): Promise<T>

  Type Parameters

  • T

  Parameters

  • id: string
  • name: string
  • ...args: any[]

  Returns Promise<T>

• run<T>(id: string, funcOrName: string | Func, ...args: any[]): Promise<T>

  Type Parameters

  • T

  Parameters

  • id: string
  • funcOrName: string | Func
  • ...args: any[]

  Returns Promise<T>

schedule

• schedule<F extends Func>(
      name: string,
      cron: string,
      func: F,
      ...args: [...Params<F>[], Options?],
  ): Promise<ResonateSchedule>

  Creates a recurring schedule that invokes a registered function on a cron interval.

  The schedule is persisted on the Resonate Server and triggers a new durable promise for each cron tick. The generated promise IDs include the schedule name and timestamp to ensure uniqueness across invocations.

  If a function reference is provided, it must already be registered via register. Alternatively, a function name (string) can be used for remote dispatch.

  Type Parameters

  • F extends Func

  Parameters

  • name: string

    A unique name identifying this schedule.

  • cron: string

    A cron expression defining the recurrence interval (e.g., "* * * * *" for every minute).

  • func: F
  • ...args: [...Params<F>[], Options?]

    Positional arguments and optional configuration parameters passed to the function.

  Returns Promise<ResonateSchedule>

  A ResonateSchedule handle with a delete() method to remove the schedule.

  Example

  const schedule = await resonate.schedule("daily-report", "0 0 * * *", generateReport);
  // Later, to remove:
  await schedule.delete();
  Copy

• schedule(
      name: string,
      cron: string,
      func: string,
      ...args: any[],
  ): Promise<ResonateSchedule>

  Creates a recurring schedule that invokes a registered function on a cron interval.

  The schedule is persisted on the Resonate Server and triggers a new durable promise for each cron tick. The generated promise IDs include the schedule name and timestamp to ensure uniqueness across invocations.

  If a function reference is provided, it must already be registered via register. Alternatively, a function name (string) can be used for remote dispatch.

  Parameters

  • name: string

    A unique name identifying this schedule.

  • cron: string

    A cron expression defining the recurrence interval (e.g., "* * * * *" for every minute).

  • func: string
  • ...args: any[]

    Positional arguments and optional configuration parameters passed to the function.

  Returns Promise<ResonateSchedule>

  A ResonateSchedule handle with a delete() method to remove the schedule.

  Example

  const schedule = await resonate.schedule("daily-report", "0 0 * * *", generateReport);
  // Later, to remove:
  await schedule.delete();
  Copy

setDependency

• setDependency(name: string, obj: any): void

  Registers a named dependency that will be available to all Resonate functions via context.getDependency(name).

  Use this to inject services, clients, or configuration objects into Resonate functions without tight coupling.

  Parameters

  • name: string

    A unique key identifying the dependency.

  • obj: any

    The dependency value (any object or primitive).

  Returns void

stop

• stop(): Promise<void>

  Stops the Resonate client, releasing all resources.

  This shuts down the underlying network transport and message source, stops the heartbeat loop, and clears the subscription refresh interval. After calling stop(), the client should not be used for further operations.

  Returns Promise<void>