1<!DOCTYPE html> 2<html lang="en"> 3<head> 4 <meta charset="utf-8"> 5 <meta name="viewport" content="width=device-width"> 6 <meta name="nodejs.org:node-version" content="v18.20.1"> 7 <title>String decoder | Node.js v18.20.1 Documentation</title> 8 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 9 <link rel="stylesheet" href="assets/style.css"> 10 <link rel="stylesheet" href="assets/hljs.css"> 11 <link rel="canonical" href="https://nodejs.org/api/string_decoder.html"> 12 <script async defer src="assets/api.js" type="text/javascript"></script> 13 14</head> 15<body class="alt apidoc" id="api-section-string_decoder"> 16 <div id="content" class="clearfix"> 17 <div id="column2" class="interior"> 18 <div id="intro" class="interior"> 19 <a href="/" title="Go back to the home page"> 20 Node.js 21 </a> 22 </div> 23 <ul> 24<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 25<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 26</ul> 27<hr class="line"> 28<ul> 29<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 30<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 31<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 32<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 33<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 34<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 35<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 36<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 37<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 38<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 39<li><a href="console.html" class="nav-console">Console</a></li> 40<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 41<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 42<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 43<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 44<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 45<li><a href="dns.html" class="nav-dns">DNS</a></li> 46<li><a href="domain.html" class="nav-domain">Domain</a></li> 47<li><a href="errors.html" class="nav-errors">Errors</a></li> 48<li><a href="events.html" class="nav-events">Events</a></li> 49<li><a href="fs.html" class="nav-fs">File system</a></li> 50<li><a href="globals.html" class="nav-globals">Globals</a></li> 51<li><a href="http.html" class="nav-http">HTTP</a></li> 52<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 53<li><a href="https.html" class="nav-https">HTTPS</a></li> 54<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 55<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 56<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 57<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 58<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 59<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 60<li><a href="net.html" class="nav-net">Net</a></li> 61<li><a href="os.html" class="nav-os">OS</a></li> 62<li><a href="path.html" class="nav-path">Path</a></li> 63<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 64<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 65<li><a href="process.html" class="nav-process">Process</a></li> 66<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 67<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 68<li><a href="readline.html" class="nav-readline">Readline</a></li> 69<li><a href="repl.html" class="nav-repl">REPL</a></li> 70<li><a href="report.html" class="nav-report">Report</a></li> 71<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 72<li><a href="stream.html" class="nav-stream">Stream</a></li> 73<li><a href="string_decoder.html" class="nav-string_decoder active">String decoder</a></li> 74<li><a href="test.html" class="nav-test">Test runner</a></li> 75<li><a href="timers.html" class="nav-timers">Timers</a></li> 76<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 77<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 78<li><a href="tty.html" class="nav-tty">TTY</a></li> 79<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 80<li><a href="url.html" class="nav-url">URL</a></li> 81<li><a href="util.html" class="nav-util">Utilities</a></li> 82<li><a href="v8.html" class="nav-v8">V8</a></li> 83<li><a href="vm.html" class="nav-vm">VM</a></li> 84<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 85<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 86<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 87<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 88<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 89</ul> 90<hr class="line"> 91<ul> 92<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 93</ul> 94 </div> 95 96 <div id="column1" data-id="string_decoder" class="interior"> 97 <header class="header"> 98 <div class="header-container"> 99 <h1>Node.js v18.20.1 documentation</h1> 100 <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 101 <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 102 <path fill="none" d="M0 0h24v24H0z" /> 103 <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/> 104 <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/> 105 </svg> 106 <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 107 <path d="M0 0h24v24H0z" fill="none" /> 108 <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/> 109 </svg> 110 </button> 111 </div> 112 <div id="gtoc"> 113 <ul> 114 <li class="pinned-header">Node.js v18.20.1</li> 115 116 <li class="picker-header"> 117 <a href="#"> 118 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 119 Table of contents 120 </a> 121 122 <div class="picker"><div class="toc"><ul> 123<li><span class="stability_2"><a href="#string-decoder">String decoder</a></span> 124<ul> 125<li><a href="#class-stringdecoder">Class: <code>StringDecoder</code></a> 126<ul> 127<li><a href="#new-stringdecoderencoding"><code>new StringDecoder([encoding])</code></a></li> 128<li><a href="#stringdecoderendbuffer"><code>stringDecoder.end([buffer])</code></a></li> 129<li><a href="#stringdecoderwritebuffer"><code>stringDecoder.write(buffer)</code></a></li> 130</ul> 131</li> 132</ul> 133</li> 134</ul></div></div> 135 </li> 136 137 138 <li class="picker-header"> 139 <a href="#"> 140 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 141 Index 142 </a> 143 144 <div class="picker"><ul> 145<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 146<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 147 148 <li> 149 <a href="index.html">Index</a> 150 </li> 151 </ul> 152 153<hr class="line"> 154<ul> 155<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 156<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 157<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 158<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 159<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 160<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 161<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 162<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 163<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 164<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 165<li><a href="console.html" class="nav-console">Console</a></li> 166<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 167<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 168<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 169<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 170<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 171<li><a href="dns.html" class="nav-dns">DNS</a></li> 172<li><a href="domain.html" class="nav-domain">Domain</a></li> 173<li><a href="errors.html" class="nav-errors">Errors</a></li> 174<li><a href="events.html" class="nav-events">Events</a></li> 175<li><a href="fs.html" class="nav-fs">File system</a></li> 176<li><a href="globals.html" class="nav-globals">Globals</a></li> 177<li><a href="http.html" class="nav-http">HTTP</a></li> 178<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 179<li><a href="https.html" class="nav-https">HTTPS</a></li> 180<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 181<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 182<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 183<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 184<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 185<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 186<li><a href="net.html" class="nav-net">Net</a></li> 187<li><a href="os.html" class="nav-os">OS</a></li> 188<li><a href="path.html" class="nav-path">Path</a></li> 189<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 190<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 191<li><a href="process.html" class="nav-process">Process</a></li> 192<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 193<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 194<li><a href="readline.html" class="nav-readline">Readline</a></li> 195<li><a href="repl.html" class="nav-repl">REPL</a></li> 196<li><a href="report.html" class="nav-report">Report</a></li> 197<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 198<li><a href="stream.html" class="nav-stream">Stream</a></li> 199<li><a href="string_decoder.html" class="nav-string_decoder active">String decoder</a></li> 200<li><a href="test.html" class="nav-test">Test runner</a></li> 201<li><a href="timers.html" class="nav-timers">Timers</a></li> 202<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 203<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 204<li><a href="tty.html" class="nav-tty">TTY</a></li> 205<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 206<li><a href="url.html" class="nav-url">URL</a></li> 207<li><a href="util.html" class="nav-util">Utilities</a></li> 208<li><a href="v8.html" class="nav-v8">V8</a></li> 209<li><a href="vm.html" class="nav-vm">VM</a></li> 210<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 211<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 212<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 213<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 214<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 215</ul> 216<hr class="line"> 217<ul> 218<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 219</ul></div> 220 </li> 221 222 223 <li class="picker-header"> 224 <a href="#"> 225 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 226 Other versions 227 </a> 228 <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/string_decoder.html">21.x</a></li> 229<li><a href="https://nodejs.org/docs/latest-v20.x/api/string_decoder.html">20.x <b>LTS</b></a></li> 230<li><a href="https://nodejs.org/docs/latest-v19.x/api/string_decoder.html">19.x</a></li> 231<li><a href="https://nodejs.org/docs/latest-v18.x/api/string_decoder.html">18.x <b>LTS</b></a></li> 232<li><a href="https://nodejs.org/docs/latest-v17.x/api/string_decoder.html">17.x</a></li> 233<li><a href="https://nodejs.org/docs/latest-v16.x/api/string_decoder.html">16.x</a></li> 234<li><a href="https://nodejs.org/docs/latest-v15.x/api/string_decoder.html">15.x</a></li> 235<li><a href="https://nodejs.org/docs/latest-v14.x/api/string_decoder.html">14.x</a></li> 236<li><a href="https://nodejs.org/docs/latest-v13.x/api/string_decoder.html">13.x</a></li> 237<li><a href="https://nodejs.org/docs/latest-v12.x/api/string_decoder.html">12.x</a></li> 238<li><a href="https://nodejs.org/docs/latest-v11.x/api/string_decoder.html">11.x</a></li> 239<li><a href="https://nodejs.org/docs/latest-v10.x/api/string_decoder.html">10.x</a></li> 240<li><a href="https://nodejs.org/docs/latest-v9.x/api/string_decoder.html">9.x</a></li> 241<li><a href="https://nodejs.org/docs/latest-v8.x/api/string_decoder.html">8.x</a></li> 242<li><a href="https://nodejs.org/docs/latest-v7.x/api/string_decoder.html">7.x</a></li> 243<li><a href="https://nodejs.org/docs/latest-v6.x/api/string_decoder.html">6.x</a></li> 244<li><a href="https://nodejs.org/docs/latest-v5.x/api/string_decoder.html">5.x</a></li> 245<li><a href="https://nodejs.org/docs/latest-v4.x/api/string_decoder.html">4.x</a></li> 246<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/string_decoder.html">0.12.x</a></li> 247<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/string_decoder.html">0.10.x</a></li></ol></div> 248 </li> 249 250 <li class="picker-header"> 251 <a href="#"> 252 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 253 Options 254 </a> 255 256 <div class="picker"> 257 <ul> 258 <li> 259 <a href="all.html">View on single page</a> 260 </li> 261 <li> 262 <a href="string_decoder.json">View as JSON</a> 263 </li> 264 <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/string_decoder.md">Edit on GitHub</a></li> 265 </ul> 266 </div> 267 </li> 268 </ul> 269 </div> 270 <hr> 271 </header> 272 273 <details id="toc" open><summary>Table of contents</summary><ul> 274<li><span class="stability_2"><a href="#string-decoder">String decoder</a></span> 275<ul> 276<li><a href="#class-stringdecoder">Class: <code>StringDecoder</code></a> 277<ul> 278<li><a href="#new-stringdecoderencoding"><code>new StringDecoder([encoding])</code></a></li> 279<li><a href="#stringdecoderendbuffer"><code>stringDecoder.end([buffer])</code></a></li> 280<li><a href="#stringdecoderwritebuffer"><code>stringDecoder.write(buffer)</code></a></li> 281</ul> 282</li> 283</ul> 284</li> 285</ul></details> 286 287 <div id="apicontent"> 288 <h2>String decoder<span><a class="mark" href="#string-decoder" id="string-decoder">#</a></span><a aria-hidden="true" class="legacy" id="string_decoder_string_decoder"></a></h2> 289 290<p></p><div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div><p></p> 291<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.20.1/lib/string_decoder.js">lib/string_decoder.js</a></p> 292<p>The <code>node:string_decoder</code> module provides an API for decoding <code>Buffer</code> objects 293into strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16 294characters. It can be accessed using:</p> 295<pre><code class="language-js"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">StringDecoder</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:string_decoder'</span>);</code> <button class="copy-button">copy</button></pre> 296<p>The following example shows the basic use of the <code>StringDecoder</code> class.</p> 297<pre><code class="language-js"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">StringDecoder</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:string_decoder'</span>); 298<span class="hljs-keyword">const</span> decoder = <span class="hljs-keyword">new</span> <span class="hljs-title class_">StringDecoder</span>(<span class="hljs-string">'utf8'</span>); 299 300<span class="hljs-keyword">const</span> cent = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>([<span class="hljs-number">0xC2</span>, <span class="hljs-number">0xA2</span>]); 301<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(decoder.<span class="hljs-title function_">write</span>(cent)); <span class="hljs-comment">// Prints: ¢</span> 302 303<span class="hljs-keyword">const</span> euro = <span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>([<span class="hljs-number">0xE2</span>, <span class="hljs-number">0x82</span>, <span class="hljs-number">0xAC</span>]); 304<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(decoder.<span class="hljs-title function_">write</span>(euro)); <span class="hljs-comment">// Prints: €</span></code> <button class="copy-button">copy</button></pre> 305<p>When a <code>Buffer</code> instance is written to the <code>StringDecoder</code> instance, an 306internal buffer is used to ensure that the decoded string does not contain 307any incomplete multibyte characters. These are held in the buffer until the 308next call to <code>stringDecoder.write()</code> or until <code>stringDecoder.end()</code> is called.</p> 309<p>In the following example, the three UTF-8 encoded bytes of the European Euro 310symbol (<code>€</code>) are written over three separate operations:</p> 311<pre><code class="language-js"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">StringDecoder</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:string_decoder'</span>); 312<span class="hljs-keyword">const</span> decoder = <span class="hljs-keyword">new</span> <span class="hljs-title class_">StringDecoder</span>(<span class="hljs-string">'utf8'</span>); 313 314decoder.<span class="hljs-title function_">write</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>([<span class="hljs-number">0xE2</span>])); 315decoder.<span class="hljs-title function_">write</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>([<span class="hljs-number">0x82</span>])); 316<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(decoder.<span class="hljs-title function_">end</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>([<span class="hljs-number">0xAC</span>]))); <span class="hljs-comment">// Prints: €</span></code> <button class="copy-button">copy</button></pre> 317<section><h3>Class: <code>StringDecoder</code><span><a class="mark" href="#class-stringdecoder" id="class-stringdecoder">#</a></span><a aria-hidden="true" class="legacy" id="string_decoder_class_stringdecoder"></a></h3> 318<h4><code>new StringDecoder([encoding])</code><span><a class="mark" href="#new-stringdecoderencoding" id="new-stringdecoderencoding">#</a></span><a aria-hidden="true" class="legacy" id="string_decoder_new_stringdecoder_encoding"></a></h4> 319<div class="api_metadata"> 320<span>Added in: v0.1.99</span> 321</div> 322<ul> 323<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The character <a href="buffer.html#buffers-and-character-encodings">encoding</a> the <code>StringDecoder</code> will use. 324<strong>Default:</strong> <code>'utf8'</code>.</li> 325</ul> 326<p>Creates a new <code>StringDecoder</code> instance.</p> 327<h4><code>stringDecoder.end([buffer])</code><span><a class="mark" href="#stringdecoderendbuffer" id="stringdecoderendbuffer">#</a></span><a aria-hidden="true" class="legacy" id="string_decoder_stringdecoder_end_buffer"></a></h4> 328<div class="api_metadata"> 329<span>Added in: v0.9.3</span> 330</div> 331<ul> 332<li><code>buffer</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="buffer.html#class-buffer" class="type"><Buffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView" class="type"><DataView></a> The bytes to decode.</li> 333<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 334</ul> 335<p>Returns any remaining input stored in the internal buffer as a string. Bytes 336representing incomplete UTF-8 and UTF-16 characters will be replaced with 337substitution characters appropriate for the character encoding.</p> 338<p>If the <code>buffer</code> argument is provided, one final call to <code>stringDecoder.write()</code> 339is performed before returning the remaining input. 340After <code>end()</code> is called, the <code>stringDecoder</code> object can be reused for new input.</p> 341<h4><code>stringDecoder.write(buffer)</code><span><a class="mark" href="#stringdecoderwritebuffer" id="stringdecoderwritebuffer">#</a></span><a aria-hidden="true" class="legacy" id="string_decoder_stringdecoder_write_buffer"></a></h4> 342<div class="api_metadata"> 343<details class="changelog"><summary>History</summary> 344<table> 345<tbody><tr><th>Version</th><th>Changes</th></tr> 346<tr><td>v8.0.0</td> 347<td><p>Each invalid character is now replaced by a single replacement character instead of one for each individual byte.</p></td></tr> 348<tr><td>v0.1.99</td> 349<td><p><span>Added in: v0.1.99</span></p></td></tr> 350</tbody></table> 351</details> 352</div> 353<ul> 354<li><code>buffer</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="buffer.html#class-buffer" class="type"><Buffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView" class="type"><DataView></a> The bytes to decode.</li> 355<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 356</ul> 357<p>Returns a decoded string, ensuring that any incomplete multibyte characters at 358the end of the <code>Buffer</code>, or <code>TypedArray</code>, or <code>DataView</code> are omitted from the 359returned string and stored in an internal buffer for the next call to 360<code>stringDecoder.write()</code> or <code>stringDecoder.end()</code>.</p></section> 361 <!-- API END --> 362 </div> 363 </div> 364 </div> 365</body> 366</html> 367