Merge pull request #13 from kefirjs/add-typings

Add types to kefir-test-utils

Author: mAAdhaTTah

.travis.yml

@@ -6,3 +6,4 @@ node_js:
   - 6
   - 8
   - 10
+  - 12

kefir-test-utils.d.ts

@@ -0,0 +1,41 @@
+import {Observable, Stream, Property, Event as KEvent, Pool} from 'kefir'
+import {Clock} from 'lolex'
+
+export type Event<V, E> = KEvent<V, E> & {
+  current?: boolean
+}
+
+export type Options = {current: boolean}
+
+export type Watcher<V, E> = {
+  log: Event<V, E>[]
+  unwatch(): void
+}
+
+export interface Helpers {
+  END: string
+  VALUE: string
+  ERROR: string
+  send<V, E>(stream$: Observable<V, E>, values: Event<V, E>[]): Observable<V, E>
+  value<V, E>(v: V, opts?: Options): Event<V, E>
+  error<V, E>(e: E, opts?: Options): Event<V, E>
+  end<V, E>(opts?: Options): Event<V, E>
+  activate<V, E>(obs: Observable<V, E>): typeof obs
+  deactivate<V, E>(obs: Observable<V, E>): typeof obs
+  prop<V, E>(): Property<V, E>
+  stream<V, E>(): Stream<V, E>
+  pool<V, E>(): Pool<V, E>
+  shakeTimers(clock: Clock): void
+  withFakeTime(cb: (tick: (x: number) => void, clock: Clock) => void, reverseSimultaneous?: boolean): void
+  logItem<V, E>(event: KEvent<V, E>, current: boolean): Event<V, E>
+  watch<V, E>(obs: Observable<V, E>): Watcher<V, E>
+  watchWithTime<V, E>(stream$: Observable<V, E>): Event<V, E>[]
+}
+
+export interface HelpersFactory {
+  (Kefir: typeof import('kefir').default): Helpers
+}
+
+declare const createHelpers: HelpersFactory
+
+export default createHelpers

kefir-test-utils.test-d.ts

@@ -0,0 +1,24 @@
+import {expectType} from 'tsd'
+import Kefir from 'kefir'
+import {Clock} from 'lolex'
+import createHelpers, {Event, Watcher} from '.'
+
+const {VALUE, ERROR, END, value, error, end, withFakeTime, logItem, watch, watchWithTime} = createHelpers(Kefir)
+
+expectType<string>(VALUE)
+expectType<string>(ERROR)
+expectType<string>(END)
+
+expectType<Event<string, any>>(value('hello'))
+expectType<Event<any, string>>(error('hello'))
+expectType<Event<any, any>>(end())
+
+expectType<void>(
+  withFakeTime((tick: (s: number) => void, clock: Clock) => {
+    tick(10)
+    clock.runToLast()
+  })
+)
+expectType<Event<string, number>>(logItem({type: 'value', value: 'hello'}, false))
+expectType<Watcher<string, number>>(watch(new Kefir.Stream<string, number>()))
+expectType<Event<string, number>[]>(watchWithTime(new Kefir.Stream<string, number>()))