Class GlobalQuotaStrategy

Readonlylimit

Readonlyreporter

createQuotaGuard

• createQuotaGuard(identifier): Promise<Guarded<PassThrough>>

• Get a Passthrough stream that will keep track of the available space. If the quota is exceeded the stream will emit an error and destroy itself. Like other Passthrough instances this will simply pass on the chunks, when the quota isn't exceeded.

  Parameters

  • identifier: ResourceIdentifier

    the identifier of the resource in question

  Returns Promise<Guarded<PassThrough>>

  a Passthrough instance that errors when quota is exceeded

estimateSize

• estimateSize(metadata): Promise<undefined | Size>

• Get an estimated size of the resource

  Parameters

  • metadata: RepresentationMetadata

    the metadata that might include the size

  Returns Promise<undefined | Size>

  a Size object containing the estimated size and unit of the resource

getAvailableSpace

• getAvailableSpace(identifier): Promise<Size>

• Get the available space when writing data to the given identifier. If the given resource already exists it will deduct the already taken up space by that resource since it is going to be overwritten and thus counts as available space.

  Parameters

  • identifier: ResourceIdentifier

    the identifier of the resource of which you want the available space

  Returns Promise<Size>

  the available space and the unit of the space as a Size object