@terascope/file-asset-apis / s3/s3-slicer / S3Slicer

Class: S3Slicer

Defined in: s3/s3-slicer.ts:7

Constructors

Constructor

new S3Slicer(client, config, logger): S3Slicer

Defined in: s3/s3-slicer.ts:16

Parameters

Parameter	Type
client	S3Client
config	FileSliceConfig
logger	Logger

Returns

S3Slicer

Properties

Property	Modifier	Type	Default value	Defined in
_doneSlicing	protected	boolean	false	s3/s3-slicer.ts:14
bucket	readonly	string	undefined	s3/s3-slicer.ts:11
client	public	S3Client	undefined	s3/s3-slicer.ts:10
logger	public	Logger	undefined	s3/s3-slicer.ts:9
prefix	readonly	string	undefined	s3/s3-slicer.ts:12
sliceConfig	readonly	SliceConfig	undefined	s3/s3-slicer.ts:8

Methods

slice()

slice(): Promise<null | FileSlice[]>

Defined in: s3/s3-slicer.ts:78

This method will return an array of file slices, or null if the slicer is done

Returns

Promise<null | FileSlice[]>