Translator: measureInputUsage() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The measureInputUsage() method of the Translator interface reports how much input quota would be used by a translation operation for a given text input.
Syntax
measureInputUsage(input)
measureInputUsage(input, options)
Parameters
input-
A string representing the input text you want an input usage measurement for.
optionsOptional-
An object specifying configuration options for the
measureInputUsage()operation. Possible values include:signal-
An
AbortSignalobject instance, which allows themeasureInputUsage()operation to be aborted via the associatedAbortController.
Return value
A Promise that fulfills with a number specifying the inputQuota usage of the given input text.
This number is implementation-dependant; if it is less than the inputQuota, the string can be translated.
Exceptions
NotAllowedErrorDOMException-
Thrown if usage of the
TranslatorAPI is blocked by atranslatorPermissions-Policy. NotReadableErrorDOMException-
Thrown if the output translation was filtered by the user agent, for example because it was detected to be harmful, inaccurate, or nonsensical.
UnknownErrorDOMException-
Thrown if the
measureInputUsage()call failed for any other reason, or a reason the user agent did not wish to disclose.
Examples
Checking if you have enough quota
In the below snippet, we create a new Translator instance using create(), then return the total input quota via inputQuota and the input quota usage for a translating a particular text string via measureInputUsage().
We then test to see if the individual input usage for that string is greater than the total available quota. If so, we throw an appropriate error; it not, we commence translating the string using translate().
const translator = await Translator.create({
sourceLanguage: "en",
targetLanguage: "ja",
});
const totalInputQuota = translator.inputQuota;
const inputUsage = await translator.measureInputUsage(myTextString);
if (inputUsage > totalInputQuota) {
throw new Error("Insufficient quota to translate.");
} else {
console.log("Quota available to translate.");
const translation = await translator.translate(myTextString);
// ...
}
Specifications
| Specification |
|---|
| Translator and Language Detector APIs # dom-translator-measureinputusage |
Browser compatibility
Loading…