Class DataAPIBlob

Represents a blob column for Data API tables.

See DataAPIBlobLike for the types that can be converted into a DataAPIBlob.

You may use the blob function as a shorthand for creating a new DataAPIBlob.

See the official DataStax documentation for more information.

Implements

TableCodec<typeof DataAPIBlob>

Index

Constructors

Properties

Accessors

Methods

[$SerializeForTable] asArrayBuffer asBase64 asBuffer raw toString [$DeserializeForTable] isBlobLike

Constructors

constructor

new DataAPIBlob(blob, validate?): DataAPIBlob
Creates a new DataAPIBlob instance from a blob-like value.

You can set validate to false to bypass any validation if you're confident the value is a valid blob.
Parameters
- blob: DataAPIBlobLike
  The blob-like value to convert to a DataAPIBlob
- validate: boolean = true
  Whether to validate the blob-like value (default: true)
Returns DataAPIBlob
Throws
TypeError If blob is not a valid blob-like value
- Defined in src/documents/datatypes/blob.ts:71

Properties

`Private` `Readonly` #raw

#raw: ArrayBuffer | Buffer | {
$binary: string;
}

Type declaration

$binary: string

Accessors

byteLength

get byteLength(): number
Gets the byte length of the blob, agnostic of the underlying type.

Returns number
The byte length of the blob
- Defined in src/documents/datatypes/blob.ts:90

Methods

[$SerializeForTable]

[$SerializeForTable](ctx): readonly [0, undefined | {
$binary: string;
}]
Implementation of $SerializeForTable for TableCodec
Parameters
- ctx: TableSerCtx
Returns readonly [0, undefined | {
$binary: string;
}]
- Defined in src/documents/datatypes/blob.ts:50

asArrayBuffer

asArrayBuffer(): ArrayBuffer
Returns the blob as an ArrayBuffer, converting between types if necessary.

Returns ArrayBuffer
The blob as an ArrayBuffer
- Defined in src/documents/datatypes/blob.ts:116

asBase64

asBase64(): string
Returns the blob as a base64 string, converting between types if necessary.

Returns string
The blob as a base64 string
- Defined in src/documents/datatypes/blob.ts:154

asBuffer

asBuffer(): Buffer
Returns the blob as a Buffer, if available, converting between types if necessary.

Returns Buffer
The blob as a Buffer
- Defined in src/documents/datatypes/blob.ts:133

raw

raw(): ArrayBuffer | Buffer | {
$binary: string;
}
Gets the raw underlying implementation of the blob.

Returns ArrayBuffer | Buffer | {
$binary: string;
}
The raw blob
- Defined in src/documents/datatypes/blob.ts:107

toString

toString(): string
Returns a pretty string representation of the DataAPIBlob.

Returns string
- Defined in src/documents/datatypes/blob.ts:169

`Static` [$DeserializeForTable]

[$DeserializeForTable](value, ctx): readonly [0, undefined | DataAPIBlob]
Implementation of $DeserializeForTable for TableCodec
Parameters
- value: any
- ctx: TableDesCtx
Returns readonly [0, undefined | DataAPIBlob]
- Defined in src/documents/datatypes/blob.ts:57

`Static` isBlobLike

isBlobLike(value): value is DataAPIBlobLike
Determines whether the given value is a blob-like value (i.e. it's DataAPIBlobLike.
Parameters
- value: unknown
  The value to check
Returns value is DataAPIBlobLike
true if the value is a blob-like value; false otherwise
- Defined in src/documents/datatypes/blob.ts:181