@terascope/file-asset-apis / interfaces

interfaces

Enumerations

Enumeration	Description
Compression	-
FileSenderType	-
Format	-

Interfaces

Interface	Description
ChunkedAPIMethods	-
ChunkedFileReaderAPIConfig	-
ChunkedFileSenderAPIConfig	-
CSVReaderAPIConfig	-
CSVSenderAPIConfig	-
FileSlice	The File Slice
FileSliceConfig	-
JSONReaderAPIConfig	-
JSONSenderAPIConfig	-
LDJSONReaderAPIConfig	-
LDJSONSenderAPIConfig	-
NameOptions	-
Offsets	-
ReaderAPIConfig	-
S3PutConfig	-
SliceConfig	-

Type Aliases

CSVOptions

CSVOptions = json2csv.Options<any>

Defined in: interfaces.ts:16

---

FetcherFn

FetcherFn = (slice) => Promise<string>

Defined in: interfaces.ts:294

Parameters

Parameter	Type
slice	FileSlice

Returns

Promise<string>

---

SendRecord

SendRecord = Record<string, unknown> | DataEntity

Defined in: interfaces.ts:7

Used for defining the slice records type definition

---

SendRecords

SendRecords = Iterable<SendRecord>

Defined in: interfaces.ts:8

Functions

getFieldDelimiter()

getFieldDelimiter(config): string

Defined in: interfaces.ts:115

Parameters

Parameter	Type
config	CSVReaderAPIConfig

Returns

string

---

getFieldsFromConfig()

getFieldsFromConfig(config): string[] | undefined

Defined in: interfaces.ts:126

Parameters

Parameter	Type
config	ChunkedFileReaderAPIConfig | ChunkedFileSenderAPIConfig

Returns

string[] | undefined

---

getLineDelimiter()

getLineDelimiter(config): string

Defined in: interfaces.ts:120

Parameters

Parameter	Type
config	ChunkedFileReaderAPIConfig | ChunkedFileSenderAPIConfig

Returns

string

---

isCSVReaderAPIConfig()

isCSVReaderAPIConfig(config): config is CSVReaderAPIConfig

Defined in: interfaces.ts:109

Parameters

Parameter	Type
config	ChunkedFileReaderAPIConfig

Returns

config is CSVReaderAPIConfig

---

isCSVSenderAPIConfig()

isCSVSenderAPIConfig(config): config is CSVSenderAPIConfig

Defined in: interfaces.ts:154

Parameters

Parameter	Type
config	Partial<ChunkedFileSenderAPIConfig>

Returns

config is CSVSenderAPIConfig

---

isJSONReaderAPIConfig()

isJSONReaderAPIConfig(config): config is JSONReaderAPIConfig

Defined in: interfaces.ts:170

Parameters

Parameter	Type
config	ChunkedFileReaderAPIConfig

Returns

config is JSONReaderAPIConfig

---

isJSONSenderAPIConfig()

isJSONSenderAPIConfig(config): config is JSONSenderAPIConfig

Defined in: interfaces.ts:186

Parameters

Parameter	Type
config	ChunkedFileSenderAPIConfig

Returns

config is JSONSenderAPIConfig

---

isLDJSONReaderAPIConfig()

isLDJSONReaderAPIConfig(config): config is LDJSONReaderAPIConfig

Defined in: interfaces.ts:201

Parameters

Parameter	Type
config	ChunkedFileReaderAPIConfig

Returns

config is LDJSONReaderAPIConfig

---

isLDJSONSenderAPIConfig()

isLDJSONSenderAPIConfig(config): config is LDJSONSenderAPIConfig

Defined in: interfaces.ts:217

Parameters

Parameter	Type
config	ChunkedFileSenderAPIConfig

Returns

config is LDJSONSenderAPIConfig