Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MessageFunction<Values>

Type parameters

  • Values: object | void

    An object type that describes values of the message arguments or void if there's no arguments.

Hierarchy

  • MessageFunction

Callable

  • MessageFunction<Result>(runtime: IRuntime<Result>, locale: string, values: Values): string | Result
  • A function that renders a message using runtime. Compiler produces functions of this type.

    Type parameters

    • Result

      The type of the rendering result.

    Parameters

    • runtime: IRuntime<Result>

      The runtime that provides methods to render the message.

    • locale: string

      The locale that defines what translation is used.

    • values: Values

      The ICU argument values.

    Returns string | Result

    The rendered message translation.

Index

Properties

Properties

Optional displayName

displayName: string

Generated using TypeDoc