Interface: DateAdapter
Defined in: adapters.d.ts:6 (opens new window)
Methods
add
▸ add(timestamp
: number, amount
: number, unit
: ): number
Adds the specified amount
of unit
to the given timestamp
.
Parameters:
Returns: number
Defined in:
diff
▸ diff(a
: number, b
: number, unit
: ): number
Returns the number of unit
between the given timestamps.
Parameters:
Name | Type | Description |
---|---|---|
number | the input timestamp (reference) | |
b | number | the timestamp to subtract |
unit | the unit as string |
Returns: number
Defined in: adapters.d.ts:42 (opens new window)
▸ endOf(timestamp
: number, unit
: millisecond | second | minute | hour | day | week | month | quarter | year | isoWeek): number
Parameters:
Returns: number
Defined in: adapters.d.ts:58 (opens new window)
format
▸ format(timestamp
: number, format
: TimeUnit): string
Returns the formatted date in the specified format
for a given timestamp
.
Parameters:
Name | Type | Description |
---|---|---|
timestamp | number | the timestamp to format |
TimeUnit | the date/time token |
Returns: string
Defined in:
formats
▸ formats(): object
Returns a map of time formats for the supported formatting units defined in Unit as well as ‘datetime’ representing a detailed date/time string.
Returns: object
Defined in:
Parameters:
Returns: void
Defined in:
parse
▸ parse(value
: any, format?
: ): number
Parses the given value
and return the associated timestamp.
Parameters:
Name | Type | Description |
---|---|---|
value | any | the value to parse (usually comes from the data) |
format? | - |
Returns: number
Defined in: adapters.d.ts:19 (opens new window)
startOf
▸ startOf(timestamp
: number, unit
: millisecond | second | minute | hour | day | week | month | quarter | year | isoWeek, weekday?
: number): number
Returns start of unit
for the given timestamp
.
Parameters:
Returns: number
Defined in: