Class FileSizeReporter

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

Hierarchy

FileSizeReporter

Implements

SizeReporter<string>

Index

Constructors

Properties

fileIdentifierMapper ignoreFolders rootFilePath

Methods

calculateChunkSize estimateSize getSize getTotalSize getUnit

Constructors

constructor

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

Properties

`Private` `Readonly` fileIdentifierMapper

fileIdentifierMapper: FileIdentifierMapper

`Private` `Readonly` ignoreFolders

ignoreFolders: RegExp[]

`Private` `Readonly` rootFilePath

rootFilePath: string

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

`Private` getTotalSize

getTotalSize(fileLocation): Promise<number>
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
- Defined in src/storage/size-reporter/FileSizeReporter.ts:54

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