Options
All
  • Public
  • Public/Protected
  • All
Menu

string-stream-utils — Reference

Index

Type aliases

Functions

Type aliases

MaybeAsyncIterable

MaybeAsyncIterable<Value>: Iterable<Value> | AsyncIterable<Value>

Type parameters

  • Value

Stream

Stream: MaybeAsyncIterable<string>

Functions

iterateCharacters

  • iterateCharacters(stream: Stream): AsyncGenerator<string, void, undefined>

  • Parameters

    Returns AsyncGenerator<string, void, undefined>

Const iterateLines

  • iterateLines(stream: Stream): AsyncGenerator<string, void, unknown>

  • Parameters

    Returns AsyncGenerator<string, void, unknown>

splitCharacterIterable

  • splitCharacterIterable(chars: MaybeAsyncIterable<string>, sepChar: string): AsyncGenerator<string, void, unknown>

Const splitStream

  • splitStream(stream: Stream, sepChar: string): AsyncGenerator<string, void, unknown>

  • Parameters

    • stream: Stream
    • sepChar: string

    Returns AsyncGenerator<string, void, unknown>

trimmedChunks

  • trimmedChunks(stream: Stream): AsyncGenerator<string, void, unknown>

  • Parameters

    Returns AsyncGenerator<string, void, unknown>

Generated using TypeDoc