Interface Source

Interface for retrieving an archive from remote or local storage.

interface Source {
getBytes: ((offset, length, signal?, etag?) => Promise<RangeResponse>);
getKey: (() => string);
}

Implemented by

Index

Properties

getBytes getKey

Properties

getBytes

getBytes: ((offset, length, signal?, etag?) => Promise<RangeResponse>)

Type declaration

- (offset, length, signal?, etag?): Promise<RangeResponse>
- Parameters
  - offset: number
  - length: number
  - Optional signal: AbortSignal
  - Optional etag: string
  Returns Promise<RangeResponse>

getKey

getKey: (() => string)

Return a unique string key for the archive e.g. a URL.

Type declaration

- (): string
- Return a unique string key for the archive e.g. a URL.
  
  Returns string

Generated using TypeDoc