baconjs/types/buffer.d.ts

A small functional reactive programming lib for JavaScript.

import { EventStream } from "./observable";
import { End } from "./event";
import { EventSink } from "./types";
export declare type VoidFunction = () => void;
/**
 *  Delay function used by `bufferWithTime` and `bufferWithTimeOrCount`. Your implementation should
 *  call the given void function to cause a buffer flush.
 */
export declare type DelayFunction = (f: VoidFunction) => any;
/** @hidden */
export declare function bufferWithTime<V>(src: EventStream<V>, delay: number | DelayFunction): EventStream<V[]>;
/** @hidden */
export declare function bufferWithCount<V>(src: EventStream<V>, count: number): EventStream<V[]>;
/** @hidden */
export declare function bufferWithTimeOrCount<V>(src: EventStream<V>, delay?: number | DelayFunction, count?: number): EventStream<V[]>;
declare class Buffer<V> {
    constructor(onFlush: BufferHandler<V>, onInput: BufferHandler<V>);
    delay?: DelayFunction;
    onInput: BufferHandler<V>;
    onFlush: BufferHandler<V>;
    push: EventSink<V[]>;
    scheduled: number | null;
    end: End | undefined;
    values: V[];
    flush(): any;
    schedule(delay: DelayFunction): any;
}
declare type BufferHandler<V> = (buffer: Buffer<V>) => any;
/** @hidden */
export declare function buffer<V>(src: EventStream<V>, onInput?: BufferHandler<V>, onFlush?: BufferHandler<V>): EventStream<V[]>;
export {};