Class DataAPITimestamp

Represents a timestamp column for Data API tables.

You may use the timestamp function as a shorthand for creating a new DataAPITimestamp.

See the official DataStax documentation for more information.

Implements

CollCodec<typeof DataAPITimestamp>
TableCodec<typeof DataAPITimestamp>

Index

Constructors

Properties

Methods

[$SerializeForCollection] [$SerializeForTable] components toDate toString [$DeserializeForCollection] [$DeserializeForTable]

Constructors

constructor

new DataAPITimestamp(input?): DataAPITimestamp
Creates a new DataAPITimestamp instance from various formats.
Parameters
- Optional input: string | Date | Partial<DataAPITimestampComponents>
  The input to create the DataAPITimestamp from
Returns DataAPITimestamp
- Defined in src/documents/datatypes/dates.ts:444

Properties

`Private` `Readonly` #timestamp

#timestamp: string

Methods

[$SerializeForCollection]

[$SerializeForCollection](ctx): readonly [0, undefined | {
$date: string;
}]
Implementation of $SerializeForCollection for TableCodec
Parameters
- ctx: CollSerCtx
Returns readonly [0, undefined | {
$date: string;
}]
- Defined in src/documents/datatypes/dates.ts:421

[$SerializeForTable]

[$SerializeForTable](ctx): readonly [0, undefined | string]
Implementation of $SerializeForTable for TableCodec
Parameters
- ctx: TableSerCtx
Returns readonly [0, undefined | string]
- Defined in src/documents/datatypes/dates.ts:414

components

components(): DataAPITimestampComponents
Returns the DataAPITimestampComponents that make up this DataAPITimestamp

Returns DataAPITimestampComponents
The components of the timestamp
- Defined in src/documents/datatypes/dates.ts:465

toDate

toDate(): Date
Converts this DataAPITimestamp to a Date object

Returns Date
The Date object representing this DataAPITimestamp
- Defined in src/documents/datatypes/dates.ts:483

toString

toString(): string
Returns the string representation of this DataAPITimestamp

Returns string
The string representation of this DataAPITimestamp
- Defined in src/documents/datatypes/dates.ts:492

`Static` [$DeserializeForCollection]

[$DeserializeForCollection](_, value, ctx): readonly [0, undefined | DataAPITimestamp]
Implementation of $DeserializeForCollection for TableCodec
Parameters
- _: string
- value: any
- ctx: CollDesCtx
Returns readonly [0, undefined | DataAPITimestamp]
- Defined in src/documents/datatypes/dates.ts:435

`Static` [$DeserializeForTable]

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