Class Instant

An instantaneous point on the time-line.

See java.time.Instant for full documentation

Constructors

constructor

new Instant(): Instant
Returns Instant

Methods

adjustInto

adjustInto(temporal: Temporal): Temporal
Adjusts the specified temporal object to have this instant.
Parameters
- temporal: Temporal
Returns Temporal
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1786

atOffset

atOffset(offset: ZoneOffset): OffsetDateTime
Combines this instant with an offset to create an OffsetDateTime.
Parameters
- offset: ZoneOffset
Returns OffsetDateTime
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1790

atZone

atZone(zone: ZoneId): ZonedDateTime
Combines this instant with a time-zone to create a ZonedDateTime.
Parameters
- zone: ZoneId
Returns ZonedDateTime
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1794

compareTo

compareTo(otherInstant: Instant): number
Compares this instant to the specified instant.
Parameters
- otherInstant: Instant
Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1782

get

get(field: TemporalField): number
Gets the value of the specified field from this instant as an int.
Parameters
- field: TemporalField
Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1798

getEpochSecond

getEpochSecond(): number
Gets the number of seconds from the Java epoch of 1970-01-01T00:00:00Z.

Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1802

getLong

getLong(field: TemporalField): number
Gets the value of the specified field from this instant as a long.
Parameters
- field: TemporalField
Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1806

getNano

getNano(): number
Gets the number of nanoseconds, later along the time-line, from the start of the second.

Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1810

isAfter

isAfter(otherInstant: Instant): boolean
Checks if this instant is after the specified instant.
Parameters
- otherInstant: Instant
Returns boolean
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1814

isBefore

isBefore(otherInstant: Instant): boolean
Checks if this instant is before the specified instant.
Parameters
- otherInstant: Instant
Returns boolean
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1818

isSupported

isSupported(field: TemporalField): boolean
Checks if the specified field is supported.
Parameters
- field: TemporalField
Returns boolean
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1823
isSupported(unit: TemporalUnit): boolean
Checks if the specified unit is supported.
Parameters
- unit: TemporalUnit
Returns boolean
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1827

minus

minus(amountToSubtract: number, unit: TemporalUnit): Instant
Returns a copy of this instant with the specified amount subtracted.
Parameters
- amountToSubtract: number
- unit: TemporalUnit
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1831
minus(amountToSubtract: TemporalAmount): Instant
Returns a copy of this instant with the specified amount subtracted.
Parameters
- amountToSubtract: TemporalAmount
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1835

minusMillis

minusMillis(millisToSubtract: number): Instant
Returns a copy of this instant with the specified duration in milliseconds subtracted.
Parameters
- millisToSubtract: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1839

minusNanos

minusNanos(nanosToSubtract: number): Instant
Returns a copy of this instant with the specified duration in nanoseconds subtracted.
Parameters
- nanosToSubtract: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1843

minusSeconds

minusSeconds(secondsToSubtract: number): Instant
Returns a copy of this instant with the specified duration in seconds subtracted.
Parameters
- secondsToSubtract: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1847

plus

plus(amountToAdd: number, unit: TemporalUnit): Instant
Returns a copy of this instant with the specified amount added.
Parameters
- amountToAdd: number
- unit: TemporalUnit
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1851
plus(amountToAdd: TemporalAmount): Instant
Returns a copy of this instant with the specified amount added.
Parameters
- amountToAdd: TemporalAmount
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1855

plusMillis

plusMillis(millisToAdd: number): Instant
Returns a copy of this instant with the specified duration in milliseconds added.
Parameters
- millisToAdd: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1859

plusNanos

plusNanos(nanosToAdd: number): Instant
Returns a copy of this instant with the specified duration in nanoseconds added.
Parameters
- nanosToAdd: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1863

plusSeconds

plusSeconds(secondsToAdd: number): Instant
Returns a copy of this instant with the specified duration in seconds added.
Parameters
- secondsToAdd: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1867

query

query<R>(query: TemporalQueryFn<R>): R
Queries this instant using the specified query.
Type Parameters
- R
Parameters
- query: TemporalQueryFn<R>
Returns R
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1871

range

range(field: TemporalField): ValueRange
Gets the range of valid values for the specified field.
Parameters
- field: TemporalField
Returns ValueRange
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1875

toEpochMilli

toEpochMilli(): number
Converts this instant to the number of milliseconds from the epoch of 1970-01-01T00:00:00Z.

Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1879

truncatedTo

truncatedTo(unit: TemporalUnit): Instant
Returns a copy of this Instant truncated to the specified unit.
Parameters
- unit: TemporalUnit
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1883

until

until(endExclusive: Temporal, unit: TemporalUnit): number
Calculates the amount of time until another instant in terms of the specified unit.
Parameters
- endExclusive: Temporal
- unit: TemporalUnit
Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1887

with

with(adjuster: TemporalAdjusterFn): Instant
Returns an adjusted copy of this instant.
Parameters
- adjuster: TemporalAdjusterFn
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1891
with(field: TemporalField, newValue: number): Instant
Returns a copy of this instant with the specified field set to a new value.
Parameters
- field: TemporalField
- newValue: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1895

`Static`from

from(temporal: TemporalAccessor): Instant
Obtains an instance of Instant from a temporal object.
Parameters
- temporal: TemporalAccessor
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1757

`Static`now

now(clock?: Clock): Instant
Obtains the current instant from the system clock.
Parameters
- Optionalclock: Clock
  When present it will return current instant from specified clock
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1762

`Static`ofEpochMilli

ofEpochMilli(epochMilli: number): Instant
Obtains an instance of Instant using milliseconds from the epoch of 1970-01-01T00:00:00Z.
Parameters
- epochMilli: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1766

`Static`ofEpochSecond

ofEpochSecond(epochSecond: number): Instant
Obtains an instance of Instant using seconds from the epoch of 1970-01-01T00:00:00Z.
Parameters
- epochSecond: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1770
ofEpochSecond(epochSecond: number, nanoAdjustment: number): Instant
Obtains an instance of Instant using seconds from the epoch of 1970-01-01T00:00:00Z and nanosecond fraction of second.
Parameters
- epochSecond: number
- nanoAdjustment: number
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1774

`Static`parse

parse(text: string): Instant
Obtains an instance of Instant from a text string such as 2007-12-03T10:15:30.00Z.
Parameters
- text: string
Returns Instant
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:1778

Class Instant

Index

Constructors

Methods

Constructors

constructor

Returns Instant

Methods

adjustInto

Parameters

Returns Temporal

atOffset

Parameters

Returns OffsetDateTime

atZone

Parameters

Returns ZonedDateTime

compareTo

Parameters

Returns number

get

Parameters

Returns number

getEpochSecond

Returns number

getLong

Parameters

Returns number

getNano

Returns number

isAfter

Parameters

Returns boolean

isBefore

Parameters

Returns boolean

isSupported

Parameters

Returns boolean

Parameters

Returns boolean

minus

Parameters

Returns Instant

Parameters

Returns Instant

minusMillis

Parameters

Returns Instant

minusNanos

Parameters

Returns Instant

minusSeconds

Parameters

Returns Instant

plus

Parameters

Returns Instant

Parameters

Returns Instant

plusMillis

Parameters

Returns Instant

plusNanos

Parameters

Returns Instant

plusSeconds

Parameters

Returns Instant

query

Type Parameters

Parameters

Returns R

range

Parameters

Returns ValueRange

toEpochMilli

Returns number

truncatedTo

Parameters

`Static`from

`Static`now

`Static`ofEpochMilli

`Static`ofEpochSecond

`Static`parse