Class BFast

See https://github.com/vimaec/bfast for bfast format spec This implementation can either lazily request content as needed from http Or it can serve the data directly from an ArrayBuffer Remote mode can transition to buffer mode if server doesnt support partial http request

Hierarchy

  • BFast

Constructors

constructor

Properties

name offset source

Methods

forceDownload getArray getBfast getBuffer getBytes getHeader getLocalBfast getRange getRanges getRow getSelf getValue getValues

Constructors

constructor

  • Parameters

    • source: ArrayBuffer | RemoteBuffer
    • Optional offset: number
    • Optional name: string

    Returns BFast

Properties

name

name: string

offset

offset: number

source

source: ArrayBuffer | RemoteBuffer

Methods

forceDownload

  • Forces download of the full underlying buffer, from now on all calls will be local.

    Returns Promise<void>

getArray

  • Returns a number array from the buffer associated with name

    Parameters

    • name: string

      buffer name

    Returns Promise<NumericArray>

getBfast

  • Returns the buffer associated with name as a new bfast. This value is cached for future requests.

    Parameters

    • name: string

      buffer name

    Returns Promise<BFast>

getBuffer

  • Returns the raw buffer associated with a name This value is not cached.

    Parameters

    • name: string

      buffer name

    Returns Promise<ArrayBuffer>

getBytes

  • Returns the buffer with given name as a byte array

    Parameters

    • name: string

      buffer name

    Returns Promise<Uint8Array>

getHeader

  • Returns

    Bfast Header

    Returns Promise<BFastHeader>

getLocalBfast

  • Parameters

    • name: string

    Returns Promise<BFast>

getRange

  • Parameters

    • name: string

    Returns Promise<Range>

getRanges

  • Returns

    a map of all buffers by names

    Returns Promise<Map<string, Range>>

getRow

  • Returns a map of name-values with the same index from all buffers.

    Parameters

    • index: number

    Returns Promise<Map<string, number | BigInt>>

getSelf

  • Returns a new local bfast equivalent to this bfast.

    Returns Promise<BFast>

getValue

  • Returns a single value from given buffer name

    Parameters

    • name: string

      buffer name

    • index: number

      row index

    Returns Promise<number | BigInt>

getValues

  • Returns count subsequent values from given buffer name.

    Parameters

    • name: string

      buffer name

    • index: number

      row index

    • count: number

      count of values to return

    Returns Promise<NumericArray>

Settings

Member Visibility

Theme

Generated using TypeDoc