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

Constructors

constructor

Properties

_raw

Accessors

byteLength

Methods

[$SerializeForCollection] [$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

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

Methods

[$SerializeForCollection]

  • [$SerializeForCollection](): void

  • Errorful implementation of $SerializeForCollection for TableCodec

    Throws a human-readable error message warning that this datatype may not be used with collections without writing a custom ser/des codec.

    Returns void

[$SerializeForTable]

  • [$SerializeForTable](ctx): readonly [0, undefined | {
        $binary: string;
    }]

  • Implementation of $SerializeForTable for TableCodec

    Parameters

    Returns readonly [0, undefined | {
        $binary: string;
    }]

asArrayBuffer

  • asArrayBuffer(): ArrayBuffer

  • Returns the blob as an ArrayBuffer, converting between types if necessary.

    Returns ArrayBuffer

    The blob as an ArrayBuffer

asBase64

  • asBase64(): string

  • Returns the blob as a base64 string, converting between types if necessary.

    Returns string

    The blob as a base64 string

asBuffer

  • asBuffer(): Buffer

  • Returns the blob as a Buffer, if available, converting between types if necessary.

    Returns Buffer

    The blob as a Buffer

raw

  • raw(): ArrayBuffer | Buffer | {
        $binary: string;
    }

  • Gets the raw underlying implementation of the blob.

    Returns ArrayBuffer | Buffer | {
        $binary: string;
    }

    The raw blob

toString

Static [$DeserializeForTable]

Static isBlobLike

Settings

Member Visibility

Theme

On This Page

constructor_rawbyteLength[$SerializeForCollection][$SerializeForTable]asArrayBufferasBase64asBufferrawtoString[$DeserializeForTable]isBlobLike