Class FileSizeReporter

SizeReporter that is used to calculate sizes of resources for a file based system.

Implements

SizeReporter<string>

Index

Constructors

Methods

calculateChunkSize estimateSize getSize getUnit

Constructors

constructor

new FileSizeReporter(fileIdentifierMapper, rootFilePath, ignoreFolders?): FileSizeReporter
Parameters
- fileIdentifierMapper: FileIdentifierMapper
- rootFilePath: string
- OptionalignoreFolders: string[]
Returns FileSizeReporter
- Defined in src/storage/size-reporter/FileSizeReporter.ts:19

Methods

calculateChunkSize

calculateChunkSize(chunk): Promise<number>
Calculate the size of a chunk based on which SizeReporter is being used
Parameters
- chunk: string
  the chunk of which you want the size
Returns Promise<number>
the size of the passed chunk as a number
Implementation of SizeReporter.calculateChunkSize
- Defined in src/storage/size-reporter/FileSizeReporter.ts:39

estimateSize

estimateSize(metadata): Promise<undefined | number>
The estimated size of a resource in this reporter is simply the content-length header
Parameters
- metadata: RepresentationMetadata
Returns Promise<undefined | number>
Implementation of SizeReporter.estimateSize
- Defined in src/storage/size-reporter/FileSizeReporter.ts:44

getSize

getSize(identifier): Promise<Size>
Returns the size of the given resource ( and its children ) in bytes
Parameters
- identifier: ResourceIdentifier
Returns Promise<Size>
Implementation of SizeReporter.getSize
- Defined in src/storage/size-reporter/FileSizeReporter.ts:33

getUnit

getUnit(): string
The FileSizeReporter will always return data in the form of bytes

Returns string
Implementation of SizeReporter.getUnit
- Defined in src/storage/size-reporter/FileSizeReporter.ts:26