Class Scanner<TResult>

constructor

• new Scanner<TResult>(params: Params<TResult, any>): Scanner<TResult>

  Type Parameters

  • TResult

    Scanner is resolved with value of this type

  Parameters

  • params: Params<TResult, any>

  Returns Scanner<TResult>

Readonly[toStringTag]

then

• then<TResult1 = TResult, TResult2 = never>(
      onfulfilled?: (value: TResult) => TResult1 | PromiseLike<TResult1>,
      onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
  ): Promise<TResult1 | TResult2>

  Attaches callbacks for the resolution and/or rejection of the Promise.

  Type Parameters

  • TResult1 = TResult
  • TResult2 = never

  Parameters

  • Optionalonfulfilled: (value: TResult) => TResult1 | PromiseLike<TResult1>

    The callback to execute when the Promise is resolved.

  • Optionalonrejected: (reason: any) => TResult2 | PromiseLike<TResult2>

    The callback to execute when the Promise is rejected.

  Returns Promise<TResult1 | TResult2>

  A Promise for the completion of which ever callback is executed.

catch

• catch<TResult1 = never>(
      onrejected?: (reason: any) => TResult1 | PromiseLike<TResult1>,
  ): Promise<TResult1>

  Attaches a callback for only the rejection of the Promise.

  Type Parameters

  • TResult1 = never

  Parameters

  • Optionalonrejected: (reason: any) => TResult1 | PromiseLike<TResult1>

    The callback to execute when the Promise is rejected.

  Returns Promise<TResult1>

  A Promise for the completion of the callback.

finally

• finally(onfinally?: () => void): Promise<TResult>

  Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

  Parameters

  • Optionalonfinally: () => void

    The callback to execute when the Promise is settled (fulfilled or rejected).

  Returns Promise<TResult>

  A Promise for the completion of the callback.

cancel

• cancel(reason?: string | Error): boolean

  Parameters

  • Optionalreason: string | Error

  Returns boolean

scan

• scan<TEventMap extends object>(
      scannable: Scannable<TEventMap>,
      listenable: Listenable<keyof TEventMap>,
      options?: SubscribeOptions,
  ): this

  scan listenable and resolve based on this.evaluator

  Type Parameters

  • TEventMap extends object

  Parameters

  • scannable: Scannable<TEventMap>
  • listenable: Listenable<keyof TEventMap>
  • Optionaloptions: SubscribeOptions

  Returns this