StreamedResults

StreamedResults /

Hierarchy

  • StreamedResults

Index

Constructors

Accessors

Constructors

constructor

+ new StreamedResults(data: Array<RecordObject>, meta: StreamedMeta): StreamedResults

Defined in streamed-results.ts:13

Parameters:

NameType
dataArray<RecordObject>
metaStreamedMeta

Returns: StreamedResults

Accessors

allData

get allData(): Array<any>

Defined in streamed-results.ts:58

All data from the original file upload including deleted rows, key-mapped to the configuration provided

Returns: Array<any>


chunkSize

get chunkSize(): number

Defined in streamed-results.ts:79

The size of chunks as configured when requesting data.

Returns: number


currentChunk

get currentChunk(): number

Defined in streamed-results.ts:86

The current chunk by index

Returns: number


data

get data(): Array<any>

Defined in streamed-results.ts:32

An array of valid data, key-mapped to the configuration provided (alias of validData)

Returns: Array<any>


deletedData

get deletedData(): Array<any>

Defined in streamed-results.ts:49

Rows of data the user excluded from the final results, key-mapped to the configuration provided

Returns: Array<any>


hasMore

get hasMore(): boolean

Defined in streamed-results.ts:93

The current chunk by index

Returns: boolean


rawOutput

get rawOutput(): Array<RecordObject>

Defined in streamed-results.ts:24

The raw output from the importer including all deleted rows and sequence info

Returns: Array<RecordObject>


remainingChunks

get remainingChunks(): number

Defined in streamed-results.ts:65

The number of remaining chunks in the stream

Returns: number


totalChunks

get totalChunks(): number

Defined in streamed-results.ts:72

The total number of chunks that will have to be received before data processing is completed

Returns: number


validData

get validData(): Array<any>

Defined in streamed-results.ts:39

An array of valid data, key-mapped to the configuration provided

Returns: Array<any>