@terascope/file-asset-apis / base/chunked-file-reader / ChunkedFileReader

Class: abstract ChunkedFileReader

Defined in: base/chunked-file-reader.ts:72

Extended by

• FileFetcher
• HDFSReader
• S3Fetcher

Constructors

Constructor

new ChunkedFileReader(inputConfig, logger): ChunkedFileReader

Defined in: base/chunked-file-reader.ts:85

Parameters

Parameter	Type
inputConfig	ChunkedFileReaderConfig
logger	Logger

Returns

ChunkedFileReader

Properties

Property	Modifier	Type	Defined in
compressor	public	Compressor	base/chunked-file-reader.ts:74
filePerSlice	protected	boolean	base/chunked-file-reader.ts:83
logger	public	Logger	base/chunked-file-reader.ts:73

Accessors

format

Get Signature

get format(): Format

Defined in: base/chunked-file-reader.ts:127

Returns

Format

---

lineDelimiter

Get Signature

get lineDelimiter(): string

Defined in: base/chunked-file-reader.ts:123

Returns

string

Methods

csv()

protected csv(incomingData, slice): Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>

Defined in: base/chunked-file-reader.ts:233

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>

---

fetch()

abstract protected fetch(msg): Promise<string>

Defined in: base/chunked-file-reader.ts:157

Parameters

Parameter	Type
msg	AnyObject

Returns

Promise<string>

---

getMargin()

protected getMargin(slice, delimiter): Promise<string>

Defined in: base/chunked-file-reader.ts:200

Parameters

Parameter	Type
slice	FileSlice
delimiter	string

Returns

Promise<string>

---

json()

protected json(incomingData, slice): Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>

Defined in: base/chunked-file-reader.ts:294

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>

---

ldjson()

protected ldjson(incomingData, slice): Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>

Defined in: base/chunked-file-reader.ts:320

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>

---

raw()

protected raw(incomingData, slice): Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>

Defined in: base/chunked-file-reader.ts:224

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>

---

read()

read(slice): Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[]>

Defined in: base/chunked-file-reader.ts:334

Parameters

Parameter	Type
slice	FileSlice

Returns

Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[]>

---

tsv()

protected tsv(incomingData, slice): Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>

Defined in: base/chunked-file-reader.ts:288

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

Promise<(null | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>)[]>