@terascope/file-asset-apis / interfaces

interfaces

Enumerations

Enumeration	Description
Compression	-
FileSenderType	-
Format	-

Interfaces

Interface	Description
ChunkedAPIMethods	-
ChunkedFileReaderConfig	-
ChunkedFileSenderConfig	-
CSVReaderConfig	-
CSVSenderConfig	-
FileSlice	The File Slice
FileSliceConfig	-
HDFSReaderConfig	-
JSONReaderConfig	-
JSONSenderConfig	-
LDJSONReaderConfig	-
LDJSONSenderConfig	-
NameOptions	-
Offsets	-
ReaderConfig	-
S3PutConfig	-
SliceConfig	-

Type Aliases

CSVOptions

CSVOptions = json2csv.Options<any>

Defined in: interfaces.ts:16

---

FetcherFn()

FetcherFn = (slice) => Promise<string>

Defined in: interfaces.ts:292

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:113

Parameters

Parameter	Type
config	CSVReaderConfig

Returns

string

---

getFieldsFromConfig()

getFieldsFromConfig(config): undefined | string[]

Defined in: interfaces.ts:124

Parameters

Parameter	Type
config	ChunkedFileReaderConfig | ChunkedFileSenderConfig

Returns

undefined | string[]

---

getLineDelimiter()

getLineDelimiter(config): string

Defined in: interfaces.ts:118

Parameters

Parameter	Type
config	ChunkedFileReaderConfig | ChunkedFileSenderConfig

Returns

string

---

isCSVReaderConfig()

isCSVReaderConfig(config): config is CSVReaderConfig

Defined in: interfaces.ts:109

Parameters

Parameter	Type
config	ChunkedFileReaderConfig

Returns

config is CSVReaderConfig

---

isCSVSenderConfig()

isCSVSenderConfig(config): config is CSVSenderConfig

Defined in: interfaces.ts:152

Parameters

Parameter	Type
config	ChunkedFileReaderConfig

Returns

config is CSVSenderConfig

---

isJSONReaderConfig()

isJSONReaderConfig(config): config is JSONReaderConfig

Defined in: interfaces.ts:166

Parameters

Parameter	Type
config	ChunkedFileReaderConfig

Returns

config is JSONReaderConfig

---

isJSONSenderConfig()

isJSONSenderConfig(config): config is JSONSenderConfig

Defined in: interfaces.ts:180

Parameters

Parameter	Type
config	ChunkedFileReaderConfig

Returns

config is JSONSenderConfig

---

isLDJSONReaderConfig()

isLDJSONReaderConfig(config): config is LDJSONReaderConfig

Defined in: interfaces.ts:193

Parameters

Parameter	Type
config	ChunkedFileReaderConfig

Returns

config is LDJSONReaderConfig

---

isLDJSONSenderConfig()

isLDJSONSenderConfig(config): config is LDJSONSenderConfig

Defined in: interfaces.ts:209

Parameters

Parameter	Type
config	ChunkedFileReaderConfig

Returns

config is LDJSONSenderConfig