method Buffer.write
Overload 1
#Buffer.write(string: string,encoding?: BufferEncoding,): numberWrites string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did
not contain enough space to fit the entire string, only part of string will be
written. However, partially encoded characters will not be written.
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(256);
const len = buf.write('\u00bd + \u00bc = \u00be', 0);
console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
// Prints: 12 bytes: ½ + ¼ = ¾
const buffer = Buffer.alloc(10);
const length = buffer.write('abcd', 8);
console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
// Prints: 2 bytes : ab
Parameters #
#string: string String to write to buf.
#encoding: BufferEncoding = 'utf8' optional
The character encoding of string.
Return Type #
number Number of bytes written.
Overload 2
#Buffer.write(): numberOverload 3
#Buffer.write(): number