Charset Node.js Reference Documentation

Charset

Current Version: 9.5.0.73

A component/class for converting character data from one encoding to another. This software is unique in that the data required for converting to/from the supported charsets is entirely embedded witin the Chilkat DLL/library. It does not depend on what code pages may or may not be installed on a particular computer. This allows programs to operate correctly regardless of the locale, OS version, or other factors.

Object Creation

var obj = new chilkat.Charset();

Properties

AltToCharset
AltToCharset
· string

If the ErrorAction property is set to 6, then this property controls how errors are handled. It specifies an alternate "To" charset. When a character in the input data cannot be converted to the target charset, an attempt is made to convert it to the AltToCharset. If that fails, the input character is dropped.

top
DebugLogFilePath
DebugLogFilePath
· string

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
ErrorAction
ErrorAction
· integer

Controls how errors are handled. When a character in the input data cannot be converted to the target charset, the action taken is controlled by this property. The possible settings are: (0) drop the error characters, (1) substitute the data set by the SetErrorBytes or SetErrorString method, (2) convert to a hex-escaped string (&#xXXXX), (3) RESERVED, (4) RESERVED, (5) RESERVED, (6) convert the error character to the AltToCharset instead, if that fails then drop the character, (7) Pass non-convertible characters to the output unchanged.

top
FromCharset
FromCharset
· string

Tells the charset converter the charset of the input data for a conversion. Possible values are:

<font size="2" face="MS Sans Serif">
us-ascii
unicode  (also known as UTF16LE or simply UTF16)
unicodefffe  (also known as UTF16BE)
ebcdic
iso-8859-1
iso-8859-2
iso-8859-3
iso-8859-4
iso-8859-5
iso-8859-6
iso-8859-7
iso-8859-8
iso-8859-9
iso-8859-13
iso-8859-15
windows-874
windows-1250
windows-1251
windows-1252
windows-1253
windows-1254
windows-1255
windows-1256
windows-1257
windows-1258
utf-7
utf-8
utf-32
utf-32be
shift_jis
gb2312
ks_c_5601-1987
big5
iso-2022-jp
iso-2022-kr
euc-jp
euc-kr
macintosh
x-mac-japanese
x-mac-chinesetrad
x-mac-korean
x-mac-arabic
x-mac-hebrew
x-mac-greek
x-mac-cyrillic
x-mac-chinesesimp
x-mac-romanian
x-mac-ukrainian
x-mac-thai
x-mac-ce
x-mac-icelandic
x-mac-turkish
x-mac-croatian
asmo-708
dos-720
dos-862
ibm01140
ibm01141
ibm01142
ibm01143
ibm01144
ibm01145
ibm01146
ibm01147
ibm01148
ibm01149
ibm037
ibm437
ibm500
ibm737
ibm775
ibm850
ibm852
ibm855
ibm857
ibm00858
ibm860
ibm861
ibm863
ibm864
ibm865
cp866
ibm869
ibm870
cp875
koi8-r
koi8-u
</font>

top
LastErrorHtml
LastErrorHtml
· string, read-only

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText
· string, read-only

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml
· string, read-only

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastInputAsHex
LastInputAsHex
· string, read-only

If SaveLast is set to true, then the input and output of a conversion is saved to allow the exact bytes that are sent to the converter to be seen (for debugging purposes). This property shows the last input data in a hexidecimalized string.

top
LastInputAsQP
LastInputAsQP
· string, read-only

If SaveLast is set to true, then the input and output of a conversion is saved to allow the exact bytes that are sent to the converter to be seen (for debugging purposes). This property shows the last input data in a quoted-printable string.

top
LastMethodSuccess
LastMethodSuccess
· boolean
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastOutputAsHex
LastOutputAsHex
· string, read-only

If SaveLast is set to true, then the input and output of a conversion is saved to allow the exact bytes that are sent to the converter to be seen (for debugging purposes). This property shows the last output data in a hexidecimalized string.

top
LastOutputAsQP
LastOutputAsQP
· string, read-only

If SaveLast is set to true, then the input and output of a conversion is saved to allow the exact bytes that are sent to the converter to be seen (for debugging purposes). This property shows the last output data in a quoted-printable string.

top
SaveLast
SaveLast
· boolean

Tells the component to keep the input/output byte data in memory after a conversion is complete so the data can be examined via the LastInputAsHex/QP and LastOutputAsHex/QP properties. (for debugging purposes)

top
ToCharset
ToCharset
· string

Tells the charset converter the target charset for a conversion. Possible values are:

<font size="2" face="MS Sans Serif">
us-ascii
unicode  (also known as UTF16LE or simply UTF16)
unicodefffe  (also known as UTF16BE)
ebcdic
iso-8859-1
iso-8859-2
iso-8859-3
iso-8859-4
iso-8859-5
iso-8859-6
iso-8859-7
iso-8859-8
iso-8859-9
iso-8859-13
iso-8859-15
windows-874
windows-1250
windows-1251
windows-1252
windows-1253
windows-1254
windows-1255
windows-1256
windows-1257
windows-1258
utf-7
utf-8
utf-32
utf-32be
shift_jis
gb2312
ks_c_5601-1987
big5
iso-2022-jp
iso-2022-kr
euc-jp
euc-kr
macintosh
x-mac-japanese
x-mac-chinesetrad
x-mac-korean
x-mac-arabic
x-mac-hebrew
x-mac-greek
x-mac-cyrillic
x-mac-chinesesimp
x-mac-romanian
x-mac-ukrainian
x-mac-thai
x-mac-ce
x-mac-icelandic
x-mac-turkish
x-mac-croatian
asmo-708
dos-720
dos-862
ibm01140
ibm01141
ibm01142
ibm01143
ibm01144
ibm01145
ibm01146
ibm01147
ibm01148
ibm01149
ibm037
ibm437
ibm500
ibm737
ibm775
ibm850
ibm852
ibm855
ibm857
ibm00858
ibm860
ibm861
ibm863
ibm864
ibm865
cp866
ibm869
ibm870
cp875
koi8-r
koi8-u
</font>

top
VerboseLogging
VerboseLogging
· boolean

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version
· string, read-only

Version of the component/library, such as "9.5.0.63"

top

Methods

CharsetToCodePage
var retInt = CharsetToCodePage(charsetName);
· Returns a Number.
· charsetName String

Converts a charset name to a code page number. For example, "iso-8859-1" converts to code page 28591.

top
CodePageToCharset
var retStr = CodePageToCharset(codePage);
· Returns a String.
· codePage Number

Converts a code page number to a charset name. For example, 65001 converts to "utf-8".

Returns null on failure

top
ConvertData
var retBuf = ConvertData(inData);
· Returns a Buffer.

Converts character data from one charset to another. Before calling ConvertData, the FromCharset and ToCharset properties must be set to the source and destination charset names, such as "iso-8859-1" or "Shift_JIS".

Returns null on failure

top
ConvertFile
var status = ConvertFile(inPath, destPath);
· Returns Boolean (true for success, false for failure).
· inPath String
· destPath String

Converts a file from one character encoding to another. The FromCharset and ToCharset properties specify the source and destination character encodings. If the ToCharset is utf-16 or utf-8, then the preamble (also known as BOM) is included in the output. (Call ConvertFileNoPreamble to suppress the output of the BOM.)

Returns true for success, false for failure.

top
ConvertFileNoPreamble
var retBool = ConvertFileNoPreamble(inPath, destPath);
· Returns a Boolean.
· inPath String
· destPath String

Converts a file from one character encoding to another. The FromCharset and ToCharset properties specify the source and destination character encodings. No preamble (also known as BOM) is included in the output.

top
ConvertFromUnicode
var retBuf = ConvertFromUnicode(inData);
· Returns a Buffer.

Converts Unicode (utf-16) text to the charset specified by the ToCharset property.

Returns null on failure

top
ConvertFromUtf16
var retBuf = ConvertFromUtf16(uniData);
· Returns a Buffer.

Converts utf-16 text to the charset specified by the ToCharset property.

Returns null on failure

top
ConvertHtml
var retBuf = ConvertHtml(inData);
· Returns a Buffer.

Converts HTML text from one character encoding to another. The FromCharset and ToCharset properties must be set prior to calling this method. This method automatically edits the META tag within the HTML that indicates the charset.

Returns null on failure

top
ConvertHtmlFile
var status = ConvertHtmlFile(inPath, destPath);
· Returns Boolean (true for success, false for failure).
· inPath String
· destPath String

Converts an HTML file from one character encoding to another. The ToCharset properties must be set prior to calling this method. If the FromCharset is not set, it is obtained from the HTML META tag that indicates the charset. This method automatically edits the META tag within the HTML that indicates the charset.

Returns true for success, false for failure.

top
ConvertToUnicode
var retStr = ConvertToUnicode(inData);
· Returns a String.
· inData Buffer

Converts multibyte character data to a Unicode string. The FromCharset property should be set before calling this method.

Returns null on failure

top
ConvertToUtf16
var retBuf = ConvertToUtf16(mbData);
· Returns a Buffer.

To be documented soon.

Returns null on failure

top
EntityEncodeDec
var retStr = EntityEncodeDec(str);
· Returns a String.
· str String

Converts non-US-ASCII characters to Unicode decimal entities (&#xxxxx;)

Returns null on failure

top
EntityEncodeHex
var retStr = EntityEncodeHex(str);
· Returns a String.
· str String

Converts non-US-ASCII characters to Unicode hex entities (&#xXXXX;)

Returns null on failure

top
GetHtmlCharset
var retStr = GetHtmlCharset(inData);
· Returns a String.
· inData Buffer

Examines HTML text and extracts the charset name specified by the META tag, if present.

Returns null on failure

top
GetHtmlFileCharset
var retStr = GetHtmlFileCharset(htmlFilePath);
· Returns a String.
· htmlFilePath String

Examines an HTML file and extracts the charset name specified by the META tag, if present.

Returns null on failure

top
HtmlDecodeToStr
var retStr = HtmlDecodeToStr(inStr);
· Returns a String.
· inStr String

Converts HTML entities to Unicode characters.

Returns null on failure

top
HtmlEntityDecode
var retBuf = HtmlEntityDecode(inHtml);
· Returns a Buffer.

Decodes HTML entities. See http://www.w3.org/TR/REC-html40/sgml/entities.html for information on HTML entities. Examples of HTML entities are &lt; , &#229; , &#xE5; , &#x6C34; , &Iacute; , etc.

Returns null on failure

top
HtmlEntityDecodeFile
var status = HtmlEntityDecodeFile(inPath, destPath);
· Returns Boolean (true for success, false for failure).
· inPath String
· destPath String

Decodes HTML entities in a file and creates a new HTML file with the entities decoded. See http://www.w3.org/TR/REC-html40/sgml/entities.html for information on HTML entities. Examples of HTML entities are &lt; , &#229; , &#xE5; , &#x6C34; , &Iacute; , etc.

Returns true for success, false for failure.

top
IsUnlocked
var retBool = IsUnlocked();
· Returns a Boolean.

Returns true if the component is unlocked.

top
LowerCase
var retStr = LowerCase(inStr);
· Returns a String.
· inStr String

Converts a string to lowercase.

Returns null on failure

top
ReadFile
var retBuf = ReadFile(path);
· Returns a Buffer.

Convenience method for reading the entire contents of a file into a byte array.

Returns null on failure

top
ReadFileToString
var retStr = ReadFileToString(path, charset);
· Returns a String.
· path String
· charset String

Reads a text file and returns the text converted to a Unicode string. The filename is specified by the first method argument, and the charset of the text data is specified by the 2nd method argument.

Returns null on failure

top
SaveLastError
var status = SaveLastError(path);
· Returns Boolean (true for success, false for failure).
· path String

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SetErrorBytes
SetErrorBytes(data);
· Does not return anything (returns Undefined).
· data Buffer

If the ErrorAction property is set to 1, the bytes passed to this method are used as the result for any characters that cannot be converted during a conversion.

top
SetErrorString
SetErrorString(str, charset);
· Does not return anything (returns Undefined).
· str String
· charset String

If the ErrorAction property is set to 1, the string passed to this method is used as the result for any characters that cannot be converted during a conversion.

top
UnlockComponent
var status = UnlockComponent(unlockCode);
· Returns Boolean (true for success, false for failure).
· unlockCode String

Unlocks the component. This method must be called once at the beginning of the program. Properties can be get/set without unlocking, but methods will not work unless the component has been unlocked.

Returns true for success, false for failure.

top
UpperCase
var retStr = UpperCase(inStr);
· Returns a String.
· inStr String

Converts a string to uppercase.

Returns null on failure

top
UrlDecodeStr
var retStr = UrlDecodeStr(inStr);
· Returns a String.
· inStr String

URL decodes a string.

Returns null on failure

top
VerifyData
var retBool = VerifyData(charset, inData);
· Returns a Boolean.
· charset String
· inData Buffer

Returns true if the byte data conforms to the charset passed in the first argument.

top
VerifyFile
var retBool = VerifyFile(charset, path);
· Returns a Boolean.
· charset String
· path String

Returns true if the file contains character data that conforms to the charset passed in the 1st argument.

top
WriteFile
var retBool = WriteFile(path, byteData);
· Returns a Boolean.
· path String
· byteData Buffer

Convenience method for saving an entire byte array to a file.

top
WriteStringToFile
var status = WriteStringToFile(textData, path, charset);
· Returns Boolean (true for success, false for failure).
· textData String
· path String
· charset String

Converts a Unicode string to a multibyte charset and writes the multibyte text data to a file. The destination charset is specified in the 2nd method argument.

Returns true for success, false for failure.

top