react-intl 4.2.0 → 4.3.1

package/dist/types.d.ts

@@ -29,7 +29,7 @@ export declare type FormatRelativeTimeOptions = Exclude<IntlRelativeTimeFormatOp
 export declare type FormatPluralOptions = Exclude<Intl.PluralRulesOptions, 'localeMatcher'> & CustomFormatConfig;
 export declare type FormatListOptions = Exclude<IntlListFormatOptions, 'localeMatcher'>;
 export declare type FormatDisplayNameOptions = Exclude<DisplayNamesOptions, 'localeMatcher'>;
-export interface IntlFormatters<T = React.ReactNode> {
+export interface IntlFormatters<T = React.ReactNode, R = T> {
     formatDate(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): string;
     formatTime(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): string;
     formatDateToParts(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): Intl.DateTimeFormatPart[];
@@ -39,7 +39,7 @@ export interface IntlFormatters<T = React.ReactNode> {
     formatNumberToParts(value: Parameters<Intl.NumberFormat['format']>[0], opts?: FormatNumberOptions): Intl.NumberFormatPart[];
     formatPlural(value: Parameters<Intl.PluralRules['select']>[0], opts?: FormatPluralOptions): ReturnType<Intl.PluralRules['select']>;
     formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType>): string;
-    formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>): string | React.ReactNodeArray;
+    formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T, R>>): string | React.ReactNodeArray;
     formatList(values: Array<string>, opts?: FormatListOptions): string;
     formatList(values: Array<string | React.ReactNode>, opts?: FormatListOptions): React.ReactNode;
     formatDisplayName(value: Parameters<DisplayNames['of']>[0], opts?: FormatDisplayNameOptions): string | undefined;

package/lib/components/message.d.ts

@@ -6,7 +6,7 @@ export interface Props<V extends Record<string, any> = Record<string, React.Reac
     tagName?: React.ElementType<any>;
     children?(...nodes: React.ReactNodeArray): React.ReactNode;
 }
-declare class FormattedMessage<T = React.ReactNode, V extends Record<string, any> = Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>> extends React.Component<Props<V>> {
+declare class FormattedMessage<V extends Record<string, any> = Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<React.ReactNode, React.ReactNode>>> extends React.Component<Props<V>> {
     static displayName: string;
     static defaultProps: {
         values: {};

package/lib/error.d.ts

@@ -1,3 +1,4 @@
+import { MessageDescriptor } from "./types";
 export declare const enum ReactIntlErrorCode {
     FORMAT_ERROR = "FORMAT_ERROR",
     UNSUPPORTED_FORMATTER = "UNSUPPORTED_FORMATTER",
@@ -6,6 +7,7 @@ export declare const enum ReactIntlErrorCode {
     MISSING_TRANSLATION = "MISSING_TRANSLATION"
 }
 export declare class ReactIntlError extends Error {
-    code: ReactIntlErrorCode;
-    constructor(code: ReactIntlErrorCode, message: string, exception?: Error);
+    readonly code: ReactIntlErrorCode;
+    readonly descriptor?: MessageDescriptor;
+    constructor(code: ReactIntlErrorCode, message: string, descriptor?: MessageDescriptor, exception?: Error);
 }

package/lib/error.js

@@ -1,7 +1,16 @@
+export var ReactIntlErrorCode;
+(function (ReactIntlErrorCode) {
+    ReactIntlErrorCode["FORMAT_ERROR"] = "FORMAT_ERROR";
+    ReactIntlErrorCode["UNSUPPORTED_FORMATTER"] = "UNSUPPORTED_FORMATTER";
+    ReactIntlErrorCode["INVALID_CONFIG"] = "INVALID_CONFIG";
+    ReactIntlErrorCode["MISSING_DATA"] = "MISSING_DATA";
+    ReactIntlErrorCode["MISSING_TRANSLATION"] = "MISSING_TRANSLATION";
+})(ReactIntlErrorCode || (ReactIntlErrorCode = {}));
 export class ReactIntlError extends Error {
-    constructor(code, message, exception) {
+    constructor(code, message, descriptor, exception) {
         super(`[React Intl Error ${code}] ${message} ${exception ? `\n${exception.stack}` : ''}`);
         this.code = code;
+        this.descriptor = descriptor;
         if (typeof Error.captureStackTrace === 'function') {
             Error.captureStackTrace(this, ReactIntlError);
         }

package/lib/formatters/displayName.js

@@ -12,7 +12,7 @@ export function formatDisplayName({ locale, onError }, getDisplayNames, value, o
     if (!DisplayNames) {
         onError(new FormatError(`Intl.DisplayNames is not available in this environment.
 Try polyfilling it using "@formatjs/intl-displaynames"
-`, 2 /* MISSING_INTL_API */));
+`, "MISSING_INTL_API" /* MISSING_INTL_API */));
     }
     const filteredOptions = filterProps(options, DISPLAY_NAMES_OPTONS);
     try {

package/lib/formatters/list.js

@@ -15,7 +15,7 @@ export function formatList({ locale, onError }, getListFormat, values, options =
     if (!ListFormat) {
         onError(new FormatError(`Intl.ListFormat is not available in this environment.
 Try polyfilling it using "@formatjs/intl-listformat"
-`, 2 /* MISSING_INTL_API */));
+`, "MISSING_INTL_API" /* MISSING_INTL_API */));
     }
     const filteredOptions = filterProps(options, LIST_FORMAT_OPTIONS);
     try {

package/lib/formatters/message.js

@@ -47,7 +47,7 @@ export function formatMessage({ locale, formats, messages, defaultLocale, defaul
         }
         catch (e) {
             onError(new ReactIntlError("FORMAT_ERROR" /* FORMAT_ERROR */, `Error formatting message: "${id}" for locale: "${locale}"` +
-                (defaultMessage ? ', using default message as fallback.' : ''), e));
+                (defaultMessage ? ', using default message as fallback.' : ''), messageDescriptor, e));
         }
     }
     else if (!defaultMessage ||
@@ -56,7 +56,7 @@ export function formatMessage({ locale, formats, messages, defaultLocale, defaul
         // when no `messages` are passed into the <IntlProvider> for the
         // default locale.
         onError(new ReactIntlError("MISSING_TRANSLATION" /* MISSING_TRANSLATION */, `Missing message: "${id}" for locale: "${locale}"` +
-            (defaultMessage ? ', using default message as fallback.' : '')));
+            (defaultMessage ? ', using default message as fallback.' : ''), messageDescriptor));
     }
     if (!formattedMessageParts && defaultMessage) {
         try {
@@ -64,12 +64,12 @@ export function formatMessage({ locale, formats, messages, defaultLocale, defaul
             formattedMessageParts = formatter.format(values);
         }
         catch (e) {
-            onError(new ReactIntlError("FORMAT_ERROR" /* FORMAT_ERROR */, `Error formatting the default message for: "${id}"`, e));
+            onError(new ReactIntlError("FORMAT_ERROR" /* FORMAT_ERROR */, `Error formatting the default message for: "${id}"`, messageDescriptor, e));
         }
     }
     if (!formattedMessageParts) {
         onError(new ReactIntlError("FORMAT_ERROR" /* FORMAT_ERROR */, `Cannot format message: "${id}", ` +
-            `using message ${message || defaultMessage ? 'source' : 'id'} as fallback.`));
+            `using message ${message || defaultMessage ? 'source' : 'id'} as fallback.`, messageDescriptor));
         if (typeof message === 'string') {
             return message || defaultMessage || String(id);
         }

package/lib/formatters/plural.js

@@ -9,7 +9,7 @@ export function formatPlural({ locale, onError }, getPluralRules, value, options
     if (!Intl.PluralRules) {
         onError(new FormatError(`Intl.PluralRules is not available in this environment.
 Try polyfilling it using "@formatjs/intl-pluralrules"
-`, 2 /* MISSING_INTL_API */));
+`, "MISSING_INTL_API" /* MISSING_INTL_API */));
     }
     const filteredOptions = filterProps(options, PLURAL_FORMAT_OPTIONS);
     try {

package/lib/formatters/relativeTime.js

@@ -19,7 +19,7 @@ export function formatRelativeTime(config, getRelativeTimeFormat, value, unit, o
     if (!RelativeTimeFormat) {
         config.onError(new FormatError(`Intl.RelativeTimeFormat is not available in this environment.
 Try polyfilling it using "@formatjs/intl-relativetimeformat"
-`, 2 /* MISSING_INTL_API */));
+`, "MISSING_INTL_API" /* MISSING_INTL_API */));
     }
     try {
         return getFormatter(config, getRelativeTimeFormat, options).format(value, unit);

package/lib/index.js

@@ -18,4 +18,4 @@ export { default as FormattedRelativeTime } from './components/relative';
 export { default as FormattedPlural } from './components/plural';
 export { default as FormattedMessage } from './components/message';
 export { createIntlCache } from './utils';
-export { ReactIntlError } from './error';
+export { ReactIntlError, ReactIntlErrorCode } from './error';

package/lib/react-intl.d.ts

@@ -65,7 +65,7 @@ export declare const FormattedList: React.FC<IntlListFormatOptions & {
     value: React.ReactNode[];
 }>;
 
-export declare class FormattedMessage<T = React.ReactNode, V extends Record<string, any> = Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>> extends React.Component<Props_3<V>> {
+export declare class FormattedMessage<V extends Record<string, any> = Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<React.ReactNode, React.ReactNode>>> extends React.Component<Props_3<V>> {
     static displayName: string;
     static defaultProps: {
         values: {};
@@ -162,7 +162,7 @@ export declare interface IntlConfig {
 
 export declare const IntlContext: React.Context<IntlShape>;
 
-export declare interface IntlFormatters<T = React.ReactNode> {
+export declare interface IntlFormatters<T = React.ReactNode, R = T> {
     formatDate(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): string;
     formatTime(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): string;
     formatDateToParts(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): Intl.DateTimeFormatPart[];
@@ -172,7 +172,7 @@ export declare interface IntlFormatters<T = React.ReactNode> {
     formatNumberToParts(value: Parameters<Intl.NumberFormat['format']>[0], opts?: FormatNumberOptions): Intl.NumberFormatPart[];
     formatPlural(value: Parameters<Intl.PluralRules['select']>[0], opts?: FormatPluralOptions): ReturnType<Intl.PluralRules['select']>;
     formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType>): string;
-    formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>): string | React.ReactNodeArray;
+    formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T, R>>): string | React.ReactNodeArray;
     formatList(values: Array<string>, opts?: FormatListOptions): string;
     formatList(values: Array<string | React.ReactNode>, opts?: FormatListOptions): React.ReactNode;
     formatDisplayName(value: Parameters<DisplayNames['of']>[0], opts?: FormatDisplayNameOptions): string | undefined;
@@ -235,8 +235,9 @@ declare interface Props_3<V extends Record<string, any> = Record<string, React.R
 export declare const RawIntlProvider: React.Provider<IntlShape>;
 
 export declare class ReactIntlError extends Error {
-    code: ReactIntlErrorCode;
-    constructor(code: ReactIntlErrorCode, message: string, exception?: Error);
+    readonly code: ReactIntlErrorCode;
+    readonly descriptor?: MessageDescriptor;
+    constructor(code: ReactIntlErrorCode, message: string, descriptor?: MessageDescriptor, exception?: Error);
 }
 
 export declare const enum ReactIntlErrorCode {

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.7.10"
+      "packageVersion": "7.7.11"
     }
   ]
 }

package/lib/types.d.ts

@@ -29,7 +29,7 @@ export declare type FormatRelativeTimeOptions = Exclude<IntlRelativeTimeFormatOp
 export declare type FormatPluralOptions = Exclude<Intl.PluralRulesOptions, 'localeMatcher'> & CustomFormatConfig;
 export declare type FormatListOptions = Exclude<IntlListFormatOptions, 'localeMatcher'>;
 export declare type FormatDisplayNameOptions = Exclude<DisplayNamesOptions, 'localeMatcher'>;
-export interface IntlFormatters<T = React.ReactNode> {
+export interface IntlFormatters<T = React.ReactNode, R = T> {
     formatDate(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): string;
     formatTime(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): string;
     formatDateToParts(value: Parameters<Intl.DateTimeFormat['format']>[0] | string, opts?: FormatDateOptions): Intl.DateTimeFormatPart[];
@@ -39,7 +39,7 @@ export interface IntlFormatters<T = React.ReactNode> {
     formatNumberToParts(value: Parameters<Intl.NumberFormat['format']>[0], opts?: FormatNumberOptions): Intl.NumberFormatPart[];
     formatPlural(value: Parameters<Intl.PluralRules['select']>[0], opts?: FormatPluralOptions): ReturnType<Intl.PluralRules['select']>;
     formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType>): string;
-    formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T>>): string | React.ReactNodeArray;
+    formatMessage(descriptor: MessageDescriptor, values?: Record<string, PrimitiveType | React.ReactElement | FormatXMLElementFn<T, R>>): string | React.ReactNodeArray;
     formatList(values: Array<string>, opts?: FormatListOptions): string;
     formatList(values: Array<string | React.ReactNode>, opts?: FormatListOptions): React.ReactNode;
     formatDisplayName(value: Parameters<DisplayNames['of']>[0], opts?: FormatDisplayNameOptions): string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-intl",
-  "version": "4.2.0",
+  "version": "4.3.1",
   "description": "Internationalize React apps. This library provides React components and an API to format dates, numbers, and strings, including pluralization and handling translations.",
   "keywords": [
     "intl",
@@ -140,7 +140,7 @@
     "@types/invariant": "^2.2.31",
     "hoist-non-react-statics": "^3.3.2",
     "intl-format-cache": "^4.2.22",
-    "intl-messageformat": "^8.2.2",
+    "intl-messageformat": "^8.3.2",
     "intl-messageformat-parser": "^4.1.1",
     "shallow-equal": "^1.2.1"
   },
@@ -153,19 +153,19 @@
     "@babel/plugin-proposal-class-properties": "^7.8.3",
     "@babel/plugin-transform-modules-commonjs": "^7.9.0",
     "@babel/preset-env": "^7.9.0",
-    "@babel/preset-react": "^7.9.1",
+    "@babel/preset-react": "^7.9.4",
     "@formatjs/intl-pluralrules": "^1.5.3",
-    "@microsoft/api-documenter": "^7.7.14",
-    "@microsoft/api-extractor": "^7.7.10",
+    "@microsoft/api-documenter": "^7.7.15",
+    "@microsoft/api-extractor": "^7.7.11",
     "@types/benchmark": "^1.0.31",
     "@types/enzyme": "^3.10.5",
     "@types/jest": "^25.1.4",
     "@types/prop-types": "^15.7.3",
-    "@types/react": "^16.9.25",
+    "@types/react": "^16.9.26",
     "@types/react-dom": "^16.9.5",
-    "@typescript-eslint/eslint-plugin": "^2.24.0",
-    "@typescript-eslint/parser": "^2.24.0",
-    "babel-jest": "^25.1.0",
+    "@typescript-eslint/eslint-plugin": "^2.25.0",
+    "@typescript-eslint/parser": "^2.25.0",
+    "babel-jest": "^25.2.3",
     "benchmark": "^2.1.4",
     "core-js": "^3.6.4",
     "cross-env": "^7.0.2",
@@ -177,7 +177,7 @@
     "fs-extra": "^9.0.0",
     "full-icu": "^1.3.1",
     "glob": "^7.1.6",
-    "jest": "^25.1.0",
+    "jest": "^25.2.3",
     "markdown-toc": "^1.2.0",
     "mkdirp": "^1.0.3",
     "parcel": "^1.12.4",
@@ -186,7 +186,7 @@
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
     "rimraf": "^3.0.2",
-    "rollup": "^2.1.0",
+    "rollup": "^2.2.0",
     "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-commonjs": "^10.1.0",
     "rollup-plugin-node-resolve": "^5.2.0",
@@ -195,9 +195,9 @@
     "rollup-plugin-uglify": "^6.0.4",
     "standard-version": "^7.1.0",
     "ts-jest": "^25.2.1",
-    "ts-node": "^8.7.0",
+    "ts-node": "^8.8.1",
     "tslib": "^1.11.1",
-    "typescript": "^3.8.3"
+    "typescript": "3.8"
   },
   "scripts": {
     "benchmark": "cross-env NODE_ENV=production TS_NODE_PROJECT=./tsconfig.cjs.json ts-node test/perf/index.tsx",

package/src/components/message.tsx

@@ -22,7 +22,7 @@ function defaultFormatMessage<T = React.ReactNode>(
   descriptor: MessageDescriptor,
   values?: Record<
     string,
-    PrimitiveType | React.ReactElement | FormatXMLElementFn<T>
+    PrimitiveType | React.ReactElement | FormatXMLElementFn<T, T>
   >
 ): string {
   if (process.env.NODE_ENV !== 'production') {
@@ -51,10 +51,11 @@ export interface Props<
 }
 
 class FormattedMessage<
-  T = React.ReactNode,
   V extends Record<string, any> = Record<
     string,
-    PrimitiveType | React.ReactElement | FormatXMLElementFn<T>
+    | PrimitiveType
+    | React.ReactElement
+    | FormatXMLElementFn<React.ReactNode, React.ReactNode>
   >
 > extends React.Component<Props<V>> {
   static displayName = 'FormattedMessage';

package/src/error.ts

@@ -1,3 +1,5 @@
+import { MessageDescriptor } from "./types"
+
 export const enum ReactIntlErrorCode {
     FORMAT_ERROR = 'FORMAT_ERROR',
     UNSUPPORTED_FORMATTER = 'UNSUPPORTED_FORMATTER',
@@ -7,10 +9,12 @@ export const enum ReactIntlErrorCode {
 }
 
 export class ReactIntlError extends Error {
-    public code: ReactIntlErrorCode
-    constructor(code: ReactIntlErrorCode, message: string, exception?: Error) {
+    public readonly code: ReactIntlErrorCode
+    public readonly descriptor?: MessageDescriptor
+    constructor(code: ReactIntlErrorCode, message: string, descriptor?: MessageDescriptor, exception?: Error) {
         super(`[React Intl Error ${code}] ${message} ${exception ? `\n${exception.stack}` : ''}`)
         this.code = code
+        this.descriptor = descriptor
         if (typeof Error.captureStackTrace === 'function') {
             Error.captureStackTrace(this, ReactIntlError)
         }

package/src/formatters/message.ts

@@ -72,8 +72,8 @@ function deepMergeFormatsAndSetTimeZone(
   };
 }
 
-function prepareIntlMessageFormatHtmlOutput<T>(
-  chunks: (string | T)[]
+function prepareIntlMessageFormatHtmlOutput(
+  chunks: React.ReactNodeArray
 ): React.ReactElement {
   return React.createElement(React.Fragment, null, ...chunks);
 }
@@ -99,7 +99,7 @@ export function formatMessage(
   messageDescriptor?: MessageDescriptor,
   values?: Record<string, PrimitiveType>
 ): string;
-export function formatMessage<T>(
+export function formatMessage(
   {
     locale,
     formats,
@@ -125,14 +125,9 @@ export function formatMessage<T>(
   values:
     | Record<
         string,
-        | string
-        | number
-        | boolean
+        | React.ReactNode
         | Date
-        | T
-        | FormatXMLElementFn<T>
-        | null
-        | undefined
+        | FormatXMLElementFn<React.ReactNode, React.ReactNode>
       >
     | undefined = {}
 ): React.ReactNode {
@@ -144,7 +139,7 @@ export function formatMessage<T>(
   formats = deepMergeFormatsAndSetTimeZone(formats, timeZone);
   defaultFormats = deepMergeFormatsAndSetTimeZone(defaultFormats, timeZone);
 
-  let formattedMessageParts: string | T | (string | T)[] = '';
+  let formattedMessageParts: React.ReactNode = '';
 
   if (message) {
     try {
@@ -152,13 +147,14 @@ export function formatMessage<T>(
         formatters: state,
       });
 
-      formattedMessageParts = formatter.format(values);
+      formattedMessageParts = formatter.format<React.ReactNode>(values);
     } catch (e) {
       onError(
         new ReactIntlError(
           ReactIntlErrorCode.FORMAT_ERROR,
           `Error formatting message: "${id}" for locale: "${locale}"` +
             (defaultMessage ? ', using default message as fallback.' : ''),
+          messageDescriptor,
           e
         )
       );
@@ -174,7 +170,8 @@ export function formatMessage<T>(
       new ReactIntlError(
         ReactIntlErrorCode.MISSING_TRANSLATION,
         `Missing message: "${id}" for locale: "${locale}"` +
-          (defaultMessage ? ', using default message as fallback.' : '')
+          (defaultMessage ? ', using default message as fallback.' : ''),
+        messageDescriptor
       )
     );
   }
@@ -193,6 +190,7 @@ export function formatMessage<T>(
         new ReactIntlError(
           ReactIntlErrorCode.FORMAT_ERROR,
           `Error formatting the default message for: "${id}"`,
+          messageDescriptor,
           e
         )
       );
@@ -206,7 +204,8 @@ export function formatMessage<T>(
         `Cannot format message: "${id}", ` +
           `using message ${
             message || defaultMessage ? 'source' : 'id'
-          } as fallback.`
+          } as fallback.`,
+        messageDescriptor
       )
     );
     if (typeof message === 'string') {
@@ -216,11 +215,9 @@ export function formatMessage<T>(
   }
   if (Array.isArray(formattedMessageParts)) {
     if (wrapRichTextChunksInFragment) {
-      return prepareIntlMessageFormatHtmlOutput<T>(
-        formattedMessageParts as Array<string | T>
-      );
+      return prepareIntlMessageFormatHtmlOutput(formattedMessageParts);
     }
     return formattedMessageParts;
   }
-  return formattedMessageParts as string | T;
+  return formattedMessageParts as React.ReactNode;
 }

package/src/types.ts

@@ -67,7 +67,7 @@ export type FormatDisplayNameOptions = Exclude<
   'localeMatcher'
 >;
 
-export interface IntlFormatters<T = React.ReactNode> {
+export interface IntlFormatters<T = React.ReactNode, R = T> {
   formatDate(
     value: Parameters<Intl.DateTimeFormat['format']>[0] | string,
     opts?: FormatDateOptions
@@ -109,7 +109,7 @@ export interface IntlFormatters<T = React.ReactNode> {
     descriptor: MessageDescriptor,
     values?: Record<
       string,
-      PrimitiveType | React.ReactElement | FormatXMLElementFn<T>
+      PrimitiveType | React.ReactElement | FormatXMLElementFn<T, R>
     >
   ): string | React.ReactNodeArray;
   formatList(values: Array<string>, opts?: FormatListOptions): string;