ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / share / doc / nodejs-docs-16.20.2 / doc / api

# String decoder

> Stability: 2 - Stable

The `node:string_decoder` module provides an API for decoding `Buffer` objects
into strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16
characters. It can be accessed using:

```js
const { StringDecoder } = require('node:string_decoder');
```

The following example shows the basic use of the `StringDecoder` class.

```js
const { StringDecoder } = require('node:string_decoder');
const decoder = new StringDecoder('utf8');

const cent = Buffer.from([0xC2, 0xA2]);
console.log(decoder.write(cent));

const euro = Buffer.from([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro));
```

When a `Buffer` instance is written to the `StringDecoder` instance, an
internal buffer is used to ensure that the decoded string does not contain
any incomplete multibyte characters. These are held in the buffer until the
next call to `stringDecoder.write()` or until `stringDecoder.end()` is called.

In the following example, the three UTF-8 encoded bytes of the European Euro
symbol (`€`) are written over three separate operations:

```js
const { StringDecoder } = require('node:string_decoder');
const decoder = new StringDecoder('utf8');

decoder.write(Buffer.from([0xE2]));
decoder.write(Buffer.from([0x82]));
console.log(decoder.end(Buffer.from([0xAC])));
```

## Class: `StringDecoder`

### `new StringDecoder([encoding])`

* `encoding` {string} The character [encoding][] the `StringDecoder` will use.
  **Default:** `'utf8'`.

Creates a new `StringDecoder` instance.

### `stringDecoder.end([buffer])`

* `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or
  `DataView` containing the bytes to decode.
* Returns: {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.

### `stringDecoder.write(buffer)`

* `buffer` {Buffer|TypedArray|DataView} 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()`.

[encoding]: buffer.md#buffers-and-character-encodings

[-] async_context.json [edit]
[-] process.md [edit]
[-] tracing.html [edit]
[-] addons.json [edit]
[-] webstreams.html [edit]
[-] debugger.md [edit]
[-] debugger.html [edit]
[-] tls.json [edit]
[-] inspector.md [edit]
[-] child_process.json [edit]
[-] packages.html [edit]
[-] events.md [edit]
[-] synopsis.html [edit]
[-] inspector.html [edit]
[-] dgram.json [edit]
[-] cli.html [edit]
[-] test.json [edit]
[-] repl.md [edit]
[-] worker_threads.md [edit]
[-] webcrypto.html [edit]
[-] readline.html [edit]
[-] crypto.html [edit]
[-] events.json [edit]
[-] esm.html [edit]
[-] querystring.md [edit]
[-] http.html [edit]
[-] buffer.md [edit]
[-] http2.md [edit]
[-] http.json [edit]
[-] documentation.json [edit]
[-] domain.json [edit]
[-] domain.html [edit]
[-] embedding.md [edit]
[-] cluster.md [edit]
[-] corepack.json [edit]
[-] errors.md [edit]
[-] modules.json [edit]
[-] string_decoder.md [edit]
[-] v8.md [edit]
[-] n-api.html [edit]
[-] module.md [edit]
[-] querystring.json [edit]
[+] ..
[-] querystring.html [edit]
[-] fs.json [edit]
[-] punycode.md [edit]
[-] esm.json [edit]
[-] test.html [edit]
[-] repl.json [edit]
[-] async_hooks.html [edit]
[-] async_hooks.md [edit]
[-] permissions.md [edit]
[-] util.md [edit]
[-] zlib.json [edit]
[-] synopsis.md [edit]
[-] vm.md [edit]
[-] tty.md [edit]
[-] child_process.html [edit]
[-] embedding.html [edit]
[-] stream.html [edit]
[-] report.json [edit]
[-] report.md [edit]
[-] policy.html [edit]
[-] policy.json [edit]
[-] index.md [edit]
[-] addons.html [edit]
[-] worker_threads.html [edit]
[-] path.json [edit]
[-] zlib.md [edit]
[-] buffer.html [edit]
[-] perf_hooks.json [edit]
[-] v8.json [edit]
[-] modules.html [edit]
[-] diagnostics_channel.json [edit]
[-] crypto.json [edit]
[-] corepack.html [edit]
[-] index.html [edit]
[-] os.md [edit]
[-] async_context.html [edit]
[-] readline.json [edit]
[-] async_context.md [edit]
[-] inspector.json [edit]
[-] report.html [edit]
[-] repl.html [edit]
[-] assert.html [edit]
[-] test.md [edit]
[-] packages.json [edit]
[-] perf_hooks.md [edit]
[-] deprecations.md [edit]
[-] intl.json [edit]
[-] webstreams.json [edit]
[-] globals.md [edit]
[-] string_decoder.html [edit]
[-] cluster.html [edit]
[-] perf_hooks.html [edit]
[-] dns.md [edit]
[-] punycode.html [edit]
[-] wasi.json [edit]
[-] n-api.md [edit]
[-] process.html [edit]
[-] dgram.md [edit]
[-] tty.html [edit]
[-] async_hooks.json [edit]
[-] tty.json [edit]
[-] path.md [edit]
[-] dgram.html [edit]
[-] console.json [edit]
[-] intl.html [edit]
[-] tracing.json [edit]
[-] vm.json [edit]
[-] webcrypto.md [edit]
[-] url.html [edit]
[-] console.md [edit]
[-] permissions.json [edit]
[-] synopsis.json [edit]
[-] corepack.md [edit]
[-] embedding.json [edit]
[-] dns.json [edit]
[-] https.md [edit]
[-] documentation.html [edit]
[-] module.json [edit]
[-] process.json [edit]
[-] esm.md [edit]
[-] util.html [edit]
[-] tls.md [edit]
[-] webcrypto.json [edit]
[-] net.json [edit]
[-] http2.json [edit]
[-] cluster.json [edit]
[-] permissions.html [edit]
[-] http2.html [edit]
[-] deprecations.json [edit]
[-] stream.md [edit]
[-] https.json [edit]
[-] url.md [edit]
[-] vm.html [edit]
[-] wasi.md [edit]
[+] assets
[-] diagnostics_channel.html [edit]
[-] stream.json [edit]
[-] all.html [edit]
[-] punycode.json [edit]
[-] url.json [edit]
[-] errors.html [edit]
[-] cli.md [edit]
[-] buffer.json [edit]
[-] worker_threads.json [edit]
[-] globals.html [edit]
[-] string_decoder.json [edit]
[-] console.html [edit]
[-] v8.html [edit]
[-] diagnostics_channel.md [edit]
[-] debugger.json [edit]
[-] child_process.md [edit]
[-] deprecations.html [edit]
[-] os.html [edit]
[-] wasi.html [edit]
[-] domain.md [edit]
[-] os.json [edit]
[-] readline.md [edit]
[-] webstreams.md [edit]
[-] tls.html [edit]
[-] index.json [edit]
[-] intl.md [edit]
[-] tracing.md [edit]
[-] zlib.html [edit]
[-] packages.md [edit]
[-] all.json [edit]
[-] assert.json [edit]
[-] fs.html [edit]
[-] errors.json [edit]
[-] documentation.md [edit]
[-] policy.md [edit]
[-] n-api.json [edit]
[-] timers.html [edit]
[-] cli.json [edit]
[-] modules.md [edit]
[-] http.md [edit]
[-] util.json [edit]
[-] fs.md [edit]
[-] timers.md [edit]
[-] globals.json [edit]
[-] assert.md [edit]
[-] module.html [edit]
[-] dns.html [edit]
[-] net.md [edit]
[-] events.html [edit]
[-] timers.json [edit]
[-] https.html [edit]
[-] crypto.md [edit]
[-] path.html [edit]
[-] addons.md [edit]
[-] net.html [edit]