Jump to Content

BlobData | @here/olp-sdk-ts

BlobData | @here/olp-sdk-ts

Class BlobData Abstract

An abstraction for BlobData instances.

The wrapper of data (Blob, Buffer, File, string, and so on) that allows to read a specific range of bytes and get data size.

Hierarchy

BlobData

Index

Constructors

constructor

Methods

Constructors

constructor

new BlobData(): BlobData

Returns BlobData

Methods

Optional Abstract finally

finally(): Promise<void>

- Defined in @here/olp-sdk-dataservice-write/lib/utils/BlobData.ts:49
This method should always be called at the end of the reading process so that we can properly clean up.

Returns Promise<void>

Abstract readBytes

readBytes(offset: number, count: number): Promise<ArrayBufferLike>

- Defined in @here/olp-sdk-dataservice-write/lib/utils/BlobData.ts:36
Gets buffer from a range of data.

Parameters
- offset: number
  
  The first byte of the data range for reading.
- count: number
  
  The number of bytes to read from the underlying data. This value will be trimmed if the count exceeded the EOF or end of the stream.
Returns Promise<ArrayBufferLike>
The Promise object with the buffer.

Abstract size

size(): number

- Defined in @here/olp-sdk-dataservice-write/lib/utils/BlobData.ts:43
Gets the size of the data.

Returns number
The Promise object with the length of the data in bytes.

Generated using TypeDoc