Function expectTimeline

expectTimeline<T>(timelineString, testExcpectation, queuingStrategy?): WritableStream<T>
Calls an expectation function to compare a timeline against chunks.
Type Parameters
- T extends unknown
Parameters
- timelineString: string
- testExcpectation: ((timelineValue, chunk, timeline) => void | Promise<void>)
  - - (timelineValue, chunk, timeline): void | Promise<void>
    - Parameters
      timelineValue: T
      chunk: unknown
      timeline: Timeline<(typeof TimelineItemBoolean | typeof TimelineItemClose | typeof TimelineItemError | typeof TimelineItemNeverReach | typeof TimelineItemNull | typeof TimelineItemTimer | typeof TimelineItemDefault | typeof TimelineItemDash | typeof TimelineItemInstance)[]>
      Returns void | Promise<void>
- Optional queuingStrategy: QueuingStrategy<T>
Returns WritableStream<T>
See
- timeline docs
- fromTimeline:function
Example
```
fromTimeline(`
  --1--2--3--4--
`)
  .pipeTo(expectTimeline(
    `
  --1--2--3--4--
    `,
    (expectation, chunk) =>
      expect(chunk).toBe(expectation)
  ))
```
- Defined in packages/stream-test/src/expectTimeline.ts:41