Class DataAPITime

Represents a time column for Data API tables.

You may use the time function as a shorthand for creating a new DataAPITime.

See the official DataStax documentation for more information.

Implements

TableCodec<typeof DataAPITime>

Index

Constructors

Properties

Methods

[$SerializeForTable] components toDate toString #initTime [$DeserializeForTable]

Constructors

constructor

new DataAPITime(input?): DataAPITime
Creates a new DataAPITime instance from various formats.
Parameters
- Optional input: string | Date | DataAPITimeComponents & {
  nanoseconds?: number;
  }
  The input to create the DataAPITime from
Returns DataAPITime
- Defined in src/documents/datatypes/dates.ts:276

Properties

`Private` `Readonly` #time

#time: 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:260

components

components(): DataAPITimeComponents
Returns the DataAPITimeComponents that make up this DataAPITime

Returns DataAPITimeComponents
The components of the time
- Defined in src/documents/datatypes/dates.ts:301

toDate

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

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

toString

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

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

`Static` `Private` #initTime

#initTime(hours, minutes, seconds, fractional?): string
Parameters
- hours: number
- minutes: number
- seconds: number
- Optional fractional: unknown
Returns string
- Defined in src/documents/datatypes/dates.ts:292

`Static` [$DeserializeForTable]

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