Skip to main content

write

method Buffer.write
Jump to headingBuffer.write(
string: string,
encoding?: BufferEncoding,
): number

Writes 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 Jump to heading

Jump to headingstring: string

String to write to buf.

optional
Jump to headingencoding: BufferEncoding = 'utf8'

The character encoding of string.

Return Type Jump to heading

number

Number of bytes written.

Jump to headingBuffer.write(
string: string,
offset: number,
encoding?: BufferEncoding,
): number

Parameters Jump to heading

Jump to headingstring: string
Jump to headingoffset: number

Return Type Jump to heading

number
Jump to headingBuffer.write(
string: string,
offset: number,
length: number,
encoding?: BufferEncoding,
): number

Parameters Jump to heading

Jump to headingstring: string
Jump to headingoffset: number
Jump to headinglength: number

Return Type Jump to heading

number
Back to top