Intl.RelativeTimeFormat.prototype.formatToParts()

The Intl.RelativeTimeFormat.prototype.formatToParts() method returns an Array of objects representing the relative time format in parts that can be used for custom locale-aware formatting.

Syntax

RelativeTimeFormat.formatToParts(value, unit)

Parameters

value
Numeric value to use in the internationalized relative time message.
unit
Unit to use in the relative time internationalized message. Possible values are: "year", "quarter", "month", "week", "day", "hour", "minute", "second". Plural forms are also permitted.

Return value

An Array of objects containing the formatted relative time in parts.

Description

The  Intl.RelativeTimeFormat.prototype.formatToParts method is a version of the format method which it returns an array of objects which represent "parts" of the object, separating the formatted number into its consituent parts and separating it from other surrounding text. These objects have two properties: type a NumberFormat formatToParts type, and value, which is the String which is the component of the output. If a "part" came from NumberFormat, it will have a unit property which indicates the unit being formatted; literals which are part of the larger frame will not have this property.

Examples

const rtf = new Intl.RelativeTimeFormat("en", { numeric: "auto" });

// Format relative time using the day unit
rtf.formatToParts(-1, "day");
// > [{ type: "literal", value: "yesterday"}]

rtf.formatToParts(100, "day");
// > [{ type: "literal", value: "in " }, 
// >  { type: "integer", value: "100", unit: "day" }, 
// >  { type: "literal", value: " days" }]

Specifications

Specification Status Comment
Intl.RelativeTime proposal Stage 3  

Browser compatibility

Update compatibility data on GitHub
Desktop Mobile Server
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet Node.js
formatToParts Chrome Full support 71 Edge No support No Firefox Full support 70 IE No support No Opera Full support 58 Safari No support No WebView Android Full support 71 Chrome Android Full support 71 Firefox Android No support No Opera Android Full support 50 Safari iOS No support No Samsung Internet Android Full support 10.0 nodejs Full support 12.0.0

Legend

Full support  
Full support
No support  
No support

See also

  1. Standard built-in objects
  2. RelativeTimeFormat
  3. Properties
    1. Intl.RelativeTimeFormat.prototype
  4. Methods
    1. Intl.RelativeTimeFormat.prototype.format()
    2. Intl.RelativeTimeFormat.prototype.formatToParts()
    3. Intl.RelativeTimeFormat.prototype.resolvedOptions()
    4. Intl.RelativeTimeFormat.supportedLocalesOf()
  5. Related pages:
  6. Intl
  7. Collator
  8. DateTimeFormat
  9. ListFormat
  10. NumberFormat
  11. PluralRules
  12. Inheritance:
  13. Function
  14. Properties
    1. Function.arguments
    2. Function.arity
    3. Function.caller
    4. Function.displayName
    5. Function.length
    6. Function.name
    7. Function.prototype
  15. Methods
    1. Function.prototype.apply()
    2. Function.prototype.bind()
    3. Function.prototype.call()
    4. Function.prototype.isGenerator()
    5. Function.prototype.toSource()
    6. Function.prototype.toString()
  16. Object
  17. Properties
    1. Object.prototype.__count__
    2. Object.prototype.__noSuchMethod__
    3. Object.prototype.__parent__
    4. Object.prototype.__proto__
    5. Object.prototype.constructor
  18. Methods
    1. Object.prototype.__defineGetter__()
    2. Object.prototype.__defineSetter__()
    3. Object.prototype.__lookupGetter__()
    4. Object.prototype.__lookupSetter__()
    5. Object.prototype.hasOwnProperty()
    6. Object.prototype.isPrototypeOf()
    7. Object.prototype.propertyIsEnumerable()
    8. Object.prototype.toLocaleString()
    9. Object.prototype.toSource()
    10. Object.prototype.toString()
    11. Object.prototype.unwatch()
    12. Object.prototype.valueOf()
    13. Object.prototype.watch()
    14. Object.setPrototypeOf()