Class Translate

constructor

• new Translate(locale?, transform?, config?): Translate

• Constructs a new instance of the Translator class.

  Parameters

  • Optionallocale: Locale = {}

    An object representing the initial locale configuration.
  • Optionaltransform: ((str: string) => string)

    A function for transforming strings.

    • • (str): string

      • Parameters

        • str: string

        Returns string

  • Optionalconfig: Partial<ITranslateConfig> = {}

    An object representing additional configuration options.

  Returns Translate

Readonlyconfig

createElement

translateText

skipList

• get skipList(): string[]

• Returns string[]

clear

• clear(): void

• Clear the _skip and _transformed variables.

  Returns void

  Function

jss

• jss(type, props): ReactElement<{}, string | JSXElementConstructor<any>>

• Create an element using the given type and props

  Parameters

  • type: string

    The type of the element
  • props: null | IAttributeCollection

    The props for the element

  Returns ReactElement<{}, string | JSXElementConstructor<any>>

  • The created element

use

• use(middleware): void

• Adds a middleware to the list of used middlewares.

  Parameters

  • middleware: Middleware

    The middleware to be added.

  Returns void

Staticinstall

• install(...params): Translate

• Installs the Translate object and configures React.

  Parameters

  • Rest...params: [locale: Locale, transform?: ((str: string) => string), config: Partial<ITranslateConfig>]

    The parameters needed to create a new Translate instance.

  Returns Translate

  The installed Translate object.