Caido
GuidesTutorialsReferenceConcepts

@caido/quickjs-types / llrt/string_decoder

llrt/string_decoder ​

Classes ​

StringDecoder ​

Constructors ​

Constructor ​

new StringDecoder(encoding?: BufferEncoding): StringDecoder

Parameters ​
ParameterType
encoding?BufferEncoding
Returns ​

StringDecoder

Methods ​

end() ​

end(buffer?: string | ArrayBufferView | Buffer): string

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 ​
ParameterTypeDescription
buffer?string | ArrayBufferView | BufferThe bytes to decode.
Returns ​

string

write() ​

write(buffer: string | ArrayBufferView | Buffer): 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 ​
ParameterTypeDescription
bufferstring | ArrayBufferView | BufferThe bytes to decode.
Returns ​

string