unicode-script.md
October 30, 2024 · View on GitHub
Functions
- unicodeScript(char) ⇒
string|undefined Returns the Unicode script name of a single character
- unicodeScriptCode(char) ⇒
string|undefined Returns the Unicode script alias (ISO 15924) of a single character
- unicodeScripts(string) ⇒
Set Returns a Set of all scripts used in the string
- unicodeScriptCodes(string) ⇒
Set Returns a Set of all scripts used in the string (ISO 15924)
- unicodeScriptExtensions(string) ⇒
Set Returns a Set of all scripts extensions used in the string See https://www.unicode.org/reports/tr24/#Script_Extensions
- unicodeScriptExtensionCodes(string) ⇒
Set Returns a Set of all scripts extensions used in the string (ISO 15924) See https://www.unicode.org/reports/tr24/#Script_Extensions
- unicodeAugmentedScriptCodes(string) ⇒
Set Returns the augmented script set as described in https://www.unicode.org/reports/tr39/#def-augmented-script-set
- unicodeResolvedScriptCodes(string) ⇒
Set Returns the resolved script set as described in https://www.unicode.org/reports/tr39/#def-resolved-script-set
- isMixedScript(string) ⇒
boolean Returns the mixed-script status of a string as per https://www.unicode.org/reports/tr39/#def-mixed-script
- isSingleScript(string) ⇒
boolean Returns the single-script status of a string as per https://www.unicode.org/reports/tr39/#def-single-script
- listUnicodeScripts() ⇒
Set Lists all known Unicode scripts
- listUnicodeScriptCodes() ⇒
Set Lists all known Unicode scripts (ISO 15924)
- listUnicodeAugmentedScriptCodes() ⇒
Set Lists augmented scripts (ISO 15924)
unicodeScript(char) ⇒ string | undefined
Returns the Unicode script name of a single character
Kind: global function
Returns: string | undefined - Script name
| Param | Type | Description |
|---|---|---|
| char | string | number | Single character string or codepoint |
unicodeScriptCode(char) ⇒ string | undefined
Returns the Unicode script alias (ISO 15924) of a single character
Kind: global function
Returns: string | undefined - Script name (ISO 15924)
| Param | Type | Description |
|---|---|---|
| char | string | number | Single character string or codepoint |
unicodeScripts(string) ⇒ Set
Returns a Set of all scripts used in the string
Kind: global function
Returns: Set - Set of script names
| Param | Type | Description |
|---|---|---|
| string | string | Input string |
unicodeScriptCodes(string) ⇒ Set
Returns a Set of all scripts used in the string (ISO 15924)
Kind: global function
Returns: Set - Set of script names (ISO 15924)
| Param | Type | Description |
|---|---|---|
| string | string | Input string |
unicodeScriptExtensions(string) ⇒ Set
Returns a Set of all scripts extensions used in the string See https://www.unicode.org/reports/tr24/#Script_Extensions
Kind: global function
Returns: Set - Set of script extensions
| Param | Type | Description |
|---|---|---|
| string | string | Input string |
unicodeScriptExtensionCodes(string) ⇒ Set
Returns a Set of all scripts extensions used in the string (ISO 15924) See https://www.unicode.org/reports/tr24/#Script_Extensions
Kind: global function
Returns: Set - Set of script extensions (ISO 15924)
| Param | Type | Description |
|---|---|---|
| string | string | Input string |
unicodeAugmentedScriptCodes(string) ⇒ Set
Returns the augmented script set as described in https://www.unicode.org/reports/tr39/#def-augmented-script-set
Kind: global function
Returns: Set - Set of script extensions + augmented scripts (ISO 15924)
| Param | Type | Description |
|---|---|---|
| string | string | Input string (single char) |
unicodeResolvedScriptCodes(string) ⇒ Set
Returns the resolved script set as described in https://www.unicode.org/reports/tr39/#def-resolved-script-set
Kind: global function
Returns: Set - Set of resolved scripts (ISO 15924)
| Param | Type | Description |
|---|---|---|
| string | string | Input string |
isMixedScript(string) ⇒ boolean
Returns the mixed-script status of a string as per https://www.unicode.org/reports/tr39/#def-mixed-script
Kind: global function
Returns: boolean - true if mixed-script, false if single-script
| Param | Type | Description |
|---|---|---|
| string | string | Input string |
isSingleScript(string) ⇒ boolean
Returns the single-script status of a string as per https://www.unicode.org/reports/tr39/#def-single-script
Kind: global function
Returns: boolean - false if mixed-script, true if single-script
| Param | Type | Description |
|---|---|---|
| string | string | Input string |
listUnicodeScripts() ⇒ Set
Lists all known Unicode scripts
Kind: global function
Returns: Set - All script names
listUnicodeScriptCodes() ⇒ Set
Lists all known Unicode scripts (ISO 15924)
Kind: global function
Returns: Set - All script names (ISO 15924)
listUnicodeAugmentedScriptCodes() ⇒ Set
Lists augmented scripts (ISO 15924)
Kind: global function
Returns: Set - Augmented scripts as described in UAX24