FlatfileResults

@flatfile/adapter

› FlatfileResults

Hierarchy

• FlatfileResults

Index

Constructors

• constructor

Accessors

• allData
• batchId
• createdAt
• customColumns
• customer
• data
• deletedData
• failedAt
• failureReason
• fileName
• headersMatched
• headersRaw
• managed
• manual
• rawOutput
• stats
• submittedAt
• validData

Methods

• nextChunk

Constructors

constructor

+ new FlatfileResults(data: Array‹

RecordObject

›, meta:

Meta

, importer: Importer): FlatfileResults

Defined in src/results.ts:23

Parameters:

Name	Type
data	Array‹ RecordObject ›
meta	Meta
importer	Importer

Returns: FlatfileResults

Accessors

allData

• 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›

---

batchId

• 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

---

createdAt

• 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

---

customColumns

• get customColumns(): Array‹object›

Defined in src/results.ts:205

An array of any columns that were created during import

Returns: Array‹object›

---

customer

• get customer(): User | null

Defined in src/results.ts:93

The customer provided in setCustomer

Returns: User | null

---

data

• 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›

---

deletedData

• 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›

---

failedAt

• get failedAt(): string | null

Defined in src/results.ts:226

The time that the import failed if it failed

Returns: string | null

---

failureReason

• get failureReason(): string | null

Defined in src/results.ts:212

The reason for the failure if there was a failure

Returns: string | null

---

fileName

• get fileName(): string | null

Defined in src/results.ts:129

The filename of the originally uploaded file

Returns: string | null

---

headersMatched

• get headersMatched(): Array‹object› | null

Defined in src/results.ts:178

The headers after they are matched

Returns: Array‹object› | null

---

headersRaw

• 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

---

managed

• get managed(): boolean

Defined in src/results.ts:136

If the final upload is managed by a private endpoint or not

Returns: boolean

---

manual

• get manual(): boolean

Defined in src/results.ts:143

If the data was entered manually instead of via file upload or not

Returns: boolean

---

rawOutput

• 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

›

---

stats

• get stats():

Stats

Defined in src/results.ts:86

Stats and counts about this file upload

Returns:

Stats

---

submittedAt

• get submittedAt(): string | null

Defined in src/results.ts:219

The time that the data was submitted

Returns: string | null

---

validData

• get validData(): Array‹any›

Defined in src/results.ts:50

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

Returns: Array‹any›

Methods

nextChunk

▸ nextChunk(): Promise‹null |

StreamedResults

›

Defined in src/results.ts:185

Get the next chunk of records

Returns: Promise‹null |

StreamedResults

›