Class Resonate

constructor

• new Resonate(__namedParameters?): Resonate

• Parameters

  • __namedParameters: Partial<ResonateOptions> = {}

  Returns Resonate

Readonly defaultInvocationOptions

Readonly logger

Readonly promises

Readonly schedules

Readonly store

locksStore

• get locksStore(): ILockStore

• Returns ILockStore

promisesStore

• get promisesStore(): IPromiseStore

• Returns IPromiseStore

getResource

• getResource<R>(name): undefined | R

• Retrieves a resource by name from the Resonate instance.

  Type Parameters

  • R

    The expected type of the resource.

  Parameters

  • name: string

    The unique string identifier of the resource to retrieve.

  Returns undefined | R

  The resource of type R if found, or undefined if not found.

  Remarks

  The method uses type assertion to cast the resource to type R. Ensure that the type parameter R matches the actual type of the stored resource to avoid runtime type errors.

invokeLocal

• invokeLocal<R>(name, id, ...argsWithOverrides): Promise<InvocationHandle<R>>

• Type Parameters

  • R

  Parameters

  • name: string
  • id: string
  • Rest ...argsWithOverrides: any[]

  Returns Promise<InvocationHandle<R>>

options

• options(opts): PartialOptions

• Parameters

  • opts: Partial<Options>

  Returns PartialOptions

register

• register(name, func, opts?): void

• Parameters

  • name: string
  • func: Func
  • opts: Partial<Options> = {}

  Returns void

registerModule

• registerModule(module, opts?): void

• Parameters

  • module: Record<string, Func>
  • opts: Partial<Options> = {}

  Returns void

registeredFunction

• registeredFunction(funcName, version): {
      func: Func;
      opts: Options;
  }

• Parameters

  • funcName: string
  • version: number

  Returns {
      func: Func;
      opts: Options;
  }

  • func: Func

  • opts: Options

run

• run<R>(name, id, ...argsWithOverrides): Promise<R>

• Type Parameters

  • R

  Parameters

  • name: string
  • id: string
  • Rest ...argsWithOverrides: any[]

  Returns Promise<R>

schedule

• schedule<F>(name, cron, func, ...args): Promise<Schedule>

• Schedule a resonate function.

  Type Parameters

  • F extends Func

  Parameters

  • name: string

    The schedule name.
  • cron: string

    The schedule cron expression.
  • func: F

    The function to schedule.
  • Rest ...args: [...Params<F>[], PartialOptions?]

    The function arguments.

  Returns Promise<Schedule>

  The schedule object.
• schedule(name, cron, func, ...args): Promise<Schedule>

• Schedule a resonate function that is already registered.

  Parameters

  • name: string

    The schedule name.
  • cron: string

    The schedule cron expression.
  • func: string

    The registered function name.
  • Rest ...args: any[]

    The function arguments.

  Returns Promise<Schedule>

  The schedule object.

setResource

• setResource(name, resource): void

• Sets a global named resource for the Resonate instace. This resource will be available in all the children Contexts of the current top level execution.

  Caller is responsible of the life cycle of the resource.

  Parameters

  • name: string

    A unique string identifier for the resource.
  • resource: any

    The resource to be stored. Can be of any type.

  Returns void

  Throws

  Throws an error if a resource with the same name already exists in the current Resonate instace.

start

• start(delay?): Promise<void>

• Start the resonate service which continually checks for pending promises every delay ms.

  Parameters

  • delay: number = 5000

    Frequency in ms to check for pending promises.

  Returns Promise<void>

stop

• stop(): Promise<void>

• Stop the resonate service.

  Returns Promise<void>

withDefaultOpts

• withDefaultOpts(givenOpts?): Options

• Parameters

  • givenOpts: Partial<Options> = {}

  Returns Options