index.js.flow

// @flow

declare type SeedValue<S, V> = { seed: S, value: V };
declare type TimeValue<V> = { time: number, value: V };

declare type CreateGenerator<A> = (...args: Array<any>) => Generator<A|Promise<A>, any, any>;

export type Sink<A> = {
  event(time: number, value: A): void;
  // end value parameter is deprecated
  end(time: number, value?: A): void;
  error(time: number, err: Error): void;
}

export type Task = {
  run(time: number): void;
  error(time: number, e: Error): void;
  dispose(): void;
}

export type ScheduledTask = {
  task: Task;
  run(): void;
  error(err: Error): void;
  dispose(): void;
}

export type Scheduler = {
  now(): number;
  asap(task: Task): ScheduledTask;
  delay(delay: number, task: Task): ScheduledTask;
  periodic(period: number, task: Task): ScheduledTask;
  schedule(delay: number, period: number, task: Task): ScheduledTask;
  cancel(task: Task): void;
  cancelAll(predicate: (task: Task) => boolean): void;
}

export type Disposable<A> = {
  dispose(): void | Promise<A>;
}

export type Source<A> = {
  run (sink: Sink<A>, scheduler: Scheduler): Disposable<A>;
}

export type Observable<A> = {
  subscribe(subscriber: Subscriber<A>): Subscription<A>;
}

export type Subscriber<A> = {
  +next?: (value: A) => void;
  +error?: (err: Error) => void;
  // complete value parameter is deprecated
  +complete?: (value?: A) => void;
}

export type Subscription<A> = {
  unsubscribe(): void;
}

declare export class Stream<A> {
  constructor(source: Source<A>): Stream<A>;
  source: Source<A>;
  run (sink: Sink<A>, scheduler: Scheduler): Disposable<A>;
  reduce<B>(f: (b: B, a: A) => B, b: B): Promise<B>;
  observe(f: (a: A) => any): Promise<any>;
  forEach(f: (a: A) => any): Promise<any>;
  drain(): Promise<any>;
  subscribe(subscriber: Subscriber<A>): Subscription<A>;

  constant<B>(b: B): Stream<B>;
  map<B>(f: (a: A) => B): Stream<B>;
  tap(f: (a: A) => any): Stream<A>;
  chain<B>(f: (a: A) => Stream<B>): Stream<B>;
  flatMap<B>(f: (a: A) => Stream<B>): Stream<B>;

  ap<B, C>(fs: Stream<(a: A) => B>): Stream<C>;

  continueWith(f: (a: any) => Stream<A>): Stream<A>;
  concatMap<B>(f: (a: A) => Stream<B>): Stream<B>;
  mergeConcurrently<B>(concurrency: number): Stream<B>;
  merge(...ss: Array<Stream<A>>): Stream<A>;
  mergeArray(streams: Array<Stream<A>>): Stream<A>;

  combine<B, R>(
    fn: (a: A, b: B) => R,
    b: Stream<B>
  ): Stream<R>;
  combine<B, C, R>(
    fn: (a: A, b: B, c: C) => R,
    b: Stream<B>,
    c: Stream<C>
  ): Stream<R>;
  combine<B, C, D, R>(
    fn: (a: A, b: B, c: C, d: D) => R,
    b: Stream<B>,
    c: Stream<C>,
    d: Stream<D>
  ): Stream<R>;
  combine<B, C, D, E, R>(
    fn: (a: A, b: B, c: C, d: D, e: E) => R,
    b: Stream<B>,
    c: Stream<C>,
    d: Stream<D>,
    e: Stream<E>
  ): Stream<R>;

  combineArray<B, R>(
    fn: (a: A, b: B) => R,
    streams: [Stream<B>]
  ): Stream<R>;
  combineArray<B, C, R>(
    fn: (a: A, b: B, c: C) => R,
    streams: [Stream<B>, Stream<C>]
  ): Stream<R>;
  combineArray<B, C, D, R>(
    fn: (a: A, b: B, c: C, d: D) => R,
    streams: [Stream<B>, Stream<C>, Stream<D>]
  ): Stream<R>;
  combineArray<B, C, D, E, R>(
    fn: (a: A, b: B, c: C, d: D, e: E) => R,
    streams: [Stream<B>, Stream<C>, Stream<D>, Stream<E>]
  ): Stream<R>;
  combineArray<V, R>(
    fn: (a: A, ...rest: V[]) => R,
    streams: Stream<V>[]
  ): Stream<R>;

  scan<B>(f: (b: B, a: A) => B, b: B): Stream<B>;
  loop<S, B>(f: (seed: S, a: A) => SeedValue<S, B>, seed: S): Stream<B>;

  concat(s2: Stream<A>): Stream<A>;
  startWith(a: A): Stream<A>;

  filter(p: (a: A) => boolean): Stream<A>;
  skipRepeats(): Stream<A>;
  skipRepeatsWith(eq: (a1: A, a2: A) => boolean): Stream<A>;

  take(n: number): Stream<A>;
  skip(n: number): Stream<A>;
  takeWhile(p: (a: A) => boolean): Stream<A>;
  skipWhile(p: (a: A) => boolean): Stream<A>;
  skipAfter(p: (a: A) => boolean): Stream<A>;
  slice(start: number, end: number): Stream<A>;

  until(signal: Stream<any>): Stream<A>;
  takeUntil(signal: Stream<any>): Stream<A>;
  since(signal: Stream<any>): Stream<A>;
  skipUntil(signal: Stream<any>): Stream<A>;
  during(timeWindow: Stream<Stream<any>>): Stream<A>;
  throttle(period: number): Stream<A>;
  debounce(period: number): Stream<A>;

  timestamp(): Stream<TimeValue<A>>;
  delay(dt: number): Stream<A>;

  sample<B, C, R>(
    fn: (b: B, c: C) => R,
    b: Stream<B>,
    c: Stream<C>
  ): Stream<R>;
  sample<B, C, D, R>(
    fn: (b: B, c: C, d: D) => R,
    b: Stream<B>,
    c: Stream<C>,
    d: Stream<D>
  ): Stream<R>;
  sample<B, C, D, E, R>(
    fn: (b: B, c: C, d: D, e: E) => R,
    b: Stream<B>,
    c: Stream<C>,
    d: Stream<D>,
    e: Stream<E>
  ): Stream<R>;

  sampleWith(sampler: Stream<any>): Stream<A>;

  zip<B, R>(
    fn: (a: A, b: B) => R,
    b: Stream<B>
  ): Stream<R>;
  zip<B, C, R>(
    fn: (a: A, b: B, c: C) => R,
    b: Stream<B>,
    c: Stream<C>
  ): Stream<R>;
  zip<B, C, D, R>(
    fn: (a: A, b: B, c: C, d: D) => R,
    b: Stream<B>,
    c: Stream<C>,
    d: Stream<D>
  ): Stream<R>;
  zip<B, C, D, E, R>(
    fn: (a: A, b: B, c: C, d: D, e: E) => R,
    b: Stream<B>,
    c: Stream<C>,
    d: Stream<D>,
    e: Stream<E>
  ): Stream<R>;

  recoverWith<B, C>(p: (a: B) => Stream<C>): Stream<A | C>;
  multicast(): Stream<A>;

  thru<B>(transform: (stream: Stream<A>) => B): B;
}

declare export function just<A>(a: A): Stream<A>;
declare export function of<A>(a: A): Stream<A>;
declare export function empty(): Stream<any>;
declare export function never(): Stream<any>;
declare export function from<A>(as: A[] | Iterable<A> | Observable<A>): Stream<A>;
declare export function periodic<A>(period: number, a?: A): Stream<A>;
declare export function fromEvent<T: Event>(event: string, target: any, useCapture?: boolean): Stream<T>;
declare export function fromEvent<T>(event: string, target: any): Stream<T>;

declare export function unfold<A, B, S>(f: (seed: S) => SeedValue<S, B|Promise<B>>, seed: S): Stream<B>;
declare export function iterate<A>(f: (a: A) => A|Promise<A>, a: A): Stream<A>;
declare export function generate<A>(g: CreateGenerator<A>, ...args: Array<any>): Stream<A>;

declare export function reduce<A, B>(f: (b: B, a: A) => B, b: B, s: Stream<A>): Promise<B>;
declare export function observe<A>(f: (a: A) => any, s: Stream<A>): Promise<any>;
declare export function forEach<A>(f: (a: A) => any, s: Stream<A>): Promise<any>;
declare export function drain<A>(s: Stream<A>): Promise<any>;

declare export function subscribe<A>(subscriber: Subscriber<A>, s: Stream<A>): Subscription<A>;

declare export function constant<A, B>(b: B, s: Stream<A>): Stream<B>;
declare export function map<A, B>(f: (a: A) => B, s: Stream<A>): Stream<B>;
declare export function tap<A>(f: (a: A) => any, s: Stream<A>): Stream<A>;
declare export function ap<A, B>(fs: Stream<(a: A) => B>, as: Stream<A> ): Stream<B>;
declare export function chain<A, B>(f: (a: A) => Stream<B>, s: Stream<A>): Stream<B>;
declare export function flatMap<A, B>(f: (a: A) => Stream<B>, s: Stream<A>): Stream<B>;
declare export function join<A>(s: Stream<Stream<A>>): Stream<A>;
declare export function switchLatest<A>(s: Stream<Stream<A>>): Stream<A>;

declare export function continueWith<A>(f: (a: any) => Stream<A>, s: Stream<A>): Stream<A>;
declare export function concatMap<A, B>(f: (a: A) => Stream<B>, s: Stream<A>): Stream<B>;
declare export function mergeConcurrently<A>(concurrency: number, s: Stream<Stream<A>>): Stream<A>;

declare export function merge<A>(...ss: Array<Stream<A>>): Stream<A>;
declare export function mergeArray<A>(streams: Array<Stream<A>>): Stream<A>;

declare export function combine<A, B, R>(
  fn: (a: A, b: B) => R,
  a: Stream<A>,
  b: Stream<B>
): Stream<R>;
declare export function combine<A, B, C, R>(
  fn: (a: A, b: B, c: C) => R,
  a: Stream<A>,
  b: Stream<B>,
  c: Stream<C>
): Stream<R>;
declare export function combine<A, B, C, D, R>(
  fn: (a: A, b: B, c: C, d: D) => R,
  a: Stream<A>,
  b: Stream<B>,
  c: Stream<C>,
  d: Stream<D>
): Stream<R>;
declare export function combine<A, B, C, D, E, R>(
  fn: (a: A, b: B, c: C, d: D, e: E) => R,
  a: Stream<A>,
  b: Stream<B>,
  c: Stream<C>,
  d: Stream<D>,
  e: Stream<E>
): Stream<R>;

declare export function combineArray<A, B, R>(
  fn: (a: A, b: B) => R,
  streams: [Stream<A>, Stream<B>]
): Stream<R>;
declare export function combineArray<A, B, C, R>(
  fn: (a: A, b: B, c: C) => R,
  streams: [Stream<A>, Stream<B>, Stream<C>]
): Stream<R>;
declare export function combineArray<A, B, C, D, R>(
  fn: (a: A, b: B, c: C, d: D) => R,
  streams: [Stream<A>, Stream<B>, Stream<C>, Stream<D>]
): Stream<R>;
declare export function combineArray<A, B, C, D, E, R>(
  fn: (a: A, b: B, c: C, d: D, e: E) => R,
  streams: [Stream<A>, Stream<B>, Stream<C>, Stream<D>, Stream<E>]
): Stream<R>;
declare export function combineArray<V, R> (
  fn: (...items: V[]) => R,
  items: Stream<V>[]
): Stream<R>;

declare export function scan<A, B>(f: (b: B, a: A) => B, b: B, s: Stream<A>): Stream<B>;
declare export function loop<A, B, S>(f: (seed: S, a: A) => SeedValue<S, B>, seed: S, s: Stream<A>): Stream<B>;

declare export function concat<A>(s1: Stream<A>, s2: Stream<A>): Stream<A>;
declare export function startWith<A>(a: A, s: Stream<A>): Stream<A>;

declare export function filter<A>(p: (a: A) => boolean, s: Stream<A>): Stream<A>;
declare export function skipRepeats<A>(s: Stream<A>): Stream<A>;
declare export function skipRepeatsWith<A>(eq: (a1: A, a2: A) => boolean, s: Stream<A>): Stream<A>;

declare export function take<A>(n: number, s: Stream<A>): Stream<A>;
declare export function skip<A>(n: number, s: Stream<A>): Stream<A>;
declare export function takeWhile<A>(p: (a:  A) => boolean, s: Stream<A>): Stream<A>;
declare export function skipWhile<A>(p: (a: A) => boolean, s: Stream<A>): Stream<A>;
declare export function skipAfter<A>(p: (a: A) => boolean, s: Stream<A>): Stream<A>;
declare export function slice<A>(start: number, end: number, s: Stream<A>): Stream<A>;

declare export function until<A>(signal: Stream<any>, s: Stream<A>): Stream<A>;
declare export function takeUntil<A>(signal: Stream<any>, s: Stream<A>): Stream<A>;
declare export function since<A>(signal: Stream<any>, s: Stream<A>): Stream<A>;
declare export function skipUntil<A>(signal: Stream<any>, s: Stream<A>): Stream<A>;
declare export function during<A>(timeWindow: Stream<Stream<any>>, s: Stream<A>): Stream<A>;
declare export function throttle<A>(period: number, s: Stream<A>): Stream<A>;
declare export function debounce<A>(period: number, s: Stream<A>): Stream<A>;

declare export function timestamp<A>(s: Stream<A>): Stream<TimeValue<A>>;
declare export function delay<A>(dt: number, s: Stream<A>): Stream<A>;

declare export function fromPromise<A>(p: Promise<A>): Stream<A>;
declare export function await<A>(s: Stream<Promise<A>>): Stream<A>;
declare export function awaitPromises<A>(s: Stream<Promise<A>>): Stream<A>;

declare export function sample<A, B, R>(
  fn: (a: A, b: B) => R,
  sampler: Stream<any>,
  a: Stream<A>,
  b: Stream<B>
): Stream<R>;
declare export function sample<A, B, C, R>(
  fn: (a: A, b: B, c: C) => R,
  sampler: Stream<any>,
  a: Stream<A>,
  b: Stream<B>,
  c: Stream<C>
): Stream<R>;
declare export function sample<A, B, C, D, R>(
  fn: (a: A, b: B, c: C, d: D) => R,
  sampler: Stream<any>,
  a: Stream<A>,
  b: Stream<B>,
  c: Stream<C>,
  d: Stream<D>
): Stream<R>;
declare export function sample<A, B, C, D, E, R>(
  fn: (a: A, b: B, c: C, d: D, e: E) => R,
  sampler: Stream<any>,
  a: Stream<A>,
  b: Stream<B>,
  c: Stream<C>,
  d: Stream<D>,
  e: Stream<E>
): Stream<R>;

declare export function sampleWith<A>(sampler: Stream<any>, s: Stream<A>): Stream<A>;

declare export function zip<A, B, R>(
  fn: (a: A, b: B) => R,
  a: Stream<A>,
  b: Stream<B>
): Stream<R>;
declare export function zip<A, B, C, R>(
  fn: (a: A, b: B, c: C) => R,
  a: Stream<A>,
  b: Stream<B>,
  c: Stream<C>
): Stream<R>;
declare export function zip<A, B, C, D, R>(
  fn: (a: A, b: B, c: C, d: D) => R,
  a: Stream<A>,
  b: Stream<B>,
  c: Stream<C>,
  d: Stream<D>
): Stream<R>;
declare export function zip<A, B, C, D, E, R>(
  fn: (a: A, b: B, c: C, d: D, e: E) => R,
  a: Stream<A>,
  b: Stream<B>,
  c: Stream<C>,
  d: Stream<D>,
  e: Stream<E>
): Stream<R>;

declare export function recoverWith<A, B, C>(p: (a: B) => Stream<C>, s: Stream<A>): Stream<A | C>;
declare export function throwError(e: Error): Stream<any>;

declare export function multicast<A>(s: Stream<A>): Stream<A>;

declare export var defaultScheduler: Scheduler;

declare export class PropagateTask<T> {
  static event <T> (value: T, sink: Sink<T>): PropagateTask<T>;
  static error (error: Error, sink: Sink<any>): PropagateTask<any>;
  // end value parameter is deprecated
  static end <T> (value: T, sink: Sink<T>): PropagateTask<T>;

  constructor (run: (time: number, value: T, sink: Sink<T>) => any, value: T, sink: Sink<T>): PropagateTask<T>;
  run(time: number): void;
  error(time: number, e: Error): void;
  dispose(): void;
}