Class Streamer

Hierarchy

Streamer
- FileStreamer
- NetworkStreamer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Streamer(src: any, params?: StreamerParams): Streamer

- Defined in src/streamer/streamer.ts:30
Parameters
- src: any
- Default value params: StreamerParams = {}
Returns Streamer

Properties

Protected __partialLine

__partialLine: string = ""

Protected __pointer

__pointer: number = 0

binary

binary: boolean

chunkSize

chunkSize: number = 1024 * 1024 * 10

compressed

compressed: string | false

data

data: any

json

json: boolean

newline

newline: string = ""

src

src: any

xml

xml: boolean

Methods

Protected _chunk

_chunk(start: number, end: number): any

- Defined in src/streamer/streamer.ts:64
Parameters
- start: number
- end: number
Returns any

Protected Abstract _read

_read(): Promise<any>

- Defined in src/streamer/streamer.ts:62
Returns Promise<any>

asText

asText(): any

- Defined in src/streamer/streamer.ts:108
Returns any

chunk

chunk(start: number): any

- Defined in src/streamer/streamer.ts:78
Parameters
- start: number
Returns any

chunkCount

chunkCount(): number

- Defined in src/streamer/streamer.ts:104
Returns number

chunkToLines

chunkToLines(chunk: string | Uint8Array, partialLine: string, isLast: boolean): object

- Defined in src/streamer/streamer.ts:112
Parameters
- chunk: string | Uint8Array
- partialLine: string
- isLast: boolean
Returns object
- lines: string[]
- partialLine: string

dispose

dispose(): void

- Defined in src/streamer/streamer.ts:199
Returns void

eachChunk

eachChunk(callback: function): void

- Defined in src/streamer/streamer.ts:175
Parameters
- callback: function
  - - (chunk: string | Uint8Array, chunkNo: number, chunkCount: number): void
    - Parameters
      - chunk: string | Uint8Array
      - chunkNo: number
      - chunkCount: number
      Returns void
Returns void

eachChunkOfLines

eachChunkOfLines(callback: function): void

- Defined in src/streamer/streamer.ts:188
Parameters
- callback: function
  - - (chunk: string[], chunkNo: number, chunkCount: number): void
    - Parameters
      - chunk: string[]
      - chunkNo: number
      - chunkCount: number
      Returns void
Returns void

isBinary

isBinary(): string | true | false

- Defined in src/streamer/streamer.ts:41
Returns string | true | false

nextChunk

nextChunk(): any

- Defined in src/streamer/streamer.ts:149
Returns any

nextChunkOfLines

nextChunkOfLines(): undefined | string[]

- Defined in src/streamer/streamer.ts:160
Returns undefined | string[]

peekLines

peekLines(m: number): string[]

- Defined in src/streamer/streamer.ts:84
Parameters
- m: number
Returns string[]

read

read(): Promise<any>

- Defined in src/streamer/streamer.ts:45
Returns Promise<any>

Generated using TypeDoc