Skip to content

Commit a2526d0

Browse files
committed
doc: lint markdown
1 parent 3e2bb60 commit a2526d0

File tree

1 file changed

+51
-27
lines changed

1 file changed

+51
-27
lines changed

doc/api/buffer.md

+51-27
Original file line numberDiff line numberDiff line change
@@ -3515,16 +3515,18 @@ console.log(buf.toString());
35153515
// Also prints: cuffer (!)
35163516
```
35173517

3518-
35193518
### `buf.asciiSlice([start[, end]])`
35203519

35213520
* `start` {integer} The byte offset to start slicing at. **Default**: 0.
3522-
* `end` {integer} The byte offset to stop slicing at (not inclusive). **Default**: `buf.length`.
3521+
* `end` {integer} The byte offset to stop slicing at (not inclusive).
3522+
**Default**: `buf.length`.
35233523
* Returns: {string}
35243524

3525-
Decodes buf to a string according ASCII character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
3525+
Decodes buf to a string according ASCII character encoding. `start` and
3526+
`end` may be passed to decode only a subset of `buf`.
35263527

3527-
In most cases, `buf.toString()` is preferable, especially if encoding is variable.
3528+
In most cases, `buf.toString()` is preferable, especially if encoding is
3529+
variable.
35283530

35293531
```mjs
35303532
import { Buffer } from 'node:buffer';
@@ -3547,10 +3549,12 @@ console.log(buf.asciiSlice(0, 3));
35473549
### `buf.base64Slice([start[, end]])`
35483550

35493551
* `start` {integer} The byte offset to start slicing at. **Default**: 0.
3550-
* `end` {integer} The byte offset to stop decoding at (not inclusive). **Default**: `buf.length`.
3552+
* `end` {integer} The byte offset to stop decoding at (not inclusive).
3553+
**Default**: `buf.length`.
35513554
* Returns: {string}
35523555

3553-
Decodes buf to a string according to base64 character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
3556+
Decodes buf to a string according to base64 character encoding. `start` and
3557+
`end` may be passed to decode only a subset of `buf`.
35543558

35553559
```mjs
35563560
import { Buffer } from 'node:buffer';
@@ -3573,10 +3577,12 @@ console.log(buf.base64Slice(0, 3));
35733577
### `buf.base64urlSlice([start[, end]])`
35743578

35753579
* `start` {integer} The byte offset to start slicing at. **Default**: 0.
3576-
* `end` {integer} The byte offset to stop decoding at (not inclusive). **Default**: `buf.length`.
3580+
* `end` {integer} The byte offset to stop decoding at (not inclusive).
3581+
**Default**: `buf.length`.
35773582
* Returns: {string}
35783583

3579-
Decodes buf to a string according to base64url character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
3584+
Decodes buf to a string according to base64url character encoding. `start`
3585+
and `end` may be passed to decode only a subset of `buf`.
35803586

35813587
```mjs
35823588
import { Buffer } from 'node:buffer';
@@ -3599,10 +3605,12 @@ console.log(buf.base64urlSlice(0, 3));
35993605
### `buf.hexSlice([start[, end]])`
36003606

36013607
* `start` {integer} The byte offset to start slicing at. **Default**: 0.
3602-
* `end` {integer} The byte offset to stop decoding at (not inclusive). **Default**: `buf.length`.
3608+
* `end` {integer} The byte offset to stop decoding at (not inclusive).
3609+
**Default**: `buf.length`.
36033610
* Returns: {string}
36043611

3605-
Decodes buf to a string according to hex character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
3612+
Decodes buf to a string according to hex character encoding. `start` and
3613+
`end` may be passed to decode only a subset of `buf`.
36063614

36073615
```mjs
36083616
import { Buffer } from 'node:buffer';
@@ -3625,10 +3633,12 @@ console.log(buf.hexSlice(0, 3));
36253633
### `buf.latin1Slice([start[, end]])`
36263634

36273635
* `start` {integer} The byte offset to start slicing at. **Default**: 0.
3628-
* `end` {integer} The byte offset to stop slicing at (not inclusive). **Default**: `buf.length`.
3636+
* `end` {integer} The byte offset to stop slicing at (not inclusive).
3637+
**Default**: `buf.length`.
36293638
* Returns: {string}
36303639

3631-
Decodes buf to a string according to latin1 character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
3640+
Decodes buf to a string according to latin1 character encoding. `start` and
3641+
`end` may be passed to decode only a subset of `buf`.
36323642

36333643
```mjs
36343644
import { Buffer } from 'node:buffer';
@@ -3651,10 +3661,12 @@ console.log(buf.latin1Slice(0, 3));
36513661
### `buf.ucs2Slice([start[, end]])`
36523662

36533663
* `start` {integer} The byte offset to start slicing at. **Default**: 0.
3654-
* `end` {integer} The byte offset to stop slicing at (not inclusive). **Default**: `buf.length`.
3664+
* `end` {integer} The byte offset to stop slicing at (not inclusive).
3665+
**Default**: `buf.length`.
36553666
* Returns: {string}
36563667

3657-
Decodes buf to a string according to UCS-2 character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
3668+
Decodes buf to a string according to UCS-2 character encoding. `start` and
3669+
`end` may be passed to decode only a subset of `buf`.
36583670

36593671
```mjs
36603672
import { Buffer } from 'node:buffer';
@@ -3677,10 +3689,12 @@ console.log(buf.ucs2Slice(0, 3));
36773689
### `buf.utf8Slice([start[, end]])`
36783690

36793691
* `start` {integer} The byte offset to start slicing at. **Default**: 0.
3680-
* `end` {integer} The byte offset to stop slicing at (not inclusive). **Default**: `buf.length`.
3692+
* `end` {integer} The byte offset to stop slicing at (not inclusive).
3693+
**Default**: `buf.length`.
36813694
* Returns: {string}
36823695

3683-
Decodes buf to a string according to UTF-8 character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
3696+
Decodes buf to a string according to UTF-8 character encoding. `start` and
3697+
`end` may be passed to decode only a subset of `buf`.
36843698

36853699
```mjs
36863700
import { Buffer } from 'node:buffer';
@@ -3703,12 +3717,14 @@ console.log(buf.utf8Slice(0, 3));
37033717
### `buf.asciiWrite(string[, offset[, length]])`
37043718

37053719
* `string` {string} String to write to `buf`.
3706-
* `offset` {integer} Number of bytes to skip before starting to write `string`. **Default**: 0.
3707-
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.length - offset`.
3720+
* `offset` {integer} Number of bytes to skip before starting to write
3721+
`string`. **Default**: 0.
3722+
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.
3723+
length - offset`.
37083724

37093725
Writes `string` to `buf` at `offset` according to the ASCII character encoding
37103726
and returns the number of bytes written. If `buf` did not contain enough space
3711-
to fit the entire string, only part of `string` will be written. However,
3727+
to fit the entire string, only part of `string` will be written. However,
37123728
partially encoded characters will not be written.
37133729

37143730
In most cases, `buf.write` is preferable, especially if `encoding` is variable.
@@ -3733,8 +3749,10 @@ console.log(bytesWritten);
37333749
### `buf.base64Write(string[, offset[, length]])`
37343750

37353751
* `string` {string} String to write to `buf`.
3736-
* `offset` {integer} Number of bytes to skip before starting to write `string`. **Default**: 0.
3737-
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.length - offset`.
3752+
* `offset` {integer} Number of bytes to skip before starting to write
3753+
`string`. **Default**: 0.
3754+
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.
3755+
length - offset`.
37383756
* Returns: {integer} The number of bytes written.
37393757

37403758
Writes `string` to `buf` at `offset` according to the base64 character encoding
@@ -3797,8 +3815,10 @@ console.log(bytesWritten);
37973815
### `buf.hexWrite(string[, offset[, length]])`
37983816

37993817
* `string` {string} String to write to `buf`.
3800-
* `offset` {integer} Number of bytes to skip before starting to write `string`. **Default**: 0.
3801-
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.length - offset`.
3818+
* `offset` {integer} Number of bytes to skip before starting to write
3819+
`string`. **Default**: 0.
3820+
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.
3821+
length - offset`.
38023822
* Returns: {integer} The number of bytes written.
38033823

38043824
Writes `string` to `buf` at `offset` according to the hex character encoding
@@ -3829,8 +3849,10 @@ console.log(bytesWritten);
38293849
### `buf.latin1Write(string[, offset[, length]])`
38303850

38313851
* `string` {string} String to write to `buf`.
3832-
* `offset` {integer} Number of bytes to skip before starting to write `string`. **Default**: 0.
3833-
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.length - offset`.
3852+
* `offset` {integer} Number of bytes to skip before starting to write
3853+
`string`. **Default**: 0.
3854+
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.
3855+
length - offset`.
38343856
* Returns: {integer} The number of bytes written.
38353857

38363858
Writes `string` to `buf` at `offset` according to the latin1 character encoding
@@ -3861,8 +3883,10 @@ console.log(bytesWritten);
38613883
### `buf.utf8Write(string[, offset[, length]])`
38623884

38633885
* `string` {string} String to write to `buf`.
3864-
* `offset` {integer} Number of bytes to skip before starting to write `string`. **Default**: 0.
3865-
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.length - offset`.
3886+
* `offset` {integer} Number of bytes to skip before starting to write
3887+
`string`. **Default**: 0.
3888+
* `length` {integer} Maximum number of bytes to write. **Default**: `buf.
3889+
length - offset`.
38663890
* Returns: {integer} The number of bytes written.
38673891

38683892
Writes `string` to `buf` at `offset` according to the utf8 character encoding

0 commit comments

Comments
 (0)