@johngw/stream
Version:
Reactive programming tools using the WHATWG Streams API.
20 lines (19 loc) • 609 B
text/typescript
import { CachableStream } from '@johngw/stream/sources/CachableStream';
import { StorageCache } from '@johngw/stream/storages/StorageCache';
/**
* Wraps a `ReadableStream` in a `CachableStream`.
*
* @group Sources
* @example
* ```
* const controller = new ControllableStream<number>()
*
* cacheStream(
* new StorageCache(new MemoryCache(), 'my-cache', 30 * 60_000)),
* ['a', 'cache', 'path']
* controller,
* )
* .pipeTo(write(console.info))
* ```
*/
export declare function cacheStream<T>(cache: StorageCache, path: string[], stream: ReadableStream<T>, ms?: number): CachableStream<T>;