From c19dbc9b250f16752841d5d3a6089e71dd1699e4 Mon Sep 17 00:00:00 2001 From: Xavier Stouder Date: Wed, 17 May 2023 20:39:30 +0200 Subject: [PATCH] fix: markdown formatting --- doc/api/buffer.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 49f3146b77f3ff..362c4bdee13247 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -3783,14 +3783,16 @@ console.log(bytesWritten); ### `buf.base64urlWrite(string[, offset[, length]])` * `string` {string} String to write to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write `string`. **Default**: 0. -* `length` {integer} Maximum number of bytes to write. **Default**: `buf.length - offset`. +* `offset` {integer} Number of bytes to skip before starting to write `string`. + **Default**: 0. +* `length` {integer} Maximum number of bytes to write. + **Default**: `buf.length - offset`. * Returns: {integer} The number of bytes written. -Writes `string` to `buf` at `offset` according to the base64url character encoding -and returns the number of bytes written. 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. +Writes `string` to `buf` at `offset` according to the base64url character +encoding and returns the number of bytes written. 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. In most cases, `buf.write` is preferable, especially if `encoding` is variable.