Bluestep JS Documentation
    Preparing search index...

    Interface TemporalField

    A field of date-time, such as month-of-year or hour-of-minute.

    See java.time.temporal for full documentation

    interface TemporalField {
        addTo<R extends Temporal>(temporal: R, amount: number): R;
        between(temporal1Inclusive: Temporal, temporal2Exclusive: Temporal): number;
        getDuration(): Duration;
        isDateBased(): boolean;
        isDurationEstimated(): boolean;
        isSupportedBy(temporal: Temporal): boolean;
        isTimeBased(): boolean;
    }
    Index

    Methods

    addTo between getDuration isDateBased isDurationEstimated isSupportedBy isTimeBased

    Methods

    • Returns a copy of the specified temporal object with the specified period added.

      Type Parameters

      Parameters

      • temporal: R
      • amount: number

      Returns R

    • Calculates the amount of time between two temporal objects.

      Parameters

      Returns number

    • Gets the duration of this unit, which may be an estimate.

      Returns Duration

    • Checks if this unit represents a component of a date.

      Returns boolean

    • Checks if the duration of the unit is an estimate.

      Returns boolean

    • Checks if this unit is supported by the specified temporal object.

      Parameters

      Returns boolean

    • Checks if this unit represents a component of a time.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Methods