Class BufferStream

Hierarchy

Index

Variables

Interfaces

Constructor methods

Properties

Methods

Variables

fn: { warn: boolean; }

public fn.warn: boolean

Interfaces

Opts: Opts

optional public blocking?: boolean

optional public disabled?: boolean

optional public encoding?: string

optional public size?: any

optional public split?: any

Constructor methods

constructor(options?: Opts): BufferStream

Parameters

  • options?: Opts optional

Returns

BufferStream

Properties

public buffer: Buffer

public length: number

public readable: boolean

public writable: boolean

Methods

public _read(size: number)

Parameters

  • size: number

public _write(data: Buffer, encoding: string, callback: Function)

Parameters

  • data: Buffer
  • encoding: string
  • callback: Function

public _write(data: string, encoding: string, callback: Function)

Parameters

  • data: string
  • encoding: string
  • callback: Function

public addListener(event: string, listener: Function): EventEmitter

Parameters

  • event: string
  • listener: Function

Returns

EventEmitter

public disable()

public disable(token: string, tokens?: Array<string>)

Parameters

  • token: string
  • tokens?: Array<string> optional

public disable(tokens: Array<string>)

Parameters

  • tokens: Array<string>

public disable(token: Buffer, tokens?: Buffer[])

Parameters

public disable(tokens: Buffer[])

Parameters

public emit(event: string, args?: Array<any>): boolean

Parameters

  • event: string
  • args?: Array<any> optional

Returns

boolean

public enable()

public end()

public end(buffer: Buffer, cb?: Function)

Parameters

  • buffer: Buffer
  • cb?: Function optional

public end(str: string, cb?: Function)

Parameters

  • str: string
  • cb?: Function optional

public end(str: string, encoding?: string, cb?: Function)

Parameters

  • str: string
  • encoding?: string optional
  • cb?: Function optional

public getBuffer(): Buffer

Returns

Buffer

public listeners(event: string): Array<Function>

Parameters

  • event: string

Returns

Array<Function>

public on(event: string, listener: Function): EventEmitter

Parameters

  • event: string
  • listener: Function

Returns

EventEmitter

public once(event: string, listener: Function): EventEmitter

Parameters

  • event: string
  • listener: Function

Returns

EventEmitter

public pause()

public pipe(destination: T, options?: { end?: boolean; }): T

Parameters

  • destination: T
  • options?: { end?: boolean; } optional

Returns

T

public push(chunk: any, encoding?: string): boolean

Parameters

  • chunk: any
  • encoding?: string optional

Returns

boolean

public read(size?: number): any

Parameters

  • size?: number optional

Returns

any

public removeAllListeners(event?: string): EventEmitter

Parameters

  • event?: string optional

Returns

EventEmitter

public removeListener(event: string, listener: Function): EventEmitter

Parameters

  • event: string
  • listener: Function

Returns

EventEmitter

public resume()

public setEncoding(encoding: string)

Parameters

  • encoding: string

public setMaxListeners(n: number)

Parameters

  • n: number

public setSize(size: string)

Parameters

  • size: string

public setSize(size: number)

Parameters

  • size: number

public split(token: string, tokens?: Array<string>)

Parameters

  • token: string
  • tokens?: Array<string> optional

public split(tokens: Array<string>)

Parameters

  • tokens: Array<string>

public split(token: Buffer, tokens?: Buffer[])

Parameters

public split(tokens: Buffer[])

Parameters

public toString(): string

Returns

string

public unpipe(destination?: T)

Parameters

  • destination?: T optional

public unshift(chunk: string)

Parameters

  • chunk: string

public unshift(chunk: Buffer)

Parameters

public wrap(oldStream: ReadableStream): ReadableStream

Parameters

Returns

ReadableStream

public write(buffer: Buffer, cb?: Function): boolean

Parameters

  • buffer: Buffer
  • cb?: Function optional

Returns

boolean

public write(str: string, cb?: Function): boolean

Parameters

  • str: string
  • cb?: Function optional

Returns

boolean

public write(str: string, encoding?: string, cb?: Function): boolean

Parameters

  • str: string
  • encoding?: string optional
  • cb?: Function optional

Returns

boolean