@isdk/detect-text-language
Version:
Detect the text language
551 lines (548 loc) • 10.2 kB
text/typescript
declare const CountryCodes: {
US: string;
GB: string;
FR: string;
DE: string;
AD: string;
AE: string;
AF: string;
AG: string;
AI: string;
AL: string;
AM: string;
AN: string;
AO: string;
AQ: string;
AR: string;
AS: string;
AT: string;
AU: string;
AW: string;
AX: string;
AZ: string;
BA: string;
BB: string;
BD: string;
BE: string;
BF: string;
BG: string;
BH: string;
BI: string;
BJ: string;
BL: string;
BM: string;
BN: string;
BO: string;
BQ: string;
BR: string;
BS: string;
BT: string;
BV: string;
BW: string;
BY: string;
BZ: string;
CA: string;
CC: string;
CD: string;
CF: string;
CG: string;
CH: string;
CI: string;
CK: string;
CL: string;
CM: string;
CN: string;
CO: string;
CR: string;
CU: string;
CV: string;
CW: string;
CX: string;
CY: string;
CZ: string;
DJ: string;
DK: string;
DM: string;
DO: string;
DZ: string;
EC: string;
EE: string;
EG: string;
EH: string;
ER: string;
ES: string;
ET: string;
FI: string;
FJ: string;
FK: string;
FM: string;
FO: string;
GA: string;
GD: string;
GE: string;
GF: string;
GG: string;
GH: string;
GI: string;
GL: string;
GM: string;
GN: string;
GP: string;
GQ: string;
GR: string;
GS: string;
GT: string;
GU: string;
GW: string;
GY: string;
HK: string;
HM: string;
HN: string;
HR: string;
HT: string;
HU: string;
ID: string;
IE: string;
IL: string;
IM: string;
IN: string;
IO: string;
IQ: string;
IR: string;
IS: string;
IT: string;
JE: string;
JM: string;
JO: string;
JP: string;
KE: string;
KG: string;
KH: string;
KI: string;
KM: string;
KN: string;
KP: string;
KR: string;
KW: string;
KY: string;
KZ: string;
LA: string;
LB: string;
LC: string;
LI: string;
LK: string;
LR: string;
LS: string;
LT: string;
LU: string;
LV: string;
LY: string;
MA: string;
MC: string;
MD: string;
ME: string;
MF: string;
MG: string;
MH: string;
MK: string;
ML: string;
MM: string;
MN: string;
MO: string;
MP: string;
MQ: string;
MR: string;
MS: string;
MT: string;
MU: string;
MV: string;
MW: string;
MX: string;
MY: string;
MZ: string;
NA: string;
NC: string;
NE: string;
NF: string;
NG: string;
NI: string;
NL: string;
NO: string;
NP: string;
NR: string;
NU: string;
NZ: string;
OM: string;
PA: string;
PE: string;
PF: string;
PG: string;
PH: string;
PK: string;
PL: string;
PM: string;
PN: string;
PR: string;
PS: string;
PT: string;
PW: string;
PY: string;
QA: string;
RE: string;
RO: string;
RS: string;
RU: string;
RW: string;
SA: string;
SB: string;
SC: string;
SD: string;
SE: string;
SG: string;
SH: string;
SI: string;
SJ: string;
SK: string;
SL: string;
SM: string;
SN: string;
SO: string;
SR: string;
SS: string;
ST: string;
SV: string;
SX: string;
SY: string;
SZ: string;
TC: string;
TD: string;
TF: string;
TG: string;
TH: string;
TJ: string;
TK: string;
TL: string;
TM: string;
TN: string;
TO: string;
TR: string;
TT: string;
TV: string;
TW: string;
TZ: string;
UA: string;
UG: string;
UM: string;
UY: string;
UZ: string;
VA: string;
VC: string;
VE: string;
VG: string;
VI: string;
VN: string;
VU: string;
WF: string;
WS: string;
XK: string;
YE: string;
YT: string;
ZA: string;
ZM: string;
ZW: string;
};
declare const CountryNames: {
AD: string;
AE: string;
AF: string;
AG: string;
AI: string;
AL: string;
AM: string;
AN: string;
AO: string;
AQ: string;
AR: string;
AS: string;
AT: string;
AU: string;
AW: string;
AX: string;
AZ: string;
BA: string;
BB: string;
BD: string;
BE: string;
BF: string;
BG: string;
BH: string;
BI: string;
BJ: string;
BL: string;
BM: string;
BN: string;
BO: string;
BQ: string;
BR: string;
BS: string;
BT: string;
BV: string;
BW: string;
BY: string;
BZ: string;
CA: string;
CC: string;
CD: string;
CF: string;
CH: string;
CI: string;
CK: string;
CL: string;
CM: string;
CN: string;
CO: string;
CR: string;
CU: string;
CV: string;
CW: string;
CX: string;
CY: string;
CZ: string;
DE: string;
DJ: string;
DK: string;
DM: string;
DO: string;
DZ: string;
EC: string;
EE: string;
EG: string;
EH: string;
ER: string;
ES: string;
ET: string;
FI: string;
FJ: string;
FK: string;
FM: string;
FO: string;
FR: string;
GA: string;
GB: string;
GD: string;
GE: string;
GF: string;
GG: string;
GH: string;
GI: string;
GL: string;
GM: string;
GN: string;
GP: string;
GQ: string;
GR: string;
GS: string;
GT: string;
GU: string;
GW: string;
GY: string;
HK: string;
HM: string;
HN: string;
HR: string;
HT: string;
HU: string;
ID: string;
IE: string;
IL: string;
IM: string;
IN: string;
IO: string;
IQ: string;
IR: string;
IS: string;
IT: string;
JE: string;
JM: string;
JO: string;
JP: string;
KE: string;
KG: string;
KH: string;
KI: string;
KM: string;
KN: string;
KP: string;
KR: string;
KW: string;
KY: string;
KZ: string;
LA: string;
LB: string;
LC: string;
LI: string;
LK: string;
LR: string;
LS: string;
LT: string;
LU: string;
LV: string;
LY: string;
MA: string;
MC: string;
MD: string;
ME: string;
MF: string;
MG: string;
MH: string;
MK: string;
ML: string;
MM: string;
MN: string;
MO: string;
MP: string;
MQ: string;
MR: string;
MS: string;
MT: string;
MU: string;
MV: string;
MW: string;
MX: string;
MY: string;
MZ: string;
NA: string;
NC: string;
NE: string;
NF: string;
NG: string;
NI: string;
NL: string;
NO: string;
NP: string;
NR: string;
NU: string;
NZ: string;
OM: string;
PA: string;
PE: string;
PF: string;
PG: string;
PH: string;
PK: string;
PL: string;
PM: string;
PN: string;
PR: string;
PS: string;
PT: string;
PW: string;
PY: string;
QA: string;
RE: string;
RO: string;
RS: string;
RU: string;
RW: string;
SA: string;
SB: string;
SC: string;
SD: string;
SE: string;
SG: string;
SH: string;
SI: string;
SJ: string;
SK: string;
SL: string;
SM: string;
SN: string;
SO: string;
SR: string;
SS: string;
ST: string;
SV: string;
SX: string;
SY: string;
SZ: string;
TC: string;
TD: string;
TF: string;
TG: string;
TH: string;
TJ: string;
TK: string;
TL: string;
TM: string;
TN: string;
TO: string;
TR: string;
TT: string;
TV: string;
TW: string;
TZ: string;
UA: string;
UG: string;
UM: string;
US: string;
UY: string;
UZ: string;
VA: string;
VC: string;
VE: string;
VG: string;
VI: string;
VN: string;
VU: string;
WF: string;
WS: string;
XK: string;
YE: string;
YT: string;
ZA: string;
ZM: string;
ZW: string;
};
interface IDetectLanguageOptions {
isoCode?: boolean;
langSubset?: string[];
threshold?: number;
}
/**
* detects the language of the given text.
*
* This function employs a language detection algorithm to identify the language of the input text. If the `isoCode` option is provided,
* it attempts to match the detected language to the ISO 639-3 standard code.
*
* @param text The text whose language is to be detected.
* @param options Additional options, such as requesting an ISO code match.
* @param options.isoCode - If truthy, returns the ISO 639-1 code instead of the language name (default: falsy).
* @returns The detected language name or ISO 639-1 code. If the `isoCode` option was specified and a match was found, returns the ISO 639-1 code;
* otherwise, returns the raw result from the language detector, return undefined if no detector.
*
* @example
* ```typescript
* await detectTextLanguage("in the world!", { isoCode: true });
* // Returns 'en' assuming the detector recognizes English and ISO code option is used.
* ```
*/
declare function detectTextLanguage(text: string, options?: IDetectLanguageOptions): string | undefined;
/**
* Detects the language of the provided text and returns the language code along with additional information.
*
* @param text The string of text to be detected.
* @returns An object containing the ISO 639-1 code of the language, and optionally, the ISO 3166 country code, country name, and language name.
* Returns undefined if the language cannot be reliably detected.
*/
declare function detectTextLangEx(text: string, options?: IDetectLanguageOptions): {
iso6391: string;
iso3166?: string;
name?: string;
country?: string;
scores?: {
[langCode: string]: number;
};
} | undefined;
declare function getCountryCodeFromLang(iso6391: string): string | undefined;
declare function getLanguageFromIso6391(iso6391: string): string | undefined;
export { CountryCodes, CountryNames, type IDetectLanguageOptions, detectTextLangEx, detectTextLanguage, getCountryCodeFromLang, getLanguageFromIso6391 };