ixfx
    Preparing search index...

    Function asResponsive

    • asResponsive<T>(
          queue: IQueueMutableWithEvents<T>,
      ): {
          set: (data: T[]) => void;
          dispose(reason: string): void;
          isDisposed(): boolean;
          on(handler: (value: Passed<readonly T[]>) => void): Unsubscriber;
          onValue(handler: (value: readonly T[]) => void): Unsubscriber;
      }

      Changes to queue are output as a responsive stream. The stream emits the full data of the queue (first item being the head of the queue) whenever there is an enqueue, remove or clear operation.

      const queue = new QueueMutable();
      const r = asResponsive(queue);
      r.onValue(v => {
       // v is an array of values
      });


      Calling `set()` on the stream enqueues data to the wrapped queue.
      ```js
      r.set([ `1, `2` ]); // Enqueues 1, 2

      @param queue @returns

      Type Parameters

      • T

      Parameters

      Returns {
          set: (data: T[]) => void;
          dispose(reason: string): void;
          isDisposed(): boolean;
          on(handler: (value: Passed<readonly T[]>) => void): Unsubscriber;
          onValue(handler: (value: readonly T[]) => void): Unsubscriber;
      }

      • set: (data: T[]) => void
      • dispose:function
        • dispose(reason: string): void

          Disposes the reactive, providing a reason for debug tracing

          Parameters

          • reason: string

          Returns void

      • isDisposed:function
        • isDisposed(): boolean

          Returns true if Reactive is disposed

          Returns boolean

      • on:function
        • on(handler: (value: Passed<readonly T[]>) => void): Unsubscriber

          Subscribes to a reactive. Receives data as well as signals. Use onValue if you just care about values.

          Return result unsubscribes.

          const unsub = someReactive.on(msg => {
             // Do something with msg.value
          });

          unsub(); // Unsubscribe

          Parameters

          • handler: (value: Passed<readonly T[]>) => void

          Returns Unsubscriber

      • onValue:function
        • onValue(handler: (value: readonly T[]) => void): Unsubscriber

          Subscribes to a reactive's values. Returns a function that unsubscribes.

          Parameters

          • handler: (value: readonly T[]) => void

          Returns Unsubscriber

    Settings

    Member Visibility