Class Resonate

constructor

• new Resonate(
      __namedParameters: { group: string; pid: string; ttl: number },
      network: Network,
  ): Resonate

  Parameters

  • __namedParameters: { group: string; pid: string; ttl: number }
  • network: Network

  Returns Resonate

Readonlypromises

Readonlyschedules

beginRpc

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

  Invoke a remote function and return a promise

  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>>

  Invoke a remote function and return a promise

  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>>

  Invoke a remote function and return a promise

  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>>>

  Invoke a function and return a promise

  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>>

  Invoke a function and return a promise

  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>>

  Invoke a function and return a promise

  Parameters

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

  Returns Promise<ResonateHandle<any>>

get

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

  Get a promise and return a value

  Type Parameters

  • T = any

  Parameters

  • id: string

  Returns Promise<ResonateHandle<T>>

options

• options(opts?: Partial<Options>): Options

  Parameters

  • opts: Partial<Options> = {}

  Returns Options

register

• register<F extends Func>(name: string, func: F): ResonateFunc<F>

  Register a function and returns a registered function

  Type Parameters

  • F extends Func

  Parameters

  • name: string
  • func: F

  Returns ResonateFunc<F>

• register<F extends Func>(func: F): ResonateFunc<F>

  Register a function and returns a registered function

  Type Parameters

  • F extends Func

  Parameters

  • func: F

  Returns ResonateFunc<F>

rpc

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

  Invoke a remote function and return a value

  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>

  Invoke a remote function and return a value

  Type Parameters

  • T

  Parameters

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

  Returns Promise<T>

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

  Invoke a remote function and return a value

  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>>

  Invoke a function and return a value

  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>

  Invoke a function and return a value

  Type Parameters

  • T

  Parameters

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

  Returns Promise<T>

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

  Invoke a function and return a value

  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>

  Type Parameters

  • F extends Func

  Parameters

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

  Returns Promise<ResonateSchedule>

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

  Parameters

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

  Returns Promise<ResonateSchedule>

setDependency

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

  Store a named dependency for use with Context. The dependency is made available to all functions via their execution Context. Setting a dependency for a name that already exists will overwrite the previously set dependency.

  Parameters

  • name: string
  • obj: any

  Returns void

stop

• stop(): void

  Returns void

Staticlocal

• local(): Resonate

  Create a local Resonate instance

  Returns Resonate

Staticremote

• remote(
      __namedParameters?: {
          group?: string;
          host?: string;
          messageSourcePort?: string;
          pid?: string;
          storePort?: string;
          ttl?: number;
      },
  ): Resonate

  Create a remote Resonate instance

  Parameters

  • __namedParameters: {
        group?: string;
        host?: string;
        messageSourcePort?: string;
        pid?: string;
        storePort?: string;
        ttl?: number;
    } = {}

  Returns Resonate