diff options
Diffstat (limited to 'doc/api/buffer.md')
| -rw-r--r-- | doc/api/buffer.md | 72 |
1 files changed, 47 insertions, 25 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 2842b6d7b0..10ad944b37 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -1509,7 +1509,8 @@ changes: uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - 8`. * Returns: {number} Reads a 64-bit double from `buf` at the specified `offset` with specified @@ -1541,7 +1542,8 @@ changes: uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 4`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - 4`. * Returns: {number} Reads a 32-bit float from `buf` at the specified `offset` with specified @@ -1572,7 +1574,8 @@ changes: uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 1`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - 1`. * Returns: {integer} Reads a signed 8-bit integer from `buf` at the specified `offset`. @@ -1601,7 +1604,8 @@ changes: uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 2`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - 2`. * Returns: {integer} Reads a signed 16-bit integer from `buf` at the specified `offset` with @@ -1632,7 +1636,8 @@ changes: uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 4`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - 4`. * Returns: {integer} Reads a signed 32-bit integer from `buf` at the specified `offset` with @@ -1663,8 +1668,10 @@ changes: byteLength to uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - byteLength`. -* `byteLength` {integer} Number of bytes to read. Must satisfy: `0 < byteLength <= 6`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - byteLength`. +* `byteLength` {integer} Number of bytes to read. Must satisfy + `0 < byteLength <= 6`. * Returns: {integer} Reads `byteLength` number of bytes from `buf` at the specified `offset` @@ -1694,7 +1701,8 @@ changes: uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 1`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - 1`. * Returns: {integer} Reads an unsigned 8-bit integer from `buf` at the specified `offset`. @@ -1721,7 +1729,8 @@ changes: uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 2`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - 2`. * Returns: {integer} Reads an unsigned 16-bit integer from `buf` at the specified `offset` with @@ -1754,7 +1763,8 @@ changes: uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 4`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - 4`. * Returns: {integer} Reads an unsigned 32-bit integer from `buf` at the specified `offset` with @@ -1783,8 +1793,10 @@ changes: byteLength to uint32 anymore. --> -* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - byteLength`. -* `byteLength` {integer} Number of bytes to read. Must satisfy: `0 < byteLength <= 6`. +* `offset` {integer} Number of bytes to skip before starting to read. Must + satisfy `0 <= offset <= buf.length - byteLength`. +* `byteLength` {integer} Number of bytes to read. Must satisfy + `0 < byteLength <= 6`. * Returns: {integer} Reads `byteLength` number of bytes from `buf` at the specified `offset` @@ -2095,7 +2107,8 @@ changes: --> * `value` {number} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`. +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - 8`. * Returns: {integer} `offset` plus the number of bytes written. Writes `value` to `buf` at the specified `offset` with specified endian @@ -2129,7 +2142,8 @@ changes: --> * `value` {number} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 4`. +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - 4`. * Returns: {integer} `offset` plus the number of bytes written. Writes `value` to `buf` at the specified `offset` with specified endian @@ -2162,7 +2176,8 @@ changes: --> * `value` {integer} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 1`. +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - 1`. * Returns: {integer} `offset` plus the number of bytes written. Writes `value` to `buf` at the specified `offset`. `value` *should* be a valid @@ -2193,7 +2208,8 @@ changes: --> * `value` {integer} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 2`. +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - 2`. * Returns: {integer} `offset` plus the number of bytes written. Writes `value` to `buf` at the specified `offset` with specified endian @@ -2225,7 +2241,8 @@ changes: --> * `value` {integer} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 4`. +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - 4`. * Returns: {integer} `offset` plus the number of bytes written. Writes `value` to `buf` at the specified `offset` with specified endian @@ -2257,8 +2274,10 @@ changes: --> * `value` {integer} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - byteLength`. -* `byteLength` {integer} Number of bytes to write. Must satisfy: `0 < byteLength <= 6`. +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - byteLength`. +* `byteLength` {integer} Number of bytes to write. Must satisfy + `0 < byteLength <= 6`. * Returns: {integer} `offset` plus the number of bytes written. Writes `byteLength` bytes of `value` to `buf` at the specified `offset`. @@ -2290,7 +2309,8 @@ changes: --> * `value` {integer} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 1`. +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - 1`. * Returns: {integer} `offset` plus the number of bytes written. Writes `value` to `buf` at the specified `offset`. `value` *should* be a @@ -2321,7 +2341,8 @@ changes: --> * `value` {integer} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 2`. +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - 2`. * Returns: {integer} `offset` plus the number of bytes written. Writes `value` to `buf` at the specified `offset` with specified endian @@ -2357,7 +2378,8 @@ changes: --> * `value` {integer} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 4`. +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - 4`. * Returns: {integer} `offset` plus the number of bytes written. Writes `value` to `buf` at the specified `offset` with specified endian @@ -2391,9 +2413,9 @@ changes: --> * `value` {integer} Number to be written to `buf`. -* `offset` {integer} Number of bytes to skip before starting to write. - Must satisfy: `0 <= offset <= buf.length - byteLength`. -* `byteLength` {integer} Number of bytes to write. Must satisfy: +* `offset` {integer} Number of bytes to skip before starting to write. Must + satisfy `0 <= offset <= buf.length - byteLength`. +* `byteLength` {integer} Number of bytes to write. Must satisfy `0 < byteLength <= 6`. * Returns: {integer} `offset` plus the number of bytes written. |