Documentation
    Preparing search index...

    Class CachableStream<T>

    An extension to the ReadableStream that queues items only when a timed cache becomes invalid.

    Caching for 30 minutes.

    const cache = new StorageCache(
    localStorage,
    'my-cache',
    30 * 60_000
    )

    let i = 0
    const stream = new CachableStream<number>(
    cache,
    ['numbers'],
    () => ++i
    )

    stream.pipeTo(write(console.info))
    // 1

    await setTimeout(30 * 60_000))
    // 2

    Manually clearing cache.

    const cache = new StorageCache(
    localStorage,
    'my-cache',
    30 * 60_000
    )

    let i = 0
    const stream = new CachableStream<number>(
    cache,
    ['numbers'],
    () => ++i
    )

    stream.pipeTo(write(console.info))
    // 1

    stream.clear()
    // 2

    Type Parameters

    • T

    Hierarchy

    • ReadableStream<T>
      • CachableStream

    Implements

    Index

    Constructors

    Properties

    locked: boolean

    Accessors

    Methods

    • Parameters

      • Optionaloptions: ReadableStreamIteratorOptions

      Returns ReadableStreamAsyncIterator<T>

    • Parameters

      • Optionalreason: any

      Returns Promise<void>

    • Parameters

      • options: { mode: "byob" }

      Returns ReadableStreamBYOBReader

    • Returns ReadableStreamDefaultReader<T>

    • Parameters

      • Optionaloptions: ReadableStreamGetReaderOptions

      Returns ReadableStreamReader<T>

    • Type Parameters

      • T

      Parameters

      • transform: ReadableWritablePair<T, T>
      • Optionaloptions: StreamPipeOptions

      Returns ReadableStream<T>

    • Parameters

      • destination: WritableStream<T>
      • Optionaloptions: StreamPipeOptions

      Returns Promise<void>

    • Returns [ReadableStream<T>, ReadableStream<T>]

    • Parameters

      • Optionaloptions: ReadableStreamIteratorOptions

      Returns ReadableStreamAsyncIterator<T>

    • Type Parameters

      • R = any

      Parameters

      • iterable: Iterable<R, any, any> | AsyncIterable<R, any, any>

      Returns ReadableStream<R>