Class DataAPIDate

Represents a date column for Data API tables.

You may use the date function as a shorthand for creating a new DataAPIDate.

See the official DataStax documentation for more information.

Implements

TableCodec<typeof DataAPIDate>

Index

Constructors

Properties

Methods

[$SerializeForTable] components toDate toString [$DeserializeForTable]

Constructors

constructor

new DataAPIDate(input?): DataAPIDate
Creates a new DataAPIVector instance from various formats.
Parameters
- Optional input: string | Date | DataAPIDateComponents
  The input to create the DataAPIDate from
Returns DataAPIDate
- Defined in src/documents/datatypes/dates.ts:81

Properties

`Private` `Readonly` #date

#date: string

Methods

[$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:65

components

components(): DataAPIDateComponents
Returns the DataAPIDateComponents that make up this DataAPIDate

Returns DataAPIDateComponents
The components of the date
- Defined in src/documents/datatypes/dates.ts:104

toDate

toDate(base?): Date
Converts this DataAPIDate to a Date object

If no base date/time is provided to use the time from, the time component is set to be the current time.
Parameters
- Optional base: Date | DataAPITime | DataAPITimestamp
  The base date/time to use for the time component
Returns Date
The Date object representing this DataAPIDate
- Defined in src/documents/datatypes/dates.ts:124

toString

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

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

`Static` [$DeserializeForTable]

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