神岛 API 文档 - ArenaPro版
    Preparing search index...

    Interface RelativeTimeFormat

    interface RelativeTimeFormat {
        format(value: number, unit: RelativeTimeFormatUnit): string;
        formatToParts(
            value: number,
            unit: RelativeTimeFormatUnit,
        ): RelativeTimeFormatPart[];
        resolvedOptions(): ResolvedRelativeTimeFormatOptions;
    }
    Index

    Methods

    • Formats a value and a unit according to the locale and formatting options of the given Intl.RelativeTimeFormat object.

      While this method automatically provides the correct plural forms, the grammatical form is otherwise as neutral as possible.

      It is the caller's responsibility to handle cut-off logic such as deciding between displaying "in 7 days" or "in 1 week". This API does not support relative dates involving compound units. e.g "in 5 days and 4 hours".

      Parameters

      • value: number

        Numeric value to use in the internationalized relative time message

      • unit: RelativeTimeFormatUnit

        Unit to use in the relative time internationalized message.

      Returns string

      Internationalized relative time message as string

      MDN.

      RangeError if unit was given something other than unit possible values

    • Returns an array of objects representing the relative time format in parts that can be used for custom locale-aware formatting.

      Parameters

      • value: number

        Numeric value to use in the internationalized relative time message

      • unit: RelativeTimeFormatUnit

        Unit to use in the relative time internationalized message.

      Returns RelativeTimeFormatPart[]

      RangeError if unit was given something other than unit possible values

      MDN.