LanguageDetector: measureInputUsage() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The measureInputUsage()
method of the LanguageDetector
interface reports how much input quota would be used by a language detection 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.
options
Optional-
An object specifying configuration options for the
measureInputUsage()
operation. Possible values include:signal
-
An
AbortSignal
object 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.
Exceptions
NotAllowedError
DOMException
-
Thrown if usage of the
LanguageDetector
API is blocked by alanguage-detector
Permissions-Policy
. UnknownError
DOMException
-
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 LanguageDetector
instance using create()
, then return the total input quota via inputQuota
and the input quota usage for a detecting a particular text string's language 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 detecting the string's language using detect()
.
const detector = await LanguageDetector.create({
expectedInputLanguages: ["en-US", "zh"],
});
const totalInputQuota = detector.inputQuota;
const inputUsage = await detector.measureInputUsage(myTextString);
if (inputUsage > totalInputQuota) {
throw new Error("Boo, not enough quota left to detect languages.");
} else {
console.log("Yay, enough quota left to detect languages.");
const results = await detector.detect(myTextString);
// ...
}
Specifications
No specification found
No specification data found for api.LanguageDetector.measureInputUsage
.
Check for problems with this page or contribute a missing spec_url
to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.