LanguageDetector: create() static method

Syntax

LanguageDetector.create(options)

Parameters

options

An object specifying configuration options for the LanguageDetector. Possible values include:

expectedInputLanguages

An array of strings specifying the expected languages of the input text, which helps improve the accuracy of the language detection. These should be valid BCP 47 language tags. Defaults to ["en"].

monitor Optional

A callback function with a CreateMonitor argument that enables monitoring download progress of the AI model.

signal Optional

An AbortSignal object instance, which allows a create() operation to be aborted via the associated AbortController. The exact effect is dependant on when 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 LanguageDetector.destroy(): The resources assigned to the resulting LanguageDetector instance are released, and any ongoing and subsequent LanguageDetector method calls will reject with an AbortError.

Return value

A Promise that fulfills with a LanguageDetector object instance.

Exceptions

InvalidStateError DOMException

Thrown if the page's Document is not yet active.

NetworkError DOMException

Thrown if:

• The network was not available to download the AI model.
• The user has cancelled the AI model download.

NotAllowedError DOMException

Thrown if:

• Usage of the method is blocked by a language-detector Permissions-Policy.
• The user has blocked the AI model download in some way.
• The create() method wasn't called via transient activation.

NotSupportedError DOMException

Thrown if:

• The language tags specified in expectedInputLanguages are invalid, or not supported.
• An AI model to support the specified expectedInputLanguages is not available.

OperationError DOMException

General-purpose exception thrown if LanguageDetector creation failed for any other reason.

Examples

Basic LanguageDetector creation

const detector = await LanguageDetector.create({
  expectedInputLanguages: ["en-US", "zh"],
});

Specifications

Browser compatibility

See also

• Using the Translator and Language Detector APIs