Class FileSizeReporter

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

Hierarchy

FileSizeReporter

Implements

SizeReporter<string>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FileSizeReporter(fileIdentifierMapper: FileIdentifierMapper, rootFilePath: string, ignoreFolders?: string[]): FileSizeReporter

- Defined in src/storage/size-reporter/FileSizeReporter.ts:19
Parameters
- fileIdentifierMapper: FileIdentifierMapper
- rootFilePath: string
- Optional ignoreFolders: string[]
Returns FileSizeReporter

Properties

Private Readonly fileIdentifierMapper

fileIdentifierMapper: FileIdentifierMapper

Private Readonly ignoreFolders

ignoreFolders: RegExp[]

Private Readonly rootFilePath

rootFilePath: string

Methods

calculateChunkSize

calculateChunkSize(chunk: string): Promise<number>

Implementation of SizeReporter.calculateChunkSize
- Defined in src/storage/size-reporter/FileSizeReporter.ts:39
Calculate the size of a chunk based on which SizeReporter is being used

Parameters
- chunk: string
Returns Promise<number>

estimateSize

estimateSize(metadata: RepresentationMetadata): Promise<undefined | number>

Implementation of SizeReporter.estimateSize
- Defined in src/storage/size-reporter/FileSizeReporter.ts:44
The estimated size of a resource in this reporter is simply the content-length header

Parameters
- metadata: RepresentationMetadata
Returns Promise<undefined | number>

getSize

getSize(identifier: ResourceIdentifier): Promise<Size>

Implementation of SizeReporter.getSize
- Defined in src/storage/size-reporter/FileSizeReporter.ts:33
Returns the size of the given resource ( and its children ) in bytes

Parameters
- identifier: ResourceIdentifier
Returns Promise<Size>

Private getTotalSize

getTotalSize(fileLocation: string): Promise<number>

- Defined in src/storage/size-reporter/FileSizeReporter.ts:54
Get the total size of a resource and its children if present

Parameters
- fileLocation: string
  
  the resource of which you want the total size of ( on disk )
Returns Promise<number>
a number specifying how many bytes are used by the resource

getUnit

getUnit(): string

Implementation of SizeReporter.getUnit
- Defined in src/storage/size-reporter/FileSizeReporter.ts:26
The FileSizeReporter will always return data in the form of bytes

Returns string