# Interface: DateAdapter

# Properties

# options

Readonly options: any

Defined in: adapters.d.ts:6 (opens new window)

# Methods

# add

add(timestamp: number, amount: number, unit: TimeUnit): number

Adds the specified amount of unit to the given timestamp.

# Parameters:

Name Type Description
timestamp number the input timestamp
amount number the amount to add
unit TimeUnit the unit as string

Returns: number

Defined in: adapters.d.ts:34 (opens new window)


# diff

diff(a: number, b: number, unit: TimeUnit): number

Returns the number of unit between the given timestamps.

# Parameters:

Name Type Description
a number the input timestamp (reference)
b number the timestamp to subtract
unit TimeUnit the unit as string

Returns: number

Defined in: adapters.d.ts:42 (opens new window)


# endOf

endOf(timestamp: number, unit: millisecond | second | minute | hour | day | week | month | quarter | year | isoWeek): number

Returns end of unit for the given timestamp.

# Parameters:

Name Type Description
timestamp number the input timestamp
unit millisecond | second | minute | hour | day | week | month | quarter | year | isoWeek the unit as string

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
format TimeUnit the date/time token

Returns: string

Defined in: adapters.d.ts:26 (opens new window)


# 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: adapters.d.ts:13 (opens new window)


# override

override(members: Partial<DateAdapter>): void

# Parameters:

Name Type
members Partial<DateAdapter>

Returns: void

Defined in: adapters.d.ts:5 (opens new window)


# parse

parse(value: any, format?: TimeUnit): 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? TimeUnit -

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:

Name Type Description
timestamp number the input timestamp
unit millisecond | second | minute | hour | day | week | month | quarter | year | isoWeek the unit as string
weekday? number -

Returns: number

Defined in: adapters.d.ts:51 (opens new window)