method

fs.promises.FileHandle.write

write<TBuffer extends Uint8Array<ArrayBufferLike>>(

buffer: TBuffer,

offset?: null | number,

length?: null | number,

position?: null | number

): Promise<{ buffer: TBuffer; bytesWritten: number }>;

Write buffer to the file.

The promise is fulfilled with an object containing two properties:

It is unsafe to use filehandle.write() multiple times on the same file without waiting for the promise to be fulfilled (or rejected). For this scenario, use filehandle.createWriteStream().

On Linux, positional writes do not work when the file is opened in append mode. The kernel ignores the position argument and always appends the data to the end of the file.

@param offset

The start position from within buffer where the data to write begins.

@param length

The number of bytes from buffer to write.

@param position

The offset from the beginning of the file where the data from buffer should be written. If position is not a number, the data will be written at the current position. See the POSIX pwrite(2) documentation for more detail.

write<TBuffer extends Uint8Array<ArrayBufferLike>>(

buffer: TBuffer,

options?: { length: number; offset: number; position: number }

): Promise<{ buffer: TBuffer; bytesWritten: number }>;

write(

data: string,

position?: null | number,

encoding?: null | BufferEncoding

): Promise<{ buffer: string; bytesWritten: number }>;