lang~Lang

Language spesific functions such as charsets and number pronounciation

Lang
lang.mjs, line 10

Methods

protected, static _nChs(setName, begin, end)
lang.mjs, line 30

Add char sets of a language
Parameters:
Name Type Description
setName String CharSet name, for example: hiragana, kanji, Arabic suppliment
begin Number integer value: begining of the charSet
end Number integer value: end of the charSet

protected, static _nTrans(transName, opts)
lang.mjs, line 52

Creates a new transformation method
Parameters:
Name Type Description
transName String transformation name (function name), for example: hiragana2Katakana
opts Array.<Object> Array of options
Example
{//If the charset exists and we use all of it
      setName: "<name of the charset",
      offset: <number>
   },
   {//otherwise
      begin: <number>,
      end: <number>,
      offset: <number>
   }

static all(text) → {Boolean}
lang.mjs, line 178

Verify if all text's characters belong to the current charSet
Parameters:
Name Type Description
text String the text to verify
Returns:
Boolean - the text contains some chars of the current charset or not

static contains(text) → {Boolean}
lang.mjs, line 167

Verify if all text's characters belong to the current charSet
Parameters:
Name Type Description
text String the text to verify
Returns:
Boolean - the text contains some chars of the current charset or not

static gcharverify(charSet) → {object}
lang.mjs, line 121

Get an object with verification functions contains: returns a function which verifies if the text contains at least one of the charsets all : returns a function which verifies if all the chacaters of the text are in this charset
Parameters:
Name Type Description
charSet String the name of the charset
Returns:
object - object with verifying functions

static getCharSetFunctions(charSet) → {object}
lang.mjs, line 145

Get an object with verification functions contains: returns a function which verifies if the text contains at least one of the charsets all : returns a function which verifies if all the chacaters of the text are in this charset
Parameters:
Name Type Description
charSet String the name of the charset
Returns:
object - object with verifying functions

static getTransDesc(transName) → {Text}
lang.mjs, line 263

Get the description of the transformation function
Parameters:
Name Type Description
transName String name of the transformation function
Returns:
Text - description

static getTransformationFunction(transName) → {function}
lang.mjs, line 234

Get the the transformation function
Parameters:
Name Type Description
transName String name of the transformation function
Returns:
function - a function which transforms a given text

static gtrans(transName) → {function}
lang.mjs, line 221

Get the the transformation function
Parameters:
Name Type Description
transName String name of the transformation function
Returns:
function - a function which transforms a given text

static gtransdesc(transName) → {Text}
lang.mjs, line 247

Get the description of the transformation function
Parameters:
Name Type Description
transName String name of the transformation function
Returns:
Text - description

static lchars() → {Array.<String>}
lang.mjs, line 92

Returns the available charsets for the current language
Returns:
Array.<String> - a set of strings containing the names of charsets

static listCharSets() → {Array.<String>}
lang.mjs, line 104

Returns the available charsets for the current language
Returns:
Array.<String> - a set of strings containing the names of charsets

static listTransformations() → {Array.<String>}
lang.mjs, line 208

Returns the available transformations for the current language (Static version)
Returns:
Array.<String> - a set of strings containing the names of transformation functions

static ltrans() → {Array.<String>}
lang.mjs, line 196

Returns the available transformations for the current language (Static version)
Returns:
Array.<String> - a set of strings containing the names of transformation functions

abstract, static nbr2str(num) → {String}
lang.mjs, line 306

A function which returns the pronounciation of a number in the destination language (this must be overriden)
Parameters:
Name Type Description
num Number A number to be transformed into letters
Returns:
String - the pronounciation

static schars(charSet)
lang.mjs, line 156

Sets the current charset we are using for functions
Parameters:
Name Type Description
charSet String the name of the charset

static strans(transName)
lang.mjs, line 275

Sets the current transformations for the current object
Parameters:
Name Type Description
transName String the name of transformation method

static trans(text) → {Text}
lang.mjs, line 287

Transforms a text from a charset to another
Parameters:
Name Type Description
text String text to be transformed
Returns:
Text - transformed text