Interface DebounceBehavior<T>

Debouncing requires at least one behavior that implements the DebounceBehavior.

See

debounce:function

interface DebounceBehavior<T> {
    init?(state): void | Readonly<{
        ms: number;
        queued: boolean;
        timer?: number;
    }>;
    postTimer?(state, chunk, controller): void | Readonly<{
        ms: number;
        queued: boolean;
        timer?: number;
    }>;
    preTimer?(state, chunk, controller): void | Readonly<{
        ms: number;
        queued: boolean;
        timer?: number;
    }>;
}

Type Parameters

  • T

Implemented by

Methods

init? postTimer? preTimer?

Methods

Optional init

  • init(state): void | Readonly<{
        ms: number;
        queued: boolean;
        timer?: number;
    }>

  • Called only once, when the debouncer is constructed.

    Parameters

    • state: Readonly<{
          ms: number;
          queued: boolean;
          timer?: number;
      }>

    Returns void | Readonly<{
        ms: number;
        queued: boolean;
        timer?: number;
    }>

Optional postTimer

  • postTimer(state, chunk, controller): void | Readonly<{
        ms: number;
        queued: boolean;
        timer?: number;
    }>

  • Called after timer has timed out.

    Parameters

    • state: Readonly<{
          ms: number;
          queued: boolean;
          timer?: number;
      }>
    • chunk: T
    • controller: TransformStreamDefaultController<T>

    Returns void | Readonly<{
        ms: number;
        queued: boolean;
        timer?: number;
    }>

Optional preTimer

  • preTimer(state, chunk, controller): void | Readonly<{
        ms: number;
        queued: boolean;
        timer?: number;
    }>

  • This is will be called once for every chunk received and before the timer has been set.

    Parameters

    • state: Readonly<{
          ms: number;
          queued: boolean;
          timer?: number;
      }>
    • chunk: T
    • controller: TransformStreamDefaultController<T>

    Returns void | Readonly<{
        ms: number;
        queued: boolean;
        timer?: number;
    }>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc