Interface Stream

Index

Properties

Methods

Properties

public MODE_APPEND: number

public MODE_READ: number

public MODE_WRITE: number

Methods

public createStream(params: CreateStreamArgs): IOStream

Parameters

Returns

IOStream

public pump(inputStream: IOStream, handler: (...args: any[]) => any, maxChunkSize: number, isAsync?: boolean)

Parameters

  • inputStream: IOStream
  • handler: (...args: any[]) => any
  • maxChunkSize: number
  • isAsync?: boolean optional

public read(sourceStream: IOStream, buffer: Buffer, offset?: number, length?: number, resultsCallback?: (...args: any[]) => any)

Parameters

  • sourceStream: IOStream
  • buffer: Buffer
  • offset?: number optional
  • length?: number optional
  • resultsCallback?: (...args: any[]) => any optional

public readAll(sourceStream: IOStream, buffer?: Buffer, resultsCallback?: (...args: any[]) => any): any

Parameters

  • sourceStream: IOStream
  • buffer?: Buffer optional
  • resultsCallback?: (...args: any[]) => any optional

Returns

any

public write(outputStream: IOStream, buffer: Buffer, offset?: number, length?: number, resultsCallback?: (...args: any[]) => any)

Parameters

  • outputStream: IOStream
  • buffer: Buffer
  • offset?: number optional
  • length?: number optional
  • resultsCallback?: (...args: any[]) => any optional

public writeStream(inputStream: IOStream, outputStream: IOStream, maxChunkSize: number, resultsCallback?: (...args: any[]) => any)

Parameters

  • inputStream: IOStream
  • outputStream: IOStream
  • maxChunkSize: number
  • resultsCallback?: (...args: any[]) => any optional