Options
All
  • Public
  • Public/Protected
  • All
Menu

split-shell-buffer — Reference

Index

Type aliases

Code

Code: number

Data

Data: AsyncIterable<Code> | Iterable<Code>

Func

Func<Return, Args>: (...args: Args) => Return

Type parameters

  • Return

  • Args: any[]

Type declaration

    • (...args: Args): Return
    • Parameters

      • Rest ...args: Args

      Returns Return

IterableStream

IterableStream: AsyncIterable<Buffer | string>

MaybeFunc

MaybeFunc<Return, Args>: Return | Func<Return, Args>

Type parameters

  • Return

  • Args: any[]

Sequence

Sequence: ArrayLike<Code>

Variables

End

EndOfLine

EndOfLine: SpecialCharacter

Const RESET

RESET: (SpecialCharacter | Digit)[] = [Start, StartFollow, Zero, End]

Seperator

Seperator: SpecialCharacter

Start

StartFollow

StartFollow: SpecialCharacter

Const ZERO_AND_SEP

ZERO_AND_SEP: Set<SpecialCharacter | Digit> = new Set([Zero, Seperator])

Zero

Zero: Digit

Const arrayEqual

arrayEqual: any = createArrayEqual<types.Sequence>()

Const symData

symData: unique symbol = Symbol('symData')

Const symEncoding

symEncoding: unique symbol = Symbol('symEncoding')

Functions

create

fromChildProcess

Const fromEventedStream

  • fromEventedStream<Chunk>(stream: types.EventedStream<Chunk>): SplitterObject

Const fromIterable

fromIterableStream

Const fromString

Const isResetSequence

  • isResetSequence(sequence: Iterable<types.Code>): boolean

iterateElements

lines

  • lines(splitter: Splitter): AsyncIterableIterator<types.Sequence>

simpleFlatten

  • simpleFlatten<Element>(container: Iterable<Iterable<Element>>): Generator<Element, void, undefined>

write

writeln

Generated using TypeDoc