+ new FlatfileResults(
datametaimporterDefined in src/results.ts:23
Parameters:
| Name | Type |
|---|---|
data | Array‹RecordObject› |
meta | Meta |
importer | Importer |
Returns: FlatfileResults
• get allData(): Array‹any›
Defined in src/results.ts:71
All data from the original file upload including deleted rows, key-mapped to the configuration provided
Returns: Array‹any›
• get batchId(): string
Defined in src/results.ts:79
The uuid of the batch assigned by Flatfile (use this in internal references for support purposes)
Returns: string
• get config(): object
Defined in src/results.ts:150
The parsed and bootstrapped config object used by this importer instance
Returns: object
• get createdAt(): string
Defined in src/results.ts:233
The time the data began the import, whether via file upload or manual data entry
Returns: string
• get csvFile(): UploadFile | null
Defined in src/results.ts:113
Same as originalFile unless it was uploaded in xls format, in which case this is the converted csv file stored as an AWS url
Returns: UploadFile | null
• get customColumns(): Array‹object›
Defined in src/results.ts:205
An array of any columns that were created during import
Returns: Array‹object›
• get customer(): User | null
Defined in src/results.ts:93
The customer provided in setCustomer
Returns: User | null
• get data(): Array‹any›
Defined in src/results.ts:43
An array of valid data, key-mapped to the configuration provided (alias of validData)
Returns: Array‹any›
• get deletedData(): Array‹any›
Defined in src/results.ts:61
Rows of data the user excluded from the final results, key-mapped to the configuration provided
Returns: Array‹any›
• get failedAt(): string | null
Defined in src/results.ts:226
The time that the import failed if it failed
Returns: string | null
• get failureReason(): string | null
Defined in src/results.ts:212
The reason for the failure if there was a failure
Returns: string | null
• get fileName(): string | null
Defined in src/results.ts:129
The filename of the originally uploaded file
Returns: string | null
• get headersMatched(): Array‹object› | null
Defined in src/results.ts:178
The headers after they are matched
Returns: Array‹object› | null
• get headersRaw(): Array‹object› | null
Defined in src/results.ts:171
The headers before they were matched as given in the original file
Returns: Array‹object› | null
• get managed(): boolean
Defined in src/results.ts:136
If the final upload is managed by a private endpoint or not
Returns: boolean
• get manual(): boolean
Defined in src/results.ts:143
If the data was entered manually instead of via file upload or not
Returns: boolean
• get originalFile(): UploadFile | null
Defined in src/results.ts:103
A File object of the originally uploaded file stored as an AWS url
Returns: UploadFile | null
• get parsingConfig(): object
Defined in src/results.ts:157
The configuration used by the csv parser PapaParse: https://www.papaparse.com/docs#config
Returns: object
• get rawOutput(): Array‹RecordObject›
Defined in src/results.ts:35
The raw output from the importer including all deleted rows and sequence info
Returns: Array‹RecordObject›
• get skippedRows(): number | null
Defined in src/results.ts:164
The invalid rows that were skipped on submission
Returns: number | null
• get stats(): Stats
Defined in src/results.ts:86
Stats and counts about this file upload
Returns: Stats
• get submittedAt(): string | null
Defined in src/results.ts:219
The time that the data was submitted
Returns: string | null
• get validData(): Array‹any›
Defined in src/results.ts:50
An array of valid data, key-mapped to the configuration provided
Returns: Array‹any›
▸ nextChunk(): Promise‹null | StreamedResults›
Defined in src/results.ts:185
Get the next chunk of records
Returns: Promise‹null | StreamedResults›