@terascope/file-asset-apis / file/file-fetcher / FileFetcher

Class: FileFetcher

Defined in: file/file-fetcher.ts:6

Extends

• ChunkedFileReader

Extended by

• FileTerasliceAPI

Constructors

Constructor

new FileFetcher(config, logger): FileFetcher

Defined in: file/file-fetcher.ts:10

Parameters

Parameter	Type
config	ReaderAPIConfig
logger	Logger

Returns

FileFetcher

Overrides

ChunkedFileReader.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
client	public	__module	fse	-	file/file-fetcher.ts:7
compressor	public	Compressor	undefined	ChunkedFileReader.compressor	base/chunked-file-reader.ts:73
filePerSlice	protected	boolean	undefined	ChunkedFileReader.filePerSlice	base/chunked-file-reader.ts:82
logger	public	Logger	undefined	ChunkedFileReader.logger	base/chunked-file-reader.ts:72
size	readonly	number	undefined	-	file/file-fetcher.ts:8

Accessors

format

Get Signature

get format(): Format

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

Returns

Format

Inherited from

ChunkedFileReader.format

---

lineDelimiter

Get Signature

get lineDelimiter(): string

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

Returns

string

Inherited from

ChunkedFileReader.lineDelimiter

Methods

csv()

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

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

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

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

Inherited from

ChunkedFileReader.csv

---

fetch()

protected fetch(slice): Promise<string>

Defined in: file/file-fetcher.ts:29

low level api that fetches the unprocessed contents of the file, please use the "read" method for correct file and data parsing

Parameters

Parameter	Type
slice	FileSlice

Returns

Promise<string>

Example

const slice = {
         offset: 0,
         length: 1000,
         path: 'some/file.txt',
         total: 1000
     };
     const results = await fileReader.fetch(slice);
     results === 'the unprocessed contents of the file here'

Overrides

ChunkedFileReader.fetch

---

getMargin()

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

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

Parameters

Parameter	Type
slice	FileSlice
delimiter	string

Returns

Promise<string>

Inherited from

ChunkedFileReader.getMargin

---

json()

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

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

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

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

Inherited from

ChunkedFileReader.json

---

ldjson()

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

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

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

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

Inherited from

ChunkedFileReader.ldjson

---

raw()

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

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

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

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

Inherited from

ChunkedFileReader.raw

---

read()

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

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

Parameters

Parameter	Type
slice	FileSlice

Returns

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

Inherited from

ChunkedFileReader.read

---

tsv()

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

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

Parameters

Parameter	Type
incomingData	string
slice	FileSlice

Returns

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

Inherited from

ChunkedFileReader.tsv