Translator: create() static method

{{APIRef("Translator and Language Detector APIs")}}{{SeeCompatTable}}{{securecontext_header}}

The create() static method of the {{domxref("Translator")}} interface creates a new Translator instance that can be used to translate text.

[!NOTE] The create() method requires transient activation, that is, it must be invoked in response to a user action such as a mouse click or button press.

Syntax

Translator.create(options)

Parameters

• options
  • : An object specifying configuration options for the Translator. Possible values include:
    • sourceLanguage
      • : A string specifying the expected language of the input text to be translated, which should be a valid {{glossary("BCP 47 language tag")}}.
    • targetLanguage
      • : A string specifying the language that the input text will be translated into, which should be valid BCP 47 language tag.
    • monitor {{optional_inline}}
      • : A callback function with a {{domxref("CreateMonitor")}} argument that enables monitoring download progress of the AI model.
    • signal {{optional_inline}}
      • : An {{domxref("AbortSignal")}} object instance, which allows a create() operation to be aborted via the associated {{domxref("AbortController")}}. The exact effect is dependant on when {{domxref("AbortController.abort()")}} is called:
        • If abort() is called before the create() promise resolves, the create() operation is cancelled.
        • If abort() is called after the create() promise fulfills, it has the same effect as calling {{domxref("Translator.destroy()")}}: The resources assigned to the resulting Translator instance are released, and any ongoing and subsequent Translator method calls will reject with an AbortError.

Return value

A {{jsxref("Promise")}} that fulfills with a Translator object instance.

Exceptions

• InvalidStateError {{domxref("DOMException")}}
  • : Thrown if the page's {{domxref("Document")}} is not yet active.
• NetworkError {{domxref("DOMException")}}
  • : Thrown if:
    • The network was not available to download the AI model.
    • The user has cancelled the AI model download.
• NotAllowedError {{domxref("DOMException")}}
  • : Thrown if:
    • Usage of the method is blocked by a {{httpheader('Permissions-Policy/translator','translator')}} {{httpheader("Permissions-Policy")}}.
    • The user has blocked the AI model download in some way.
    • The create() method wasn't called via {{glossary("transient activation")}}.
• NotSupportedError {{domxref("DOMException")}}
  • : Thrown if:
    • The language tags specified in sourceLanguage or targetLanguage are invalid, or not supported. This is the case if the specified sourceLanguage and targetLanguage are the same.
    • An AI model to support the specified combination of sourceLanguage and targetLanguage is not available.
• OperationError {{domxref("DOMException")}}
  • : General-purpose exception thrown if Translator creation failed for any other reason.

Examples

Basic Translator creation

const translator = await Translator.create({
  sourceLanguage: "en",
  targetLanguage: "ja",
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Using the Translator and Language Detector APIs