Interface SizeReporter<T>

A SizeReporter's only purpose (at the moment) is to calculate the size of a resource. How the size is calculated or what unit it is in is defined by the class implementing this interface. One might use the amount of bytes and another might use the amount of triples stored in a resource.

Type Parameters

  • T

Hierarchy

  • SizeReporter

Implemented by

Properties

calculateChunkSize estimateSize getSize getUnit

Properties

calculateChunkSize

calculateChunkSize: ((chunk: T) => Promise<number>)

Type declaration

    • (chunk: T): Promise<number>

    • Calculate the size of a chunk based on which SizeReporter is being used

      Returns

      the size of the passed chunk as a number

      Parameters

      • chunk: T

        the chunk of which you want the size

      Returns Promise<number>

estimateSize

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

Type declaration

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

    • Estimate the size of a body / request by looking at its metadata

      Returns

      the estimated size of the body / request or undefined if no meaningful estimation can be made

      Parameters

      Returns Promise<undefined | number>

getSize

getSize: ((identifier: ResourceIdentifier) => Promise<Size>)

Type declaration

    • (identifier: ResourceIdentifier): Promise<Size>

    • Get the size of a given resource

      Returns

      The size of the resource as a Size object calculated recursively if the identifier leads to a container

      Parameters

      Returns Promise<Size>

getUnit

getUnit: (() => string)

Type declaration

    • (): string

    • Get the unit as a string in which a SizeReporter returns data

      Returns string

Settings

Member Visibility

Theme