Wrap MessageFunction source, locales args in one object, adding dir (#38

)
tc39 · Jan 8, 2024 · 1243189 · 1243189
1 parent 0e2e2e7
commit 1243189
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -403,13 +403,22 @@ to complement or replace the default ones.
 
 ```ts
 type MessageFunction = (
-  source: string,
-  locales: string[],
+  msgCtx: MessageFunctionContext,
   options: { [key: string]: unknown },
   input?: unknown
 ) => MessageValue;
+
+interface MessageFunctionContext {
+  locales: string[];
+  dir: 'ltr' | 'rtl' | 'auto';
+  source: string;
+}
 ```
 
+The `msgCtx` value defines the context in which the expression is being resolved,
+with the `locales` and `dir` of the whole message
+as well as the `source` fallback string representation of the expression.
+
 The `input` and `options` values are constructed as follows:
 
 - If the value is a literal defined in the message syntax,