Skip to content
Titanium SDK
Version12.6.2

You are reading 12.6.2. See this page in 13.4.1.

StringDecoder

pseudoAndroidiPhoneiPadmacOSsince 8.3.0

The primary class exported by the string_decoder core module.

Methods 3

Creates a new StringDecoder instance.

Parameters
ParametersTypeDescription
encoding?String

The character encoding the StringDecoder will use.

Returns any remaining input stored in the internal buffer as a string. Bytes representing incomplete UTF-8 and UTF-16 characters will be replaced with substitution characters appropriate for the character encoding.

If the buffer argument is provided, one final call to stringDecoder.write() is performed before returning the remaining input. After end() is called, the stringDecoder object can be reused for new input.

Parameters
ParametersTypeDescription
buffer?buffer.Buffer | Uint8Array

A Buffer, or TypedArray, or DataView containing the bytes to decode.

Returns String

Returns a decoded string, ensuring that any incomplete multibyte characters at the end of the Buffer, or TypedArray, or DataView are omitted from the returned string and stored in an internal buffer for the next call to stringDecoder.write() or stringDecoder.end().

Parameters
ParametersTypeDescription
bufferbuffer.Buffer | Uint8Array

A Buffer, or TypedArray, or DataView containing the bytes to decode.

Returns String