Readonly
clientReadonly
detailReadonly
instanceReadonly
shortOptional
stackReadonly
statusReadonly
taskReadonly
titleReadonly
typeStatic
Optional
prepareOptional override for formatting stack traces
-Static
stackStatic
captureStatic
fromGenerated using TypeDoc
Readonly
clientReadonly
detailReadonly
instanceReadonly
shortOptional
stackReadonly
statusReadonly
taskReadonly
titleReadonly
typeStatic
Optional
prepareOptional override for formatting stack traces
+Static
stackStatic
captureStatic
fromGenerated using TypeDoc
Static
parseGenerated using TypeDoc
Static
parseGenerated using TypeDoc
A client for interacting with DAP servers, as specified by +
A client for interacting with DAP servers, as specified by
draft-ietf-ppm-dap-02. Instances
of this class contain all of the necessary functionality to
generate a privacy-preserving measurement report for the provided
ClientVdaf
, such as an implementation of Prio3, as specified by
draft-irtf-cfrg-vdaf-03.
Builds a new Task from the ClientParameters
provided.
Static
Readonly
protocolthe protocol version for this task, usually in the form dap-{nn}
Builds a new Task from the ClientParameters
provided.
Static
Readonly
protocolthe protocol version for this task, usually in the form dap-{nn}
Fetches hpke configuration from the configured aggregators over the network. This will make one http/https request for each aggregator (leader and helper).
DAPError
if any response is not Ok.
Produce a Report
from the supplied Measurement
This may make network requests to fetch key configuration from the leader and helper, if needed.
The type of this argument will be determined by the Vdaf that this task is constructed for.
Optional
options: ReportOptionsError
if there is any issue in generating the report
A convenience function to fetch the key configuration (if needed), generate a report from the provided measurement and send that report to the leader aggregator.
This will call Task.generateReport
and
@@ -32,7 +32,7 @@
retry.
Optional
options: ReportOptionsDAPError
if any http response is not Ok or
Error
if there is an issue generating the report
Sends a pregenerated Report
to the leader aggregator.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional
hpkeConfigList: HpkeConfigListOptional
hpkeStatic
helperStatic
leaderGenerated using TypeDoc
Optional
hpkeConfigList: HpkeConfigListOptional
hpkeStatic
helperStatic
leaderGenerated using TypeDoc
The Hybrid Public Key Encryption (HPKE) ciphersuite, +
The Hybrid Public Key Encryption (HPKE) ciphersuite, which supports all of the ciphersuites defined in RFC9180.
The class consists of the @hpke/core, @@ -27,49 +27,49 @@
import { AeadId, CipherSuite, KdfId } from "http://deno.land/x/hpke/mod.ts";
// Use an extension module.
import {
HybridkemX25519Kyber768,
} from "https://deno.land/x/hpke/x/hybridkem-x25519-kyber768/mod.ts";
const suite = new CipherSuite({
kem: new HybridkemX25519Kyber768(),
kdf: KdfId.HkdfSha256,
aead: AeadId.Aes128Gcm,
});
-A set of parameters for building a cipher suite.
+A set of parameters for building a cipher suite.
InvalidParamError
-Protected
_apiProtected
_kemGets the AEAD context of the ciphersuite.
-Gets the KDF context of the ciphersuite.
-Gets the KEM context of the ciphersuite.
-Protected
_setupCreates an encryption context for a recipient.
+Protected
_apiProtected
_kemGets the AEAD context of the ciphersuite.
+Gets the KDF context of the ciphersuite.
+Gets the KEM context of the ciphersuite.
+Protected
_setupCreates an encryption context for a recipient.
If the error occurred, throws DecapError | DeserializeError | ValidationError.
A set of parameters for the recipient encryption context.
A recipient encryption context.
DecapError, DeserializeError, ValidationError
-Creates an encryption context for a sender.
+Creates an encryption context for a sender.
If the error occurred, throws DecapError | ValidationError.
A set of parameters for the sender encryption context.
A sender encryption context.
EncapError, ValidationError
-Derives a key pair for the cipher suite in the manner +
Derives a key pair for the cipher suite in the manner defined in RFC9180 Section 7.1.3.
If the error occurred, throws DeriveKeyPairError.
A byte string of input keying material. The maximum length is 128 bytes.
A key pair derived.
Generates a key pair for the cipher suite.
+Generates a key pair for the cipher suite.
If the error occurred, throws NotSupportedError.
A key pair generated.
Imports a public or private key and converts to a CryptoKey.
Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.
@@ -82,18 +82,18 @@NotSupportedError
A public or private CryptoKey.
Decrypts a message from a sender.
If the error occurred, throws DecapError
| DeserializeError
| OpenError
| ValidationError
.
A set of parameters for building a recipient encryption context.
An encrypted text as bytes to be decrypted.
Optional
aad: ArrayBufferAdditional authenticated data as bytes fed by an application.
A decrypted plain text as bytes.
DecapError, DeserializeError, OpenError, ValidationError
-Encrypts a message to a recipient.
+Encrypts a message to a recipient.
If the error occurred, throws EncapError
| MessageLimitReachedError
| SealError
| ValidationError
.
A set of parameters for building a sender encryption context.
A plain text as bytes to be encrypted.
Optional
aad: ArrayBufferAdditional authenticated data as bytes fed by an application.
A cipher text and an encapsulated key as bytes.
EncapError, MessageLimitReachedError, SealError, ValidationError
-Generated using TypeDoc
Generated using TypeDoc
The Hybrid Public Key Encryption (HPKE) ciphersuite, +
The Hybrid Public Key Encryption (HPKE) ciphersuite, which is implemented using only Web Cryptography API.
This is the super class of CipherSuite and the same as @@ -35,46 +35,46 @@
import { Aes128Gcm, HkdfSha256, CipherSuite } from "http://deno.land/x/hpke/mod.ts";
// Use an extension module.
import { DhkemX25519HkdfSha256 } from "https://deno.land/x/hpke/x/dhkem-x25519/mod.ts";
const suite = new CipherSuite({
kem: new DhkemX25519HkdfSha256(),
kdf: new HkdfSha256(),
aead: new Aes128Gcm(),
});
-A set of parameters for building a cipher suite.
+A set of parameters for building a cipher suite.
If the error occurred, throws InvalidParamError.
InvalidParamError
-Protected
_apiProtected
_kemGets the AEAD context of the ciphersuite.
-Gets the KDF context of the ciphersuite.
-Gets the KEM context of the ciphersuite.
-Protected
_setupCreates an encryption context for a recipient.
+Protected
_apiProtected
_kemGets the AEAD context of the ciphersuite.
+Gets the KDF context of the ciphersuite.
+Gets the KEM context of the ciphersuite.
+Protected
_setupCreates an encryption context for a recipient.
If the error occurred, throws DecapError | DeserializeError | ValidationError.
A set of parameters for the recipient encryption context.
A recipient encryption context.
DecapError, DeserializeError, ValidationError
-Creates an encryption context for a sender.
+Creates an encryption context for a sender.
If the error occurred, throws DecapError | ValidationError.
A set of parameters for the sender encryption context.
A sender encryption context.
EncapError, ValidationError
-Decrypts a message from a sender.
If the error occurred, throws DecapError
| DeserializeError
| OpenError
| ValidationError
.
A set of parameters for building a recipient encryption context.
An encrypted text as bytes to be decrypted.
Optional
aad: ArrayBufferAdditional authenticated data as bytes fed by an application.
A decrypted plain text as bytes.
DecapError, DeserializeError, OpenError, ValidationError
-Encrypts a message to a recipient.
+Encrypts a message to a recipient.
If the error occurred, throws EncapError
| MessageLimitReachedError
| SealError
| ValidationError
.
A set of parameters for building a sender encryption context.
A plain text as bytes to be encrypted.
Optional
aad: ArrayBufferAdditional authenticated data as bytes fed by an application.
A cipher text and an encapsulated key as bytes.
EncapError, MessageLimitReachedError, SealError, ValidationError
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Static
parseGenerated using TypeDoc
Static
parseGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Protected
_apiProtected
_setupGenerated using TypeDoc
Protected
_apiProtected
_setupGenerated using TypeDoc
Static
fromGenerated using TypeDoc
Static
fromGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Readonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyGenerated using TypeDoc
Readonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyGenerated using TypeDoc
Readonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
chunkReadonly
flpReadonly
idReadonly
lengthReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
chunkReadonly
flpReadonly
idReadonly
lengthReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
bitsReadonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
bitsReadonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
bitsReadonly
chunkReadonly
flpReadonly
idReadonly
lengthReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
bitsReadonly
chunkReadonly
flpReadonly
idReadonly
lengthReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Abstract
Abstract
idAbstract
nonceAbstract
randAbstract
roundsAbstract
sharesAbstract
verifyAbstract
aggregateAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
isAbstract
prepareAbstract
prepareOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyAbstract
shardAbstract
unshardAbstract
unshardGenerated using TypeDoc
Abstract
Abstract
idAbstract
nonceAbstract
randAbstract
roundsAbstract
sharesAbstract
verifyAbstract
aggregateAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
isAbstract
prepareAbstract
prepareOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyAbstract
shardAbstract
unshardAbstract
unshardGenerated using TypeDoc
Abstract
Abstract
nextStatic
deriveStatic
expandGenerated using TypeDoc
Abstract
Abstract
nextStatic
deriveStatic
expandGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Readonly
elementReadonly
modulusGenerated using TypeDoc
Readonly
elementReadonly
modulusGenerated using TypeDoc
Readonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyGenerated using TypeDoc
Readonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyGenerated using TypeDoc
Readonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
chunkReadonly
flpReadonly
idReadonly
lengthReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
chunkReadonly
flpReadonly
idReadonly
lengthReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
bitsReadonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
bitsReadonly
flpReadonly
idReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
bitsReadonly
chunkReadonly
flpReadonly
idReadonly
lengthReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
bitsReadonly
chunkReadonly
flpReadonly
idReadonly
lengthReadonly
nonceReadonly
randReadonly
roundsReadonly
sharesReadonly
verifyReadonly
xofGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Readonly
encodedReadonly
genReadonly
generatorReadonly
modulusGenerated using TypeDoc
Abstract
Abstract
idAbstract
nonceAbstract
randAbstract
roundsAbstract
sharesAbstract
verifyAbstract
aggregateAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
isAbstract
prepareAbstract
prepareOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyAbstract
shardAbstract
unshardAbstract
unshardGenerated using TypeDoc
Abstract
Abstract
idAbstract
nonceAbstract
randAbstract
roundsAbstract
sharesAbstract
verifyAbstract
aggregateAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
isAbstract
prepareAbstract
prepareOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyAbstract
shardAbstract
unshardAbstract
unshardGenerated using TypeDoc
Abstract
Abstract
nextStatic
deriveStatic
expandGenerated using TypeDoc
Abstract
Abstract
nextStatic
deriveStatic
expandGenerated using TypeDoc
Abstract
Abstract
idAbstract
nonceAbstract
randAbstract
roundsAbstract
sharesAbstract
verifyAbstract
aggregateAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
isAbstract
prepareAbstract
prepareOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyAbstract
shardAbstract
unshardAbstract
unshardGenerated using TypeDoc
Abstract
Abstract
idAbstract
nonceAbstract
randAbstract
roundsAbstract
sharesAbstract
verifyAbstract
aggregateAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
encodeAbstract
isAbstract
prepareAbstract
prepareOptional
nonces?: Buffer[]Optional
rands?: Buffer[]Optional
verifyAbstract
shardAbstract
unshardAbstract
unshardGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The main
branch is under continuous development and will usually be partway between DAP and VDAF
@@ -104,4 +104,4 @@
<script
src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
crossorigin="anonymous"
integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The AEAD encryption context interface.
-Decrypts data with an initialization vector and additional authenticated data.
+The AEAD encryption context interface.
+Decrypts data with an initialization vector and additional authenticated data.
An initialization vector.
A plain text as bytes to be encrypted.
Additional authenticated data as bytes fed by an application.
A decrypted plain text as bytes.
-Encrypts data with an initialization vector and additional authenticated data.
+Encrypts data with an initialization vector and additional authenticated data.
An initialization vector.
A plain text as bytes to be encrypted.
Additional authenticated data as bytes fed by an application.
A cipher text as bytes.
-Generated using TypeDoc
Generated using TypeDoc
The AEAD interface.
-Readonly
idThe KDF identifier.
-Readonly
keyThe length in bytes of an AEAD key (Nk).
-Readonly
nonceThe length in bytes of an AEAD nonce (Nn).
-Readonly
tagThe length in bytes of an AEAD authentication tag (Nt).
-Creates an AEAD encryption context which has seal/open operation.
+The AEAD interface.
+Readonly
idThe KDF identifier.
+Readonly
keyThe length in bytes of an AEAD key (Nk).
+Readonly
nonceThe length in bytes of an AEAD nonce (Nn).
+Readonly
tagThe length in bytes of an AEAD authentication tag (Nt).
+Creates an AEAD encryption context which has seal/open operation.
A byte string of the raw key.
An AEAD encryption context.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional
additionalOptional
tagGenerated using TypeDoc
Optional
additionalOptional
tagGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The ArrayBuffer instance referenced by the array.
-The length in bytes of the array.
-The offset in bytes of the array.
-Generated using TypeDoc
The ArrayBuffer instance referenced by the array.
+The length in bytes of the array.
+The offset in bytes of the array.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Readonly
BYTES_The size in bytes of each element in the array.
-Readonly
[toReadonly
bufferThe ArrayBuffer instance referenced by the array.
-Readonly
byteThe length in bytes of the array.
-Readonly
byteThe offset in bytes of the array.
-Readonly
lengthThe length of the array.
-Takes an integer value and returns the item at that index, +
Readonly
BYTES_The size in bytes of each element in the array.
+Readonly
[toReadonly
bufferThe ArrayBuffer instance referenced by the array.
+Readonly
byteThe length in bytes of the array.
+Readonly
byteThe offset in bytes of the array.
+Readonly
lengthThe length of the array.
+Compares buf
with target
and returns a number indicating whether buf
comes before, after, or is the same as target
in sort order.
Comparison is based on the actual sequence of bytes in each Buffer
.
0
is returned if target
is the same as buf
Optional
sourceStart: numberThe offset within buf
at which to begin comparison.
Optional
sourceEnd: numberThe offset within buf
at which to end comparison (not inclusive).
v0.11.13
-Copies data from a region of buf
to a region in target
, even if the target
memory region overlaps with buf
.
TypedArray.prototype.set()
performs the same operation, and is available
for all TypedArrays, including Node.js Buffer
s, although it takes
different function arguments.
Optional
sourceEnd: numberThe offset within buf
at which to stop copying (not inclusive).
The number of bytes copied.
v0.1.90
-Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
If target is negative, it is treated as length+target where length is the length of the array.
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional
end: numberIf not specified, length of the this object is used as its default value.
-Creates and returns an iterator of [index, byte]
pairs from the contents
+
Creates and returns an iterator of [index, byte]
pairs from the contents
of buf
.
import { Buffer } from 'node:buffer';
// Log the entire contents of a `Buffer`.
const buf = Buffer.from('buffer');
for (const pair of buf.entries()) {
console.log(pair);
}
// Prints:
// [0, 98]
// [1, 117]
// [2, 102]
// [3, 102]
// [4, 101]
// [5, 114]
v1.1.0
-Returns true
if both buf
and otherBuffer
have exactly the same bytes,false
otherwise. Equivalent to buf.compare(otherBuffer) === 0
.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('ABC');
const buf2 = Buffer.from('414243', 'hex');
const buf3 = Buffer.from('ABCD');
console.log(buf1.equals(buf2));
// Prints: true
console.log(buf1.equals(buf3));
// Prints: false
A Buffer
or Uint8Array with which to compare buf
.
v0.11.13
-Determines whether all the members of an array satisfy the specified test.
A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Fills buf
with the specified value
. If the offset
and end
are not given,
the entire buf
will be filled:
import { Buffer } from 'node:buffer';
// Fill a `Buffer` with the ASCII character 'h'.
const b = Buffer.allocUnsafe(50).fill('h');
console.log(b.toString());
// Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
// Fill a buffer with empty string
const c = Buffer.allocUnsafe(5).fill('');
console.log(c.fill(''));
// Prints: <Buffer 00 00 00 00 00>
@@ -187,31 +187,31 @@
Optional
encoding: BufferEncodingThe encoding for value
if value
is a string.
A reference to buf
.
v0.5.0
-Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Returns the value of the first element in the array where predicate is true, and undefined otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Returns the index of the first element in the array where predicate is true, and -1 otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-Equivalent to buf.indexOf() !== -1
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
console.log(buf.includes('this'));
// Prints: true
console.log(buf.includes('is'));
// Prints: true
console.log(buf.includes(Buffer.from('a buffer')));
// Prints: true
console.log(buf.includes(97));
// Prints: true (97 is the decimal ASCII value for 'a')
console.log(buf.includes(Buffer.from('a buffer example')));
// Prints: false
console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// Prints: true
console.log(buf.includes('this', 4));
// Prints: false
What to search for.
@@ -219,7 +219,7 @@Optional
encoding: BufferEncodingIf value
is a string, this is its encoding.
true
if value
was found in buf
, false
otherwise.
v5.3.0
-If value
is:
value
is interpreted according to the character encoding inencoding
.Buffer
or Uint8Array
, value
will be used in its entirety.
@@ -243,14 +243,14 @@
Optional
encoding: BufferEncodingIf value
is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf
.
The index of the first occurrence of value
in buf
, or -1
if buf
does not contain value
.
v1.5.0
-Adds all the elements of an array separated by the specified separator string.
Optional
separator: stringA string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
-Creates and returns an iterator of buf
keys (indices).
Creates and returns an iterator of buf
keys (indices).
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
for (const key of buf.keys()) {
console.log(key);
}
// Prints:
// 0
// 1
// 2
// 3
// 4
// 5
v1.1.0
-Identical to buf.indexOf()
, except the last occurrence of value
is found
rather than the first occurrence.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this buffer is a buffer');
console.log(buf.lastIndexOf('this'));
// Prints: 0
console.log(buf.lastIndexOf('buffer'));
// Prints: 17
console.log(buf.lastIndexOf(Buffer.from('buffer')));
// Prints: 17
console.log(buf.lastIndexOf(97));
// Prints: 15 (97 is the decimal ASCII value for 'a')
console.log(buf.lastIndexOf(Buffer.from('yolo')));
// Prints: -1
console.log(buf.lastIndexOf('buffer', 5));
// Prints: 5
console.log(buf.lastIndexOf('buffer', 4));
// Prints: -1
const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');
console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
// Prints: 6
console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
// Prints: 4
@@ -267,133 +267,133 @@
Optional
encoding: BufferEncodingIf value
is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf
.
The index of the last occurrence of value
in buf
, or -1
if buf
does not contain value
.
v6.0.0
-Calls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-Reads a signed, big-endian 64-bit integer from buf
at the specified offset
.
Reads a signed, big-endian 64-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed
values.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads a signed, little-endian 64-bit integer from buf
at the specifiedoffset
.
Integers read from a Buffer
are interpreted as two's complement signed
values.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads an unsigned, big-endian 64-bit integer from buf
at the specifiedoffset
.
This function is also available under the readBigUint64BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64BE(0));
// Prints: 4294967295n
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads an unsigned, little-endian 64-bit integer from buf
at the specifiedoffset
.
This function is also available under the readBigUint64LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64LE(0));
// Prints: 18446744069414584320n
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads a 64-bit, big-endian double from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleBE(0));
// Prints: 8.20788039913184e-304
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8
.
v0.11.15
-Reads a 64-bit, little-endian double from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleLE(0));
// Prints: 5.447603722011605e-270
console.log(buf.readDoubleLE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8
.
v0.11.15
-Reads a 32-bit, big-endian float from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
console.log(buf.readFloatBE(0));
// Prints: 2.387939260590663e-38
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.11.15
-Reads a 32-bit, little-endian float from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
console.log(buf.readFloatLE(0));
// Prints: 1.539989614439558e-36
console.log(buf.readFloatLE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.11.15
-Reads a signed, big-endian 16-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
console.log(buf.readInt16BE(0));
// Prints: 5
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads a signed, little-endian 16-bit integer from buf
at the specifiedoffset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
console.log(buf.readInt16LE(0));
// Prints: 1280
console.log(buf.readInt16LE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads a signed, big-endian 32-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32BE(0));
// Prints: 5
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads a signed, little-endian 32-bit integer from buf
at the specifiedoffset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32LE(0));
// Prints: 83886080
console.log(buf.readInt32LE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads a signed 8-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([-1, 5]);
console.log(buf.readInt8(0));
// Prints: -1
console.log(buf.readInt8(1));
// Prints: 5
console.log(buf.readInt8(2));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1
.
v0.5.0
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as a big-endian, two's complement signed value
supporting up to 48 bits of accuracy.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntBE(0, 6).toString(16));
// Prints: 1234567890ab
console.log(buf.readIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
console.log(buf.readIntBE(1, 0).toString(16));
// Throws ERR_OUT_OF_RANGE.
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as a little-endian, two's complement signed value
supporting up to 48 bits of accuracy.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntLE(0, 6).toString(16));
// Prints: -546f87a9cbee
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Reads an unsigned, big-endian 16-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint16BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
console.log(buf.readUInt16BE(0).toString(16));
// Prints: 1234
console.log(buf.readUInt16BE(1).toString(16));
// Prints: 3456
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads an unsigned, little-endian 16-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint16LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
console.log(buf.readUInt16LE(0).toString(16));
// Prints: 3412
console.log(buf.readUInt16LE(1).toString(16));
// Prints: 5634
console.log(buf.readUInt16LE(2).toString(16));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads an unsigned, big-endian 32-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint32BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32BE(0).toString(16));
// Prints: 12345678
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads an unsigned, little-endian 32-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint32LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32LE(0).toString(16));
// Prints: 78563412
console.log(buf.readUInt32LE(1).toString(16));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads an unsigned 8-bit integer from buf
at the specified offset
.
This function is also available under the readUint8
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, -2]);
console.log(buf.readUInt8(0));
// Prints: 1
console.log(buf.readUInt8(1));
// Prints: 254
console.log(buf.readUInt8(2));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1
.
v0.5.0
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as an unsigned big-endian integer supporting
up to 48 bits of accuracy.
This function is also available under the readUintBE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntBE(0, 6).toString(16));
// Prints: 1234567890ab
console.log(buf.readUIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
@@ -401,7 +401,7 @@ Since
v14.10.0, v12.19.0
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as an unsigned, little-endian integer supporting
up to 48 bits of accuracy.
This function is also available under the readUintLE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntLE(0, 6).toString(16));
// Prints: ab9078563412
@@ -409,26 +409,26 @@ Since
v14.10.0, v12.19.0
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-Calls the specified callback function for all the elements in an array. The return value of +
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the @@ -436,12 +436,12 @@
v14.9.0, v12.19.0
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-Calls the specified callback function for all the elements in an array, in descending order. +
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
-Calls the specified callback function for all the elements in an array, in descending order. +
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls @@ -449,10 +449,10 @@
v14.9.0, v12.19.0
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-Sets a value or an array of values.
A typed or untyped array of values to set.
Optional
offset: numberThe index in the current array at which the values are to be written.
-Returns a new Buffer
that references the same memory as the original, but
+
Returns a new Buffer
that references the same memory as the original, but
offset and cropped by the start
and end
indices.
This method is not compatible with the Uint8Array.prototype.slice()
,
which is a superclass of Buffer
. To copy the slice, useUint8Array.prototype.slice()
.
v14.9.0, v12.19.0
Optional
end: numberWhere the new Buffer
will end (not inclusive).
v0.3.0
Use subarray
instead.
Determines whether the specified callback function returns true for any element of an array.
A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Sorts an array.
Optional
compareFn: ((a, b) => number)Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.
[11,2,22,1].sort((a, b) => a - b)
-Returns a new Buffer
that references the same memory as the original, but
+
Returns a new Buffer
that references the same memory as the original, but
offset and cropped by the start
and end
indices.
Specifying end
greater than buf.length
will return the same result as
that of end
equal to buf.length
.
Use subarray
instead.
Optional
start: numberWhere the new Buffer
will start.
Optional
end: numberWhere the new Buffer
will end (not inclusive).
v3.0.0
-Interprets buf
as an array of unsigned 16-bit integers and swaps the
+
Interprets buf
as an array of unsigned 16-bit integers and swaps the
byte order in-place. Throws ERR_INVALID_BUFFER_SIZE
if buf.length
is not a multiple of 2.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
buf1.swap16();
console.log(buf1);
// Prints: <Buffer 02 01 04 03 06 05 08 07>
const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap16();
// Throws ERR_INVALID_BUFFER_SIZE.
@@ -499,27 +499,27 @@ Use subarray
instead.
A reference to buf
.
v5.10.0
-Interprets buf
as an array of unsigned 32-bit integers and swaps the
+
Interprets buf
as an array of unsigned 32-bit integers and swaps the
byte order in-place. Throws ERR_INVALID_BUFFER_SIZE
if buf.length
is not a multiple of 4.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
buf1.swap32();
console.log(buf1);
// Prints: <Buffer 04 03 02 01 08 07 06 05>
const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap32();
// Throws ERR_INVALID_BUFFER_SIZE.
A reference to buf
.
v5.10.0
-Interprets buf
as an array of 64-bit numbers and swaps byte order in-place.
+
Interprets buf
as an array of 64-bit numbers and swaps byte order in-place.
Throws ERR_INVALID_BUFFER_SIZE
if buf.length
is not a multiple of 8.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
buf1.swap64();
console.log(buf1);
// Prints: <Buffer 08 07 06 05 04 03 02 01>
const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap64();
// Throws ERR_INVALID_BUFFER_SIZE.
A reference to buf
.
v6.3.0
-Returns a JSON representation of buf
. JSON.stringify()
implicitly calls
+
Returns a JSON representation of buf
. JSON.stringify()
implicitly calls
this function when stringifying a Buffer
instance.
Buffer.from()
accepts objects in the format returned from this method.
In particular, Buffer.from(buf.toJSON())
works like Buffer.from(buf)
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
const json = JSON.stringify(buf);
console.log(json);
// Prints: {"type":"Buffer","data":[1,2,3,4,5]}
const copy = JSON.parse(json, (key, value) => {
return value && value.type === 'Buffer' ?
Buffer.from(value) :
value;
});
console.log(copy);
// Prints: <Buffer 01 02 03 04 05>
v0.9.2
-Decodes buf
to a string according to the specified character encoding inencoding
. start
and end
may be passed to decode only a subset of buf
.
If encoding
is 'utf8'
and a byte sequence in the input is not valid UTF-8,
then each invalid byte is replaced with the replacement character U+FFFD
.
The maximum length of a string instance (in UTF-16 code units) is available @@ -530,13 +530,13 @@
Use subarray
instead.
Optional
start: numberThe byte offset to start decoding at.
Optional
end: numberThe byte offset to stop decoding at (not inclusive).
v0.1.90
-Creates and returns an iterator for buf
values (bytes). This function is
+
Creates and returns an iterator for buf
values (bytes). This function is
called automatically when a Buffer
is used in a for..of
statement.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
for (const value of buf.values()) {
console.log(value);
}
// Prints:
// 98
// 117
// 102
// 102
// 101
// 114
for (const value of buf) {
console.log(value);
}
// Prints:
// 98
// 117
// 102
// 102
// 101
// 114
v1.1.0
-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
@@ -545,7 +545,7 @@ Deprecated
Use subarray
instead.
Optional
encoding: BufferEncodingThe character encoding of string
.
Number of bytes written.
v0.1.90
-Optional
encoding: BufferEncodingOptional
encoding: BufferEncodingWrites value
to buf
at the specified offset
as big-endian.
Optional
encoding: BufferEncodingOptional
encoding: BufferEncodingWrites value
to buf
at the specified offset
as big-endian.
value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigInt64BE(0x0102030405060708n, 0);
console.log(buf);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
@@ -553,7 +553,7 @@ Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as little-endian.
value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigInt64LE(0x0102030405060708n, 0);
console.log(buf);
// Prints: <Buffer 08 07 06 05 04 03 02 01>
@@ -561,7 +561,7 @@ Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as big-endian.
This function is also available under the writeBigUint64BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigUInt64BE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints: <Buffer de ca fa fe ca ce fa de>
@@ -569,7 +569,7 @@ Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as little-endian
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigUInt64LE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints: <Buffer de fa ce ca fe fa ca de>
This function is also available under the writeBigUint64LE
alias.
Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a JavaScript number. Behavior is undefined when value
is anything
other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeDoubleBE(123.456, 0);
console.log(buf);
// Prints: <Buffer 40 5e dd 2f 1a 9f be 77>
@@ -589,7 +589,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a JavaScript number. Behavior is undefined when value
is anything
other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeDoubleLE(123.456, 0);
console.log(buf);
// Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>
@@ -597,7 +597,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as big-endian. Behavior is
undefined when value
is anything other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeFloatBE(0xcafebabe, 0);
console.log(buf);
// Prints: <Buffer 4f 4a fe bb>
@@ -605,7 +605,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as little-endian. Behavior is
undefined when value
is anything other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeFloatLE(0xcafebabe, 0);
console.log(buf);
// Prints: <Buffer bb fe 4a 4f>
@@ -613,7 +613,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid signed 16-bit integer. Behavior is undefined when value
is
anything other than a signed 16-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
buf.writeInt16BE(0x0102, 0);
console.log(buf);
// Prints: <Buffer 01 02>
@@ -622,7 +622,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid signed 16-bit integer. Behavior is undefined when value
is
anything other than a signed 16-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
buf.writeInt16LE(0x0304, 0);
console.log(buf);
// Prints: <Buffer 04 03>
@@ -631,7 +631,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid signed 32-bit integer. Behavior is undefined when value
is
anything other than a signed 32-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeInt32BE(0x01020304, 0);
console.log(buf);
// Prints: <Buffer 01 02 03 04>
@@ -640,7 +640,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid signed 32-bit integer. Behavior is undefined when value
is
anything other than a signed 32-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeInt32LE(0x05060708, 0);
console.log(buf);
// Prints: <Buffer 08 07 06 05>
@@ -649,7 +649,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
. value
must be a valid
signed 8-bit integer. Behavior is undefined when value
is anything other than
a signed 8-bit integer.
value
is interpreted and written as a two's complement signed integer.
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1
.
offset
plus the number of bytes written.
v0.5.0
-Writes byteLength
bytes of value
to buf
at the specified offset
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue
is anything other than a
signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer 12 34 56 78 90 ab>
@@ -668,7 +668,7 @@ v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.11.15
-Writes byteLength
bytes of value
to buf
at the specified offset
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when value
is anything other than a signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer ab 90 78 56 34 12>
@@ -677,7 +677,7 @@ v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid unsigned 16-bit integer. Behavior is undefined when value
is anything other than an
unsigned 16-bit integer.
This function is also available under the writeUint16BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt16BE(0xdead, 0);
buf.writeUInt16BE(0xbeef, 2);
console.log(buf);
// Prints: <Buffer de ad be ef>
@@ -686,7 +686,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid unsigned 16-bit integer. Behavior is undefined when value
is
anything other than an unsigned 16-bit integer.
This function is also available under the writeUint16LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt16LE(0xdead, 0);
buf.writeUInt16LE(0xbeef, 2);
console.log(buf);
// Prints: <Buffer ad de ef be>
@@ -695,7 +695,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid unsigned 32-bit integer. Behavior is undefined when value
is anything other than an
unsigned 32-bit integer.
This function is also available under the writeUint32BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt32BE(0xfeedface, 0);
console.log(buf);
// Prints: <Buffer fe ed fa ce>
@@ -704,7 +704,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid unsigned 32-bit integer. Behavior is undefined when value
is
anything other than an unsigned 32-bit integer.
This function is also available under the writeUint32LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt32LE(0xfeedface, 0);
console.log(buf);
// Prints: <Buffer ce fa ed fe>
@@ -713,7 +713,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
. value
must be a
valid unsigned 8-bit integer. Behavior is undefined when value
is anything
other than an unsigned 8-bit integer.
This function is also available under the writeUint8
alias.
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1
.
offset
plus the number of bytes written.
v0.5.0
-Writes byteLength
bytes of value
to buf
at the specified offset
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when value
is anything other than an unsigned integer.
This function is also available under the writeUintBE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer 12 34 56 78 90 ab>
@@ -733,7 +733,7 @@ Since
v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.5.5
-Writes byteLength
bytes of value
to buf
at the specified offset
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when value
is anything other than an unsigned integer.
This function is also available under the writeUintLE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeUIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer ab 90 78 56 34 12>
@@ -743,18 +743,18 @@ Since
v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.5.5
-Generated using TypeDoc
Generated using TypeDoc
Raw data is stored in instances of the Buffer class. +
Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'
-Allocates a new buffer containing the given {str}.
+Allocates a new buffer containing the given {str}.
String to store in buffer.
Optional
encoding: BufferEncodingencoding to use, optional. Default is 'utf8'
since v10.0.0 - Use Buffer.from(string[, encoding])
instead.
Allocates a new buffer of {size} octets.
+Allocates a new buffer of {size} octets.
count of octets to allocate.
since v10.0.0 - Use Buffer.alloc()
instead (also see Buffer.allocUnsafe()
).
Allocates a new buffer containing the given {array} of octets.
+Allocates a new buffer containing the given {array} of octets.
The octets to store.
since v10.0.0 - Use Buffer.from(array)
instead.
Produces a Buffer backed by the same allocated memory as +
Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}/{SharedArrayBuffer}.
The ArrayBuffer with which to share memory.
since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]])
instead.
Allocates a new buffer containing the given {array} of octets.
+Allocates a new buffer containing the given {array} of octets.
The octets to store.
since v10.0.0 - Use Buffer.from(array)
instead.
Copies the passed {buffer} data onto a new {Buffer} instance.
+Copies the passed {buffer} data onto a new {Buffer} instance.
The buffer to copy.
since v10.0.0 - Use Buffer.from(buffer)
instead.
This is the size (in bytes) of pre-allocated internal Buffer
instances used
+
This is the size (in bytes) of pre-allocated internal Buffer
instances used
for pooling. This value may be modified.
v0.11.3
-Allocates a new Buffer
of size
bytes. If fill
is undefined
, theBuffer
will be zero-filled.
Allocates a new Buffer
of size
bytes. If fill
is undefined
, theBuffer
will be zero-filled.
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(5);
console.log(buf);
// Prints: <Buffer 00 00 00 00 00>
If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown.
Optional
fill: string | number | Uint8ArrayA value to pre-fill the new Buffer
with.
Optional
encoding: BufferEncodingIf fill
is a string, this is its encoding.
v5.10.0
-Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown.
Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown.
The underlying memory for Buffer
instances created in this way is not
initialized. The contents of the newly created Buffer
are unknown and may contain sensitive data. Use Buffer.alloc()
instead to initializeBuffer
instances with zeroes.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(10);
console.log(buf);
// Prints (contents may vary): <Buffer a0 8b 28 3f 01 00 00 00 50 32>
buf.fill(0);
console.log(buf);
// Prints: <Buffer 00 00 00 00 00 00 00 00 00 00>
@@ -73,7 +73,7 @@
additional performance that Buffer.allocUnsafe()
provides.
The desired length of the new Buffer
.
v5.10.0
-Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown. A zero-length Buffer
is created if
+
Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown. A zero-length Buffer
is created if
size
is 0.
The underlying memory for Buffer
instances created in this way is not
initialized. The contents of the newly created Buffer
are unknown and may contain sensitive data. Use buf.fill(0)
to initialize
@@ -93,7 +93,7 @@
A TypeError
will be thrown if size
is not a number.
The desired length of the new Buffer
.
v5.12.0
-Returns the byte length of a string when encoded using encoding
.
This is not the same as String.prototype.length
, which does not account
for the encoding that is used to convert the string into bytes.
For 'base64'
, 'base64url'
, and 'hex'
, this function assumes valid input.
@@ -110,12 +110,12 @@
Optional
encoding: BufferEncodingIf string
is a string, this is its encoding.
The number of bytes contained within string
.
v0.1.90
-Compares buf1
to buf2
, typically for the purpose of sorting arrays ofBuffer
instances. This is equivalent to calling buf1.compare(buf2)
.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('1234');
const buf2 = Buffer.from('0123');
const arr = [buf1, buf2];
console.log(arr.sort(Buffer.compare));
// Prints: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
// (This result is equal to: [buf2, buf1].)
Either -1
, 0
, or 1
, depending on the result of the comparison. See compare
for details.
v0.11.13
-Returns a new Buffer
which is the result of concatenating all the Buffer
instances in the list
together.
Returns a new Buffer
which is the result of concatenating all the Buffer
instances in the list
together.
If the list has no items, or if the totalLength
is 0, then a new zero-lengthBuffer
is returned.
If totalLength
is not provided, it is calculated from the Buffer
instances
in list
by adding their lengths.
List of Buffer
or Uint8Array instances to concatenate.
Optional
totalLength: numberTotal length of the Buffer
instances in list
when concatenated.
v0.7.11
-Copies the underlying memory of view
into a new Buffer
.
Copies the underlying memory of view
into a new Buffer
.
const u16 = new Uint16Array([0, 0xffff]);
const buf = Buffer.copyBytesFrom(u16, 1, 1);
u16[1] = 0;
console.log(buf.length); // 2
console.log(buf[0]); // 255
console.log(buf[1]); // 255
The {TypedArray} to copy.
Optional
offset: numberThe starting offset within view
.
Optional
length: numberThe number of elements from view
to copy.
v19.8.0
-Allocates a new Buffer
using an array
of bytes in the range 0
– 255
.
+
Allocates a new Buffer
using an array
of bytes in the range 0
– 255
.
Array entries outside that range will be truncated to fit into it.
import { Buffer } from 'node:buffer';
// Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
@@ -146,20 +146,20 @@
appropriate for Buffer.from()
variants.
Buffer.from(array)
and Buffer.from(string)
may also use the internalBuffer
pool like Buffer.allocUnsafe()
does.
Optional
byteOffset: numberOptional
length: numberv5.10.0
-Creates a new Buffer using the passed {data}
+Creates a new Buffer using the passed {data}
data to create a new Buffer
-Creates a new Buffer containing the given JavaScript string {str}. +
Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.
-Optional
encoding: BufferEncodingReturns true
if obj
is a Buffer
, false
otherwise.
Optional
encoding: BufferEncodingReturns true
if obj
is a Buffer
, false
otherwise.
import { Buffer } from 'node:buffer';
Buffer.isBuffer(Buffer.alloc(10)); // true
Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false
v0.1.101
-Returns true
if encoding
is the name of a supported character encoding,
+
Returns true
if encoding
is the name of a supported character encoding,
or false
otherwise.
import { Buffer } from 'node:buffer';
console.log(Buffer.isEncoding('utf8'));
// Prints: true
console.log(Buffer.isEncoding('hex'));
// Prints: true
console.log(Buffer.isEncoding('utf/8'));
// Prints: false
console.log(Buffer.isEncoding(''));
// Prints: false
A character encoding name to check.
v0.9.1
-Generated using TypeDoc
Generated using TypeDoc
A call site object representing the location where eval was called +
Generated using TypeDoc
Generated using TypeDoc
The parameters used to configure the CipherSuite
.
The AEAD (Authenticated Encryption with Addtional Data) identifier or the AEAD object.
-The KDF (Key Derivation Function) identifier or the KDF object.
-The KEM (Key Encapsulation Mechanism) identifier or the KEM object.
-Generated using TypeDoc
The parameters used to configure the CipherSuite
.
The AEAD (Authenticated Encryption with Addtional Data) identifier or the AEAD object.
+The KDF (Key Derivation Function) identifier or the KDF object.
+The KEM (Key Encapsulation Mechanism) identifier or the KEM object.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Parameters from which to build a Task
+Parameters from which to build a Task
The Measurement for the provided vdaf, usually inferred from the vdaf.
-the url of the helper aggregator, specified as either a string or +
the url of the helper aggregator, specified as either a string or URLs.
-The task identifier for this Task
. This can be specified
+
the url of the leader aggregator, specified as either a string +
the url of the leader aggregator, specified as either a string or a URL
-The task's minimum batch duration, in seconds. Report timestamps will be +
The task's minimum batch duration, in seconds. Report timestamps will be rounded down to a multiple of this.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The CryptoKey dictionary of the Web Crypto API represents a cryptographic key. +
The CryptoKey dictionary of the Web Crypto API represents a cryptographic key. Available only in secure contexts.
-Readonly
algorithmReadonly
extractableReadonly
typeReadonly
usagesGenerated using TypeDoc
Readonly
algorithmReadonly
extractableReadonly
typeReadonly
usagesGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The encryption context interface for a recipient and a sender.
-Exports a secret using a variable-length pseudorandom function.
+The encryption context interface for a recipient and a sender.
+Exports a secret using a variable-length pseudorandom function.
If the error occurred, throws ExportError
.
An exporter context string as bytes. The maximum length is 128 bytes.
A desired length in bytes of the output secret.
A secret string as bytes.
ExportError
-Decrypts data.
If the error occurred, throws OpenError
.
An encrypted text as bytes to be decrypted.
Optional
aad: ArrayBufferAdditional authenticated data as bytes fed by an application.
A decrypted plain text as bytes.
OpenError
-Encrypts data.
If the error occurred, throws SealError
| MessageLimitReachedError
.
A plain text as bytes to be encrypted.
Optional
aad: ArrayBufferAdditional authenticated data as bytes fed by an application.
A cipher text as bytes.
MessageLimitReachedError, SealError
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The exporter interface.
-Exports a secret using a variable-length pseudorandom function.
+The exporter interface.
+Exports a secret using a variable-length pseudorandom function.
If the error occurred, throws ExportError
.
An exporter context string as bytes. The maximum length is 128 bytes.
A desired length in bytes of the output secret.
A secret string as bytes.
ExportError
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Rest
...args: [] | [undefined]Optional
returnOptional
value: anyOptional
throwOptional
e: anyGenerated using TypeDoc
Rest
...args: [] | [undefined]Optional
returnOptional
value: anyOptional
throwOptional
e: anyGenerated using TypeDoc
Rest
...args: [] | [TNext]Optional
returnOptional
value: TReturnOptional
throwOptional
e: anyGenerated using TypeDoc
Rest
...args: [] | [TNext]Optional
returnOptional
value: TReturnOptional
throwOptional
e: anyGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional
algOptional
crvOptional
dOptional
dpOptional
dqOptional
eOptional
extOptional
kOptional
key_Optional
ktyOptional
nOptional
othOptional
pOptional
qOptional
qiOptional
useOptional
xOptional
yGenerated using TypeDoc
Optional
algOptional
crvOptional
dOptional
dpOptional
dqOptional
eOptional
extOptional
kOptional
key_Optional
ktyOptional
nOptional
othOptional
pOptional
qOptional
qiOptional
useOptional
xOptional
yGenerated using TypeDoc
The KDF interface.
-Readonly
hashThe output size of the extract() function in bytes (Nh).
-Readonly
idThe KDF identifier.
-Builds a labeled input keying material.
+The KDF interface.
+Readonly
hashThe output size of the extract() function in bytes (Nh).
+Readonly
idThe KDF identifier.
+Builds a labeled info string.
+Builds a labeled info string.
A byte string indicating the cryptographic context/operation.
An additional byte string.
The length of the output byte string.
An info string as bytes.
-Expands a pseudorandom key prk
.
Extracts a pseudorandom key of fixed length (Nh) bytes.
+Extracts a pseudorandom key and expand it to a specified length keying material.
+Extracts a pseudorandom key and expand it to a specified length keying material.
An additional random byte string.
An input keying material
An additional byte string.
The length in bytes of the output keying material.
An output keying material as bytes.
-Extracts a pseudorandom key with label.
A pseudorandom key.
A byte string indicating the cryptographic context/operation.
An additional byte string.
The length in bytes of the output keying material.
An output keying material as bytes.
-Extracts a pseudorandom key with label.
+Extracts a pseudorandom key with label.
An additional random byte string.
A byte string indicating the cryptographic context/operation.
An input keying material
A pseudorandom key as bytes.
-Generated using TypeDoc
Generated using TypeDoc
The KEM interface.
-Readonly
encThe length in bytes of an encapsulated key produced by this KEM (Nenc).
-Readonly
idThe KEM identifier.
-Readonly
privateThe length in bytes of an encoded private key for this KEM (Nsk).
-Readonly
publicThe length in bytes of an encoded public key for this KEM (Npk).
-Readonly
secretThe length in bytes of a KEM shared secret produced by this KEM (Nsecret).
-Recovers the ephemeral symmetric key from its encapsulated representation enc
.
The KEM interface.
+Readonly
encThe length in bytes of an encapsulated key produced by this KEM (Nenc).
+Readonly
idThe KEM identifier.
+Readonly
privateThe length in bytes of an encoded private key for this KEM (Nsk).
+Readonly
publicThe length in bytes of an encoded public key for this KEM (Npk).
+Readonly
secretThe length in bytes of a KEM shared secret produced by this KEM (Nsecret).
+Recovers the ephemeral symmetric key from its encapsulated representation enc
.
If the error occurred, throws DecapError.
A set of parameters for the recipient context.
A shared secret as the output of the decapsulation step.
DecapError
-Derives a key pair from the byte string ikm.
+Derives a key pair from the byte string ikm.
If the error occurred, throws DeriveKeyPairError.
An input keying material.
A key pair derived.
DeriveKeyPairError
-Deserializes a private key as a byte string of length Nsk
to CryptoKey.
Deserializes a public key as a byte string of length Npk
to CryptoKey.
Generates an ephemeral, fixed-length symmetric key and
a fixed-length encapsulation of the key that can be decapsulated
by the holder of the private key corresponding to pkR
.
If the error occurred, throws EncapError.
A set of parameters for the sender context.
A shared secret and an encapsulated key as the output of the encapsulation step.
EncapError
-Generates a key pair.
+Generates a key pair.
If the error occurred, throws NotSupportedError.
A key pair generated.
NotSupportedError
-Optional
isPublic: booleanThe indicator whether the provided key is a public key or not, which is used only for 'raw'
format.
A public or private CryptoKey.
DeserializeError
-Serializes a private key as CryptoKey to a byte string of length Nsk
.
If the error occurred, throws SerializeError.
A CryptoKey.
A key as bytes.
SerializeError
-Serializes a public key as CryptoKey to a byte string of length Npk
.
If the error occurred, throws SerializeError.
A CryptoKey.
A key as bytes.
SerializeError
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The common parameters used to setup the EncryptionContext
.
Optional
infoApplication supplied information. The maximum length is 128 bytes.
-Optional
pskA pre-shared key (PSK) held by both the sender and recipient. +
The common parameters used to setup the EncryptionContext
.
Optional
infoApplication supplied information. The maximum length is 128 bytes.
+Optional
pskA pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The parameters used to setup the RecipientContext
.
A byte string of the encapsulated key received from a sender.
-Optional
infoApplication supplied information. The maximum length is 128 bytes.
-Optional
pskA pre-shared key (PSK) held by both the sender and recipient. +
The parameters used to setup the RecipientContext
.
A byte string of the encapsulated key received from a sender.
+Optional
infoApplication supplied information. The maximum length is 128 bytes.
+Optional
pskA pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.
-A recipient private key or a key pair.
-Optional
senderA sender public key for Auth mode.
-Generated using TypeDoc
A recipient private key or a key pair.
+Optional
senderA sender public key for Auth mode.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The sender encryption context.
-The encapsulated key generated by the sender.
-Exports a secret using a variable-length pseudorandom function.
+The sender encryption context.
+The encapsulated key generated by the sender.
+Exports a secret using a variable-length pseudorandom function.
If the error occurred, throws ExportError
.
An exporter context string as bytes. The maximum length is 128 bytes.
A desired length in bytes of the output secret.
A secret string as bytes.
ExportError
-Decrypts data.
If the error occurred, throws OpenError
.
An encrypted text as bytes to be decrypted.
Optional
aad: ArrayBufferAdditional authenticated data as bytes fed by an application.
A decrypted plain text as bytes.
OpenError
-Encrypts data.
If the error occurred, throws SealError
| MessageLimitReachedError
.
A plain text as bytes to be encrypted.
Optional
aad: ArrayBufferAdditional authenticated data as bytes fed by an application.
A cipher text as bytes.
MessageLimitReachedError, SealError
-Generated using TypeDoc
Generated using TypeDoc
The parameters used to setup the SenderContext
.
Optional
ekmDO NOT USE. FOR DEBUGGING/TESTING PURPOSES ONLY.
-Optional
infoApplication supplied information. The maximum length is 128 bytes.
-Optional
pskA pre-shared key (PSK) held by both the sender and recipient. +
The parameters used to setup the SenderContext
.
Optional
ekmDO NOT USE. FOR DEBUGGING/TESTING PURPOSES ONLY.
+Optional
infoApplication supplied information. The maximum length is 128 bytes.
+Optional
pskA pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.
-A recipient public key.
-Optional
senderA sender private key or a key pair for Auth mode.
-Generated using TypeDoc
A recipient public key.
+Optional
senderA sender private key or a key pair for Auth mode.
+Generated using TypeDoc
Readonly
[species]Readonly
[toReadonly
byteRead-only. The length of the ArrayBuffer (in bytes).
-Returns a section of an SharedArrayBuffer.
-Optional
end: numberGenerated using TypeDoc
Readonly
[species]Readonly
[toReadonly
byteRead-only. The length of the ArrayBuffer (in bytes).
+Returns a section of an SharedArrayBuffer.
+Optional
end: numberGenerated using TypeDoc
Readonly
prototypeGenerated using TypeDoc
Readonly
prototypeGenerated using TypeDoc
This Web Crypto API interface provides a number of low-level cryptographic functions. It is accessed via the Crypto.subtle properties available in a window context (via Window.crypto). +
This Web Crypto API interface provides a number of low-level cryptographic functions. It is accessed via the Crypto.subtle properties available in a window context (via Window.crypto). Available only in secure contexts.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Readonly
BYTES_The size in bytes of each element in the array.
-Readonly
[toReadonly
bufferThe ArrayBuffer instance referenced by the array.
-Readonly
byteThe length in bytes of the array.
-Readonly
byteThe offset in bytes of the array.
-Readonly
lengthThe length of the array.
-Takes an integer value and returns the item at that index, +
Readonly
BYTES_The size in bytes of each element in the array.
+Readonly
[toReadonly
bufferThe ArrayBuffer instance referenced by the array.
+Readonly
byteThe length in bytes of the array.
+Readonly
byteThe offset in bytes of the array.
+Readonly
lengthThe length of the array.
+Compares buf
with target
and returns a number indicating whether buf
comes before, after, or is the same as target
in sort order.
Comparison is based on the actual sequence of bytes in each Buffer
.
0
is returned if target
is the same as buf
Optional
sourceStart: numberThe offset within buf
at which to begin comparison.
Optional
sourceEnd: numberThe offset within buf
at which to end comparison (not inclusive).
v0.11.13
-Copies data from a region of buf
to a region in target
, even if the target
memory region overlaps with buf
.
TypedArray.prototype.set()
performs the same operation, and is available
for all TypedArrays, including Node.js Buffer
s, although it takes
different function arguments.
Optional
sourceEnd: numberThe offset within buf
at which to stop copying (not inclusive).
The number of bytes copied.
v0.1.90
-Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
If target is negative, it is treated as length+target where length is the length of the array.
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional
end: numberIf not specified, length of the this object is used as its default value.
-Creates and returns an iterator of [index, byte]
pairs from the contents
+
Creates and returns an iterator of [index, byte]
pairs from the contents
of buf
.
import { Buffer } from 'node:buffer';
// Log the entire contents of a `Buffer`.
const buf = Buffer.from('buffer');
for (const pair of buf.entries()) {
console.log(pair);
}
// Prints:
// [0, 98]
// [1, 117]
// [2, 102]
// [3, 102]
// [4, 101]
// [5, 114]
v1.1.0
-Returns true
if both buf
and otherBuffer
have exactly the same bytes,false
otherwise. Equivalent to buf.compare(otherBuffer) === 0
.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('ABC');
const buf2 = Buffer.from('414243', 'hex');
const buf3 = Buffer.from('ABCD');
console.log(buf1.equals(buf2));
// Prints: true
console.log(buf1.equals(buf3));
// Prints: false
A Buffer
or Uint8Array with which to compare buf
.
v0.11.13
-Determines whether all the members of an array satisfy the specified test.
A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Fills buf
with the specified value
. If the offset
and end
are not given,
the entire buf
will be filled:
import { Buffer } from 'node:buffer';
// Fill a `Buffer` with the ASCII character 'h'.
const b = Buffer.allocUnsafe(50).fill('h');
console.log(b.toString());
// Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
// Fill a buffer with empty string
const c = Buffer.allocUnsafe(5).fill('');
console.log(c.fill(''));
// Prints: <Buffer 00 00 00 00 00>
@@ -187,31 +187,31 @@
Optional
encoding: BufferEncodingThe encoding for value
if value
is a string.
A reference to buf
.
v0.5.0
-Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Returns the value of the first element in the array where predicate is true, and undefined otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Returns the index of the first element in the array where predicate is true, and -1 otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-Equivalent to buf.indexOf() !== -1
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
console.log(buf.includes('this'));
// Prints: true
console.log(buf.includes('is'));
// Prints: true
console.log(buf.includes(Buffer.from('a buffer')));
// Prints: true
console.log(buf.includes(97));
// Prints: true (97 is the decimal ASCII value for 'a')
console.log(buf.includes(Buffer.from('a buffer example')));
// Prints: false
console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// Prints: true
console.log(buf.includes('this', 4));
// Prints: false
What to search for.
@@ -219,7 +219,7 @@Optional
encoding: BufferEncodingIf value
is a string, this is its encoding.
true
if value
was found in buf
, false
otherwise.
v5.3.0
-If value
is:
value
is interpreted according to the character encoding inencoding
.Buffer
or Uint8Array
, value
will be used in its entirety.
@@ -243,14 +243,14 @@
Optional
encoding: BufferEncodingIf value
is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf
.
The index of the first occurrence of value
in buf
, or -1
if buf
does not contain value
.
v1.5.0
-Adds all the elements of an array separated by the specified separator string.
Optional
separator: stringA string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
-Creates and returns an iterator of buf
keys (indices).
Creates and returns an iterator of buf
keys (indices).
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
for (const key of buf.keys()) {
console.log(key);
}
// Prints:
// 0
// 1
// 2
// 3
// 4
// 5
v1.1.0
-Identical to buf.indexOf()
, except the last occurrence of value
is found
rather than the first occurrence.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this buffer is a buffer');
console.log(buf.lastIndexOf('this'));
// Prints: 0
console.log(buf.lastIndexOf('buffer'));
// Prints: 17
console.log(buf.lastIndexOf(Buffer.from('buffer')));
// Prints: 17
console.log(buf.lastIndexOf(97));
// Prints: 15 (97 is the decimal ASCII value for 'a')
console.log(buf.lastIndexOf(Buffer.from('yolo')));
// Prints: -1
console.log(buf.lastIndexOf('buffer', 5));
// Prints: 5
console.log(buf.lastIndexOf('buffer', 4));
// Prints: -1
const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');
console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
// Prints: 6
console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
// Prints: 4
@@ -267,133 +267,133 @@
Optional
encoding: BufferEncodingIf value
is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf
.
The index of the last occurrence of value
in buf
, or -1
if buf
does not contain value
.
v6.0.0
-Calls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-Reads a signed, big-endian 64-bit integer from buf
at the specified offset
.
Reads a signed, big-endian 64-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed
values.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads a signed, little-endian 64-bit integer from buf
at the specifiedoffset
.
Integers read from a Buffer
are interpreted as two's complement signed
values.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads an unsigned, big-endian 64-bit integer from buf
at the specifiedoffset
.
This function is also available under the readBigUint64BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64BE(0));
// Prints: 4294967295n
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads an unsigned, little-endian 64-bit integer from buf
at the specifiedoffset
.
This function is also available under the readBigUint64LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64LE(0));
// Prints: 18446744069414584320n
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads a 64-bit, big-endian double from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleBE(0));
// Prints: 8.20788039913184e-304
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8
.
v0.11.15
-Reads a 64-bit, little-endian double from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleLE(0));
// Prints: 5.447603722011605e-270
console.log(buf.readDoubleLE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8
.
v0.11.15
-Reads a 32-bit, big-endian float from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
console.log(buf.readFloatBE(0));
// Prints: 2.387939260590663e-38
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.11.15
-Reads a 32-bit, little-endian float from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
console.log(buf.readFloatLE(0));
// Prints: 1.539989614439558e-36
console.log(buf.readFloatLE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.11.15
-Reads a signed, big-endian 16-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
console.log(buf.readInt16BE(0));
// Prints: 5
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads a signed, little-endian 16-bit integer from buf
at the specifiedoffset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
console.log(buf.readInt16LE(0));
// Prints: 1280
console.log(buf.readInt16LE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads a signed, big-endian 32-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32BE(0));
// Prints: 5
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads a signed, little-endian 32-bit integer from buf
at the specifiedoffset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32LE(0));
// Prints: 83886080
console.log(buf.readInt32LE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads a signed 8-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([-1, 5]);
console.log(buf.readInt8(0));
// Prints: -1
console.log(buf.readInt8(1));
// Prints: 5
console.log(buf.readInt8(2));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1
.
v0.5.0
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as a big-endian, two's complement signed value
supporting up to 48 bits of accuracy.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntBE(0, 6).toString(16));
// Prints: 1234567890ab
console.log(buf.readIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
console.log(buf.readIntBE(1, 0).toString(16));
// Throws ERR_OUT_OF_RANGE.
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as a little-endian, two's complement signed value
supporting up to 48 bits of accuracy.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntLE(0, 6).toString(16));
// Prints: -546f87a9cbee
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Reads an unsigned, big-endian 16-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint16BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
console.log(buf.readUInt16BE(0).toString(16));
// Prints: 1234
console.log(buf.readUInt16BE(1).toString(16));
// Prints: 3456
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads an unsigned, little-endian 16-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint16LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
console.log(buf.readUInt16LE(0).toString(16));
// Prints: 3412
console.log(buf.readUInt16LE(1).toString(16));
// Prints: 5634
console.log(buf.readUInt16LE(2).toString(16));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads an unsigned, big-endian 32-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint32BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32BE(0).toString(16));
// Prints: 12345678
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads an unsigned, little-endian 32-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint32LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32LE(0).toString(16));
// Prints: 78563412
console.log(buf.readUInt32LE(1).toString(16));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads an unsigned 8-bit integer from buf
at the specified offset
.
This function is also available under the readUint8
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, -2]);
console.log(buf.readUInt8(0));
// Prints: 1
console.log(buf.readUInt8(1));
// Prints: 254
console.log(buf.readUInt8(2));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1
.
v0.5.0
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as an unsigned big-endian integer supporting
up to 48 bits of accuracy.
This function is also available under the readUintBE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntBE(0, 6).toString(16));
// Prints: 1234567890ab
console.log(buf.readUIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
@@ -401,7 +401,7 @@ Since
v14.10.0, v12.19.0
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as an unsigned, little-endian integer supporting
up to 48 bits of accuracy.
This function is also available under the readUintLE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntLE(0, 6).toString(16));
// Prints: ab9078563412
@@ -409,26 +409,26 @@ Since
v14.10.0, v12.19.0
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-Calls the specified callback function for all the elements in an array. The return value of +
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the @@ -436,12 +436,12 @@
v14.9.0, v12.19.0
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-Calls the specified callback function for all the elements in an array, in descending order. +
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
-Calls the specified callback function for all the elements in an array, in descending order. +
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls @@ -449,10 +449,10 @@
v14.9.0, v12.19.0
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-Sets a value or an array of values.
A typed or untyped array of values to set.
Optional
offset: numberThe index in the current array at which the values are to be written.
-Returns a new Buffer
that references the same memory as the original, but
+
Returns a new Buffer
that references the same memory as the original, but
offset and cropped by the start
and end
indices.
This method is not compatible with the Uint8Array.prototype.slice()
,
which is a superclass of Buffer
. To copy the slice, useUint8Array.prototype.slice()
.
v14.9.0, v12.19.0
Optional
end: numberWhere the new Buffer
will end (not inclusive).
v0.3.0
Use subarray
instead.
Determines whether the specified callback function returns true for any element of an array.
A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Sorts an array.
Optional
compareFn: ((a, b) => number)Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.
[11,2,22,1].sort((a, b) => a - b)
-Returns a new Buffer
that references the same memory as the original, but
+
Returns a new Buffer
that references the same memory as the original, but
offset and cropped by the start
and end
indices.
Specifying end
greater than buf.length
will return the same result as
that of end
equal to buf.length
.
Use subarray
instead.
Optional
start: numberWhere the new Buffer
will start.
Optional
end: numberWhere the new Buffer
will end (not inclusive).
v3.0.0
-Interprets buf
as an array of unsigned 16-bit integers and swaps the
+
Interprets buf
as an array of unsigned 16-bit integers and swaps the
byte order in-place. Throws ERR_INVALID_BUFFER_SIZE
if buf.length
is not a multiple of 2.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
buf1.swap16();
console.log(buf1);
// Prints: <Buffer 02 01 04 03 06 05 08 07>
const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap16();
// Throws ERR_INVALID_BUFFER_SIZE.
@@ -499,27 +499,27 @@ Use subarray
instead.
A reference to buf
.
v5.10.0
-Interprets buf
as an array of unsigned 32-bit integers and swaps the
+
Interprets buf
as an array of unsigned 32-bit integers and swaps the
byte order in-place. Throws ERR_INVALID_BUFFER_SIZE
if buf.length
is not a multiple of 4.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
buf1.swap32();
console.log(buf1);
// Prints: <Buffer 04 03 02 01 08 07 06 05>
const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap32();
// Throws ERR_INVALID_BUFFER_SIZE.
A reference to buf
.
v5.10.0
-Interprets buf
as an array of 64-bit numbers and swaps byte order in-place.
+
Interprets buf
as an array of 64-bit numbers and swaps byte order in-place.
Throws ERR_INVALID_BUFFER_SIZE
if buf.length
is not a multiple of 8.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
buf1.swap64();
console.log(buf1);
// Prints: <Buffer 08 07 06 05 04 03 02 01>
const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap64();
// Throws ERR_INVALID_BUFFER_SIZE.
A reference to buf
.
v6.3.0
-Returns a JSON representation of buf
. JSON.stringify()
implicitly calls
+
Returns a JSON representation of buf
. JSON.stringify()
implicitly calls
this function when stringifying a Buffer
instance.
Buffer.from()
accepts objects in the format returned from this method.
In particular, Buffer.from(buf.toJSON())
works like Buffer.from(buf)
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
const json = JSON.stringify(buf);
console.log(json);
// Prints: {"type":"Buffer","data":[1,2,3,4,5]}
const copy = JSON.parse(json, (key, value) => {
return value && value.type === 'Buffer' ?
Buffer.from(value) :
value;
});
console.log(copy);
// Prints: <Buffer 01 02 03 04 05>
v0.9.2
-Decodes buf
to a string according to the specified character encoding inencoding
. start
and end
may be passed to decode only a subset of buf
.
If encoding
is 'utf8'
and a byte sequence in the input is not valid UTF-8,
then each invalid byte is replaced with the replacement character U+FFFD
.
The maximum length of a string instance (in UTF-16 code units) is available @@ -530,13 +530,13 @@
Use subarray
instead.
Optional
start: numberThe byte offset to start decoding at.
Optional
end: numberThe byte offset to stop decoding at (not inclusive).
v0.1.90
-Creates and returns an iterator for buf
values (bytes). This function is
+
Creates and returns an iterator for buf
values (bytes). This function is
called automatically when a Buffer
is used in a for..of
statement.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
for (const value of buf.values()) {
console.log(value);
}
// Prints:
// 98
// 117
// 102
// 102
// 101
// 114
for (const value of buf) {
console.log(value);
}
// Prints:
// 98
// 117
// 102
// 102
// 101
// 114
v1.1.0
-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
@@ -545,7 +545,7 @@ Deprecated
Use subarray
instead.
Optional
encoding: BufferEncodingThe character encoding of string
.
Number of bytes written.
v0.1.90
-Optional
encoding: BufferEncodingOptional
encoding: BufferEncodingWrites value
to buf
at the specified offset
as big-endian.
Optional
encoding: BufferEncodingOptional
encoding: BufferEncodingWrites value
to buf
at the specified offset
as big-endian.
value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigInt64BE(0x0102030405060708n, 0);
console.log(buf);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
@@ -553,7 +553,7 @@ Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as little-endian.
value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigInt64LE(0x0102030405060708n, 0);
console.log(buf);
// Prints: <Buffer 08 07 06 05 04 03 02 01>
@@ -561,7 +561,7 @@ Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as big-endian.
This function is also available under the writeBigUint64BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigUInt64BE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints: <Buffer de ca fa fe ca ce fa de>
@@ -569,7 +569,7 @@ Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as little-endian
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigUInt64LE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints: <Buffer de fa ce ca fe fa ca de>
This function is also available under the writeBigUint64LE
alias.
Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a JavaScript number. Behavior is undefined when value
is anything
other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeDoubleBE(123.456, 0);
console.log(buf);
// Prints: <Buffer 40 5e dd 2f 1a 9f be 77>
@@ -589,7 +589,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a JavaScript number. Behavior is undefined when value
is anything
other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeDoubleLE(123.456, 0);
console.log(buf);
// Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>
@@ -597,7 +597,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as big-endian. Behavior is
undefined when value
is anything other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeFloatBE(0xcafebabe, 0);
console.log(buf);
// Prints: <Buffer 4f 4a fe bb>
@@ -605,7 +605,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as little-endian. Behavior is
undefined when value
is anything other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeFloatLE(0xcafebabe, 0);
console.log(buf);
// Prints: <Buffer bb fe 4a 4f>
@@ -613,7 +613,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid signed 16-bit integer. Behavior is undefined when value
is
anything other than a signed 16-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
buf.writeInt16BE(0x0102, 0);
console.log(buf);
// Prints: <Buffer 01 02>
@@ -622,7 +622,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid signed 16-bit integer. Behavior is undefined when value
is
anything other than a signed 16-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
buf.writeInt16LE(0x0304, 0);
console.log(buf);
// Prints: <Buffer 04 03>
@@ -631,7 +631,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid signed 32-bit integer. Behavior is undefined when value
is
anything other than a signed 32-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeInt32BE(0x01020304, 0);
console.log(buf);
// Prints: <Buffer 01 02 03 04>
@@ -640,7 +640,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid signed 32-bit integer. Behavior is undefined when value
is
anything other than a signed 32-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeInt32LE(0x05060708, 0);
console.log(buf);
// Prints: <Buffer 08 07 06 05>
@@ -649,7 +649,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
. value
must be a valid
signed 8-bit integer. Behavior is undefined when value
is anything other than
a signed 8-bit integer.
value
is interpreted and written as a two's complement signed integer.
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1
.
offset
plus the number of bytes written.
v0.5.0
-Writes byteLength
bytes of value
to buf
at the specified offset
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue
is anything other than a
signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer 12 34 56 78 90 ab>
@@ -668,7 +668,7 @@ v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.11.15
-Writes byteLength
bytes of value
to buf
at the specified offset
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when value
is anything other than a signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer ab 90 78 56 34 12>
@@ -677,7 +677,7 @@ v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid unsigned 16-bit integer. Behavior is undefined when value
is anything other than an
unsigned 16-bit integer.
This function is also available under the writeUint16BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt16BE(0xdead, 0);
buf.writeUInt16BE(0xbeef, 2);
console.log(buf);
// Prints: <Buffer de ad be ef>
@@ -686,7 +686,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid unsigned 16-bit integer. Behavior is undefined when value
is
anything other than an unsigned 16-bit integer.
This function is also available under the writeUint16LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt16LE(0xdead, 0);
buf.writeUInt16LE(0xbeef, 2);
console.log(buf);
// Prints: <Buffer ad de ef be>
@@ -695,7 +695,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid unsigned 32-bit integer. Behavior is undefined when value
is anything other than an
unsigned 32-bit integer.
This function is also available under the writeUint32BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt32BE(0xfeedface, 0);
console.log(buf);
// Prints: <Buffer fe ed fa ce>
@@ -704,7 +704,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid unsigned 32-bit integer. Behavior is undefined when value
is
anything other than an unsigned 32-bit integer.
This function is also available under the writeUint32LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt32LE(0xfeedface, 0);
console.log(buf);
// Prints: <Buffer ce fa ed fe>
@@ -713,7 +713,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
. value
must be a
valid unsigned 8-bit integer. Behavior is undefined when value
is anything
other than an unsigned 8-bit integer.
This function is also available under the writeUint8
alias.
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1
.
offset
plus the number of bytes written.
v0.5.0
-Writes byteLength
bytes of value
to buf
at the specified offset
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when value
is anything other than an unsigned integer.
This function is also available under the writeUintBE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer 12 34 56 78 90 ab>
@@ -733,7 +733,7 @@ Since
v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.5.5
-Writes byteLength
bytes of value
to buf
at the specified offset
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when value
is anything other than an unsigned integer.
This function is also available under the writeUintLE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeUIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer ab 90 78 56 34 12>
@@ -743,18 +743,18 @@ Since
v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.5.5
-Generated using TypeDoc
Generated using TypeDoc
Raw data is stored in instances of the Buffer class. +
Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'
-Allocates a new buffer containing the given {str}.
+Allocates a new buffer containing the given {str}.
String to store in buffer.
Optional
encoding: BufferEncodingencoding to use, optional. Default is 'utf8'
since v10.0.0 - Use Buffer.from(string[, encoding])
instead.
Allocates a new buffer of {size} octets.
+Allocates a new buffer of {size} octets.
count of octets to allocate.
since v10.0.0 - Use Buffer.alloc()
instead (also see Buffer.allocUnsafe()
).
Allocates a new buffer containing the given {array} of octets.
+Allocates a new buffer containing the given {array} of octets.
The octets to store.
since v10.0.0 - Use Buffer.from(array)
instead.
Produces a Buffer backed by the same allocated memory as +
Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}/{SharedArrayBuffer}.
The ArrayBuffer with which to share memory.
since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]])
instead.
Allocates a new buffer containing the given {array} of octets.
+Allocates a new buffer containing the given {array} of octets.
The octets to store.
since v10.0.0 - Use Buffer.from(array)
instead.
Copies the passed {buffer} data onto a new {Buffer} instance.
+Copies the passed {buffer} data onto a new {Buffer} instance.
The buffer to copy.
since v10.0.0 - Use Buffer.from(buffer)
instead.
This is the size (in bytes) of pre-allocated internal Buffer
instances used
+
This is the size (in bytes) of pre-allocated internal Buffer
instances used
for pooling. This value may be modified.
v0.11.3
-Allocates a new Buffer
of size
bytes. If fill
is undefined
, theBuffer
will be zero-filled.
Allocates a new Buffer
of size
bytes. If fill
is undefined
, theBuffer
will be zero-filled.
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(5);
console.log(buf);
// Prints: <Buffer 00 00 00 00 00>
If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown.
Optional
fill: string | number | Uint8ArrayA value to pre-fill the new Buffer
with.
Optional
encoding: BufferEncodingIf fill
is a string, this is its encoding.
v5.10.0
-Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown.
Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown.
The underlying memory for Buffer
instances created in this way is not
initialized. The contents of the newly created Buffer
are unknown and may contain sensitive data. Use Buffer.alloc()
instead to initializeBuffer
instances with zeroes.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(10);
console.log(buf);
// Prints (contents may vary): <Buffer a0 8b 28 3f 01 00 00 00 50 32>
buf.fill(0);
console.log(buf);
// Prints: <Buffer 00 00 00 00 00 00 00 00 00 00>
@@ -73,7 +73,7 @@
additional performance that Buffer.allocUnsafe()
provides.
The desired length of the new Buffer
.
v5.10.0
-Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown. A zero-length Buffer
is created if
+
Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown. A zero-length Buffer
is created if
size
is 0.
The underlying memory for Buffer
instances created in this way is not
initialized. The contents of the newly created Buffer
are unknown and may contain sensitive data. Use buf.fill(0)
to initialize
@@ -93,7 +93,7 @@
A TypeError
will be thrown if size
is not a number.
The desired length of the new Buffer
.
v5.12.0
-Returns the byte length of a string when encoded using encoding
.
This is not the same as String.prototype.length
, which does not account
for the encoding that is used to convert the string into bytes.
For 'base64'
, 'base64url'
, and 'hex'
, this function assumes valid input.
@@ -110,12 +110,12 @@
Optional
encoding: BufferEncodingIf string
is a string, this is its encoding.
The number of bytes contained within string
.
v0.1.90
-Compares buf1
to buf2
, typically for the purpose of sorting arrays ofBuffer
instances. This is equivalent to calling buf1.compare(buf2)
.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('1234');
const buf2 = Buffer.from('0123');
const arr = [buf1, buf2];
console.log(arr.sort(Buffer.compare));
// Prints: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
// (This result is equal to: [buf2, buf1].)
Either -1
, 0
, or 1
, depending on the result of the comparison. See compare
for details.
v0.11.13
-Returns a new Buffer
which is the result of concatenating all the Buffer
instances in the list
together.
Returns a new Buffer
which is the result of concatenating all the Buffer
instances in the list
together.
If the list has no items, or if the totalLength
is 0, then a new zero-lengthBuffer
is returned.
If totalLength
is not provided, it is calculated from the Buffer
instances
in list
by adding their lengths.
List of Buffer
or Uint8Array instances to concatenate.
Optional
totalLength: numberTotal length of the Buffer
instances in list
when concatenated.
v0.7.11
-Copies the underlying memory of view
into a new Buffer
.
Copies the underlying memory of view
into a new Buffer
.
const u16 = new Uint16Array([0, 0xffff]);
const buf = Buffer.copyBytesFrom(u16, 1, 1);
u16[1] = 0;
console.log(buf.length); // 2
console.log(buf[0]); // 255
console.log(buf[1]); // 255
The {TypedArray} to copy.
Optional
offset: numberThe starting offset within view
.
Optional
length: numberThe number of elements from view
to copy.
v19.8.0
-Allocates a new Buffer
using an array
of bytes in the range 0
– 255
.
+
Allocates a new Buffer
using an array
of bytes in the range 0
– 255
.
Array entries outside that range will be truncated to fit into it.
import { Buffer } from 'node:buffer';
// Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
@@ -146,20 +146,20 @@
appropriate for Buffer.from()
variants.
Buffer.from(array)
and Buffer.from(string)
may also use the internalBuffer
pool like Buffer.allocUnsafe()
does.
Optional
byteOffset: numberOptional
length: numberv5.10.0
-Creates a new Buffer using the passed {data}
+Creates a new Buffer using the passed {data}
data to create a new Buffer
-Creates a new Buffer containing the given JavaScript string {str}. +
Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.
-Optional
encoding: BufferEncodingReturns true
if obj
is a Buffer
, false
otherwise.
Optional
encoding: BufferEncodingReturns true
if obj
is a Buffer
, false
otherwise.
import { Buffer } from 'node:buffer';
Buffer.isBuffer(Buffer.alloc(10)); // true
Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false
v0.1.101
-Returns true
if encoding
is the name of a supported character encoding,
+
Returns true
if encoding
is the name of a supported character encoding,
or false
otherwise.
import { Buffer } from 'node:buffer';
console.log(Buffer.isEncoding('utf8'));
// Prints: true
console.log(Buffer.isEncoding('hex'));
// Prints: true
console.log(Buffer.isEncoding('utf/8'));
// Prints: false
console.log(Buffer.isEncoding(''));
// Prints: false
A character encoding name to check.
v0.9.1
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Rest
...args: [] | [undefined]Optional
returnOptional
value: anyOptional
throwOptional
e: anyGenerated using TypeDoc
Rest
...args: [] | [undefined]Optional
returnOptional
value: anyOptional
throwOptional
e: anyGenerated using TypeDoc
Rest
...args: [] | [TNext]Optional
returnOptional
value: TReturnOptional
throwOptional
e: anyGenerated using TypeDoc
Rest
...args: [] | [TNext]Optional
returnOptional
value: TReturnOptional
throwOptional
e: anyGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Readonly
[species]Readonly
[toReadonly
byteRead-only. The length of the ArrayBuffer (in bytes).
-Returns a section of an SharedArrayBuffer.
-Optional
end: numberGenerated using TypeDoc
Readonly
[species]Readonly
[toReadonly
byteRead-only. The length of the ArrayBuffer (in bytes).
+Returns a section of an SharedArrayBuffer.
+Optional
end: numberGenerated using TypeDoc
Readonly
prototypeGenerated using TypeDoc
Readonly
prototypeGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Readonly
BYTES_The size in bytes of each element in the array.
-Readonly
[toReadonly
bufferThe ArrayBuffer instance referenced by the array.
-Readonly
byteThe length in bytes of the array.
-Readonly
byteThe offset in bytes of the array.
-Readonly
lengthThe length of the array.
-Takes an integer value and returns the item at that index, +
Readonly
BYTES_The size in bytes of each element in the array.
+Readonly
[toReadonly
bufferThe ArrayBuffer instance referenced by the array.
+Readonly
byteThe length in bytes of the array.
+Readonly
byteThe offset in bytes of the array.
+Readonly
lengthThe length of the array.
+Compares buf
with target
and returns a number indicating whether buf
comes before, after, or is the same as target
in sort order.
Comparison is based on the actual sequence of bytes in each Buffer
.
0
is returned if target
is the same as buf
Optional
sourceStart: numberThe offset within buf
at which to begin comparison.
Optional
sourceEnd: numberThe offset within buf
at which to end comparison (not inclusive).
v0.11.13
-Copies data from a region of buf
to a region in target
, even if the target
memory region overlaps with buf
.
TypedArray.prototype.set()
performs the same operation, and is available
for all TypedArrays, including Node.js Buffer
s, although it takes
different function arguments.
Optional
sourceEnd: numberThe offset within buf
at which to stop copying (not inclusive).
The number of bytes copied.
v0.1.90
-Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
If target is negative, it is treated as length+target where length is the length of the array.
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional
end: numberIf not specified, length of the this object is used as its default value.
-Creates and returns an iterator of [index, byte]
pairs from the contents
+
Creates and returns an iterator of [index, byte]
pairs from the contents
of buf
.
import { Buffer } from 'node:buffer';
// Log the entire contents of a `Buffer`.
const buf = Buffer.from('buffer');
for (const pair of buf.entries()) {
console.log(pair);
}
// Prints:
// [0, 98]
// [1, 117]
// [2, 102]
// [3, 102]
// [4, 101]
// [5, 114]
v1.1.0
-Returns true
if both buf
and otherBuffer
have exactly the same bytes,false
otherwise. Equivalent to buf.compare(otherBuffer) === 0
.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('ABC');
const buf2 = Buffer.from('414243', 'hex');
const buf3 = Buffer.from('ABCD');
console.log(buf1.equals(buf2));
// Prints: true
console.log(buf1.equals(buf3));
// Prints: false
A Buffer
or Uint8Array with which to compare buf
.
v0.11.13
-Determines whether all the members of an array satisfy the specified test.
A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Fills buf
with the specified value
. If the offset
and end
are not given,
the entire buf
will be filled:
import { Buffer } from 'node:buffer';
// Fill a `Buffer` with the ASCII character 'h'.
const b = Buffer.allocUnsafe(50).fill('h');
console.log(b.toString());
// Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
// Fill a buffer with empty string
const c = Buffer.allocUnsafe(5).fill('');
console.log(c.fill(''));
// Prints: <Buffer 00 00 00 00 00>
@@ -187,31 +187,31 @@
Optional
encoding: BufferEncodingThe encoding for value
if value
is a string.
A reference to buf
.
v0.5.0
-Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Returns the value of the first element in the array where predicate is true, and undefined +
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Returns the index of the first element in the array where predicate is true, and -1 +
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-Equivalent to buf.indexOf() !== -1
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
console.log(buf.includes('this'));
// Prints: true
console.log(buf.includes('is'));
// Prints: true
console.log(buf.includes(Buffer.from('a buffer')));
// Prints: true
console.log(buf.includes(97));
// Prints: true (97 is the decimal ASCII value for 'a')
console.log(buf.includes(Buffer.from('a buffer example')));
// Prints: false
console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// Prints: true
console.log(buf.includes('this', 4));
// Prints: false
What to search for.
@@ -219,7 +219,7 @@Optional
encoding: BufferEncodingIf value
is a string, this is its encoding.
true
if value
was found in buf
, false
otherwise.
v5.3.0
-If value
is:
value
is interpreted according to the character encoding inencoding
.Buffer
or Uint8Array
, value
will be used in its entirety.
@@ -243,14 +243,14 @@
Optional
encoding: BufferEncodingIf value
is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf
.
The index of the first occurrence of value
in buf
, or -1
if buf
does not contain value
.
v1.5.0
-Adds all the elements of an array separated by the specified separator string.
Optional
separator: stringA string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
-Creates and returns an iterator of buf
keys (indices).
Creates and returns an iterator of buf
keys (indices).
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
for (const key of buf.keys()) {
console.log(key);
}
// Prints:
// 0
// 1
// 2
// 3
// 4
// 5
v1.1.0
-Identical to buf.indexOf()
, except the last occurrence of value
is found
rather than the first occurrence.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this buffer is a buffer');
console.log(buf.lastIndexOf('this'));
// Prints: 0
console.log(buf.lastIndexOf('buffer'));
// Prints: 17
console.log(buf.lastIndexOf(Buffer.from('buffer')));
// Prints: 17
console.log(buf.lastIndexOf(97));
// Prints: 15 (97 is the decimal ASCII value for 'a')
console.log(buf.lastIndexOf(Buffer.from('yolo')));
// Prints: -1
console.log(buf.lastIndexOf('buffer', 5));
// Prints: 5
console.log(buf.lastIndexOf('buffer', 4));
// Prints: -1
const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');
console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
// Prints: 6
console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
// Prints: 4
@@ -267,133 +267,133 @@
Optional
encoding: BufferEncodingIf value
is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf
.
The index of the last occurrence of value
in buf
, or -1
if buf
does not contain value
.
v6.0.0
-Calls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-Reads a signed, big-endian 64-bit integer from buf
at the specified offset
.
Reads a signed, big-endian 64-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed
values.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads a signed, little-endian 64-bit integer from buf
at the specifiedoffset
.
Integers read from a Buffer
are interpreted as two's complement signed
values.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads an unsigned, big-endian 64-bit integer from buf
at the specifiedoffset
.
This function is also available under the readBigUint64BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64BE(0));
// Prints: 4294967295n
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads an unsigned, little-endian 64-bit integer from buf
at the specifiedoffset
.
This function is also available under the readBigUint64LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
console.log(buf.readBigUInt64LE(0));
// Prints: 18446744069414584320n
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8
.
v12.0.0, v10.20.0
-Reads a 64-bit, big-endian double from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleBE(0));
// Prints: 8.20788039913184e-304
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8
.
v0.11.15
-Reads a 64-bit, little-endian double from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
console.log(buf.readDoubleLE(0));
// Prints: 5.447603722011605e-270
console.log(buf.readDoubleLE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8
.
v0.11.15
-Reads a 32-bit, big-endian float from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
console.log(buf.readFloatBE(0));
// Prints: 2.387939260590663e-38
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.11.15
-Reads a 32-bit, little-endian float from buf
at the specified offset
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, 2, 3, 4]);
console.log(buf.readFloatLE(0));
// Prints: 1.539989614439558e-36
console.log(buf.readFloatLE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.11.15
-Reads a signed, big-endian 16-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
console.log(buf.readInt16BE(0));
// Prints: 5
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads a signed, little-endian 16-bit integer from buf
at the specifiedoffset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 5]);
console.log(buf.readInt16LE(0));
// Prints: 1280
console.log(buf.readInt16LE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads a signed, big-endian 32-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32BE(0));
// Prints: 5
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads a signed, little-endian 32-bit integer from buf
at the specifiedoffset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0, 0, 0, 5]);
console.log(buf.readInt32LE(0));
// Prints: 83886080
console.log(buf.readInt32LE(1));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads a signed 8-bit integer from buf
at the specified offset
.
Integers read from a Buffer
are interpreted as two's complement signed values.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([-1, 5]);
console.log(buf.readInt8(0));
// Prints: -1
console.log(buf.readInt8(1));
// Prints: 5
console.log(buf.readInt8(2));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1
.
v0.5.0
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as a big-endian, two's complement signed value
supporting up to 48 bits of accuracy.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntBE(0, 6).toString(16));
// Prints: 1234567890ab
console.log(buf.readIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
console.log(buf.readIntBE(1, 0).toString(16));
// Throws ERR_OUT_OF_RANGE.
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as a little-endian, two's complement signed value
supporting up to 48 bits of accuracy.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readIntLE(0, 6).toString(16));
// Prints: -546f87a9cbee
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Reads an unsigned, big-endian 16-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint16BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
console.log(buf.readUInt16BE(0).toString(16));
// Prints: 1234
console.log(buf.readUInt16BE(1).toString(16));
// Prints: 3456
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads an unsigned, little-endian 16-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint16LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56]);
console.log(buf.readUInt16LE(0).toString(16));
// Prints: 3412
console.log(buf.readUInt16LE(1).toString(16));
// Prints: 5634
console.log(buf.readUInt16LE(2).toString(16));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
.
v0.5.5
-Reads an unsigned, big-endian 32-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint32BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32BE(0).toString(16));
// Prints: 12345678
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads an unsigned, little-endian 32-bit integer from buf
at the specifiedoffset
.
This function is also available under the readUint32LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
console.log(buf.readUInt32LE(0).toString(16));
// Prints: 78563412
console.log(buf.readUInt32LE(1).toString(16));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
.
v0.5.5
-Reads an unsigned 8-bit integer from buf
at the specified offset
.
This function is also available under the readUint8
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([1, -2]);
console.log(buf.readUInt8(0));
// Prints: 1
console.log(buf.readUInt8(1));
// Prints: 254
console.log(buf.readUInt8(2));
// Throws ERR_OUT_OF_RANGE.
Optional
offset: numberNumber of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1
.
v0.5.0
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as an unsigned big-endian integer supporting
up to 48 bits of accuracy.
This function is also available under the readUintBE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntBE(0, 6).toString(16));
// Prints: 1234567890ab
console.log(buf.readUIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
@@ -401,7 +401,7 @@ Since
v14.10.0, v12.19.0
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Reads byteLength
number of bytes from buf
at the specified offset
and interprets the result as an unsigned, little-endian integer supporting
up to 48 bits of accuracy.
This function is also available under the readUintLE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
console.log(buf.readUIntLE(0, 6).toString(16));
// Prints: ab9078563412
@@ -409,26 +409,26 @@ Since
v14.10.0, v12.19.0
Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength
.
Number of bytes to read. Must satisfy 0 < byteLength <= 6
.
v0.11.15
-Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-Calls the specified callback function for all the elements in an array. The return value of +
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the @@ -436,12 +436,12 @@
v14.9.0, v12.19.0
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-Calls the specified callback function for all the elements in an array, in descending order. +
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
-Calls the specified callback function for all the elements in an array, in descending order. +
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls @@ -449,10 +449,10 @@
v14.9.0, v12.19.0
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-Sets a value or an array of values.
A typed or untyped array of values to set.
Optional
offset: numberThe index in the current array at which the values are to be written.
-Returns a new Buffer
that references the same memory as the original, but
+
Returns a new Buffer
that references the same memory as the original, but
offset and cropped by the start
and end
indices.
This method is not compatible with the Uint8Array.prototype.slice()
,
which is a superclass of Buffer
. To copy the slice, useUint8Array.prototype.slice()
.
v14.9.0, v12.19.0
Optional
end: numberWhere the new Buffer
will end (not inclusive).
v0.3.0
Use subarray
instead.
Determines whether the specified callback function returns true for any element of an array.
A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Sorts an array.
Optional
compareFn: ((a, b) => number)Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.
[11,2,22,1].sort((a, b) => a - b)
-Returns a new Buffer
that references the same memory as the original, but
+
Returns a new Buffer
that references the same memory as the original, but
offset and cropped by the start
and end
indices.
Specifying end
greater than buf.length
will return the same result as
that of end
equal to buf.length
.
Use subarray
instead.
Optional
start: numberWhere the new Buffer
will start.
Optional
end: numberWhere the new Buffer
will end (not inclusive).
v3.0.0
-Interprets buf
as an array of unsigned 16-bit integers and swaps the
+
Interprets buf
as an array of unsigned 16-bit integers and swaps the
byte order in-place. Throws ERR_INVALID_BUFFER_SIZE
if buf.length
is not a multiple of 2.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
buf1.swap16();
console.log(buf1);
// Prints: <Buffer 02 01 04 03 06 05 08 07>
const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap16();
// Throws ERR_INVALID_BUFFER_SIZE.
@@ -499,27 +499,27 @@ Use subarray
instead.
A reference to buf
.
v5.10.0
-Interprets buf
as an array of unsigned 32-bit integers and swaps the
+
Interprets buf
as an array of unsigned 32-bit integers and swaps the
byte order in-place. Throws ERR_INVALID_BUFFER_SIZE
if buf.length
is not a multiple of 4.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
buf1.swap32();
console.log(buf1);
// Prints: <Buffer 04 03 02 01 08 07 06 05>
const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap32();
// Throws ERR_INVALID_BUFFER_SIZE.
A reference to buf
.
v5.10.0
-Interprets buf
as an array of 64-bit numbers and swaps byte order in-place.
+
Interprets buf
as an array of 64-bit numbers and swaps byte order in-place.
Throws ERR_INVALID_BUFFER_SIZE
if buf.length
is not a multiple of 8.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
console.log(buf1);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
buf1.swap64();
console.log(buf1);
// Prints: <Buffer 08 07 06 05 04 03 02 01>
const buf2 = Buffer.from([0x1, 0x2, 0x3]);
buf2.swap64();
// Throws ERR_INVALID_BUFFER_SIZE.
A reference to buf
.
v6.3.0
-Returns a JSON representation of buf
. JSON.stringify()
implicitly calls
+
Returns a JSON representation of buf
. JSON.stringify()
implicitly calls
this function when stringifying a Buffer
instance.
Buffer.from()
accepts objects in the format returned from this method.
In particular, Buffer.from(buf.toJSON())
works like Buffer.from(buf)
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
const json = JSON.stringify(buf);
console.log(json);
// Prints: {"type":"Buffer","data":[1,2,3,4,5]}
const copy = JSON.parse(json, (key, value) => {
return value && value.type === 'Buffer' ?
Buffer.from(value) :
value;
});
console.log(copy);
// Prints: <Buffer 01 02 03 04 05>
v0.9.2
-Decodes buf
to a string according to the specified character encoding inencoding
. start
and end
may be passed to decode only a subset of buf
.
If encoding
is 'utf8'
and a byte sequence in the input is not valid UTF-8,
then each invalid byte is replaced with the replacement character U+FFFD
.
The maximum length of a string instance (in UTF-16 code units) is available @@ -530,13 +530,13 @@
Use subarray
instead.
Optional
start: numberThe byte offset to start decoding at.
Optional
end: numberThe byte offset to stop decoding at (not inclusive).
v0.1.90
-Creates and returns an iterator for buf
values (bytes). This function is
+
Creates and returns an iterator for buf
values (bytes). This function is
called automatically when a Buffer
is used in a for..of
statement.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('buffer');
for (const value of buf.values()) {
console.log(value);
}
// Prints:
// 98
// 117
// 102
// 102
// 101
// 114
for (const value of buf) {
console.log(value);
}
// Prints:
// 98
// 117
// 102
// 102
// 101
// 114
v1.1.0
-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
@@ -545,7 +545,7 @@ Deprecated
Use subarray
instead.
Optional
encoding: BufferEncodingThe character encoding of string
.
Number of bytes written.
v0.1.90
-Optional
encoding: BufferEncodingOptional
encoding: BufferEncodingWrites value
to buf
at the specified offset
as big-endian.
Optional
encoding: BufferEncodingOptional
encoding: BufferEncodingWrites value
to buf
at the specified offset
as big-endian.
value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigInt64BE(0x0102030405060708n, 0);
console.log(buf);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
@@ -553,7 +553,7 @@ Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as little-endian.
value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigInt64LE(0x0102030405060708n, 0);
console.log(buf);
// Prints: <Buffer 08 07 06 05 04 03 02 01>
@@ -561,7 +561,7 @@ Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as big-endian.
This function is also available under the writeBigUint64BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigUInt64BE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints: <Buffer de ca fa fe ca ce fa de>
@@ -569,7 +569,7 @@ Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as little-endian
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeBigUInt64LE(0xdecafafecacefaden, 0);
console.log(buf);
// Prints: <Buffer de fa ce ca fe fa ca de>
This function is also available under the writeBigUint64LE
alias.
Use subarray
instead.
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v12.0.0, v10.20.0
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a JavaScript number. Behavior is undefined when value
is anything
other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeDoubleBE(123.456, 0);
console.log(buf);
// Prints: <Buffer 40 5e dd 2f 1a 9f be 77>
@@ -589,7 +589,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a JavaScript number. Behavior is undefined when value
is anything
other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(8);
buf.writeDoubleLE(123.456, 0);
console.log(buf);
// Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>
@@ -597,7 +597,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as big-endian. Behavior is
undefined when value
is anything other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeFloatBE(0xcafebabe, 0);
console.log(buf);
// Prints: <Buffer 4f 4a fe bb>
@@ -605,7 +605,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as little-endian. Behavior is
undefined when value
is anything other than a JavaScript number.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeFloatLE(0xcafebabe, 0);
console.log(buf);
// Prints: <Buffer bb fe 4a 4f>
@@ -613,7 +613,7 @@ v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid signed 16-bit integer. Behavior is undefined when value
is
anything other than a signed 16-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
buf.writeInt16BE(0x0102, 0);
console.log(buf);
// Prints: <Buffer 01 02>
@@ -622,7 +622,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid signed 16-bit integer. Behavior is undefined when value
is
anything other than a signed 16-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(2);
buf.writeInt16LE(0x0304, 0);
console.log(buf);
// Prints: <Buffer 04 03>
@@ -631,7 +631,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid signed 32-bit integer. Behavior is undefined when value
is
anything other than a signed 32-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeInt32BE(0x01020304, 0);
console.log(buf);
// Prints: <Buffer 01 02 03 04>
@@ -640,7 +640,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid signed 32-bit integer. Behavior is undefined when value
is
anything other than a signed 32-bit integer.
The value
is interpreted and written as a two's complement signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeInt32LE(0x05060708, 0);
console.log(buf);
// Prints: <Buffer 08 07 06 05>
@@ -649,7 +649,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
. value
must be a valid
signed 8-bit integer. Behavior is undefined when value
is anything other than
a signed 8-bit integer.
value
is interpreted and written as a two's complement signed integer.
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1
.
offset
plus the number of bytes written.
v0.5.0
-Writes byteLength
bytes of value
to buf
at the specified offset
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue
is anything other than a
signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer 12 34 56 78 90 ab>
@@ -668,7 +668,7 @@ v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.11.15
-Writes byteLength
bytes of value
to buf
at the specified offset
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when value
is anything other than a signed integer.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer ab 90 78 56 34 12>
@@ -677,7 +677,7 @@ v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.11.15
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid unsigned 16-bit integer. Behavior is undefined when value
is anything other than an
unsigned 16-bit integer.
This function is also available under the writeUint16BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt16BE(0xdead, 0);
buf.writeUInt16BE(0xbeef, 2);
console.log(buf);
// Prints: <Buffer de ad be ef>
@@ -686,7 +686,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid unsigned 16-bit integer. Behavior is undefined when value
is
anything other than an unsigned 16-bit integer.
This function is also available under the writeUint16LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt16LE(0xdead, 0);
buf.writeUInt16LE(0xbeef, 2);
console.log(buf);
// Prints: <Buffer ad de ef be>
@@ -695,7 +695,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as big-endian. The value
must be a valid unsigned 32-bit integer. Behavior is undefined when value
is anything other than an
unsigned 32-bit integer.
This function is also available under the writeUint32BE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt32BE(0xfeedface, 0);
console.log(buf);
// Prints: <Buffer fe ed fa ce>
@@ -704,7 +704,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
as little-endian. The value
must be a valid unsigned 32-bit integer. Behavior is undefined when value
is
anything other than an unsigned 32-bit integer.
This function is also available under the writeUint32LE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(4);
buf.writeUInt32LE(0xfeedface, 0);
console.log(buf);
// Prints: <Buffer ce fa ed fe>
@@ -713,7 +713,7 @@ Since
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4
.
offset
plus the number of bytes written.
v0.5.5
-Writes value
to buf
at the specified offset
. value
must be a
valid unsigned 8-bit integer. Behavior is undefined when value
is anything
other than an unsigned 8-bit integer.
This function is also available under the writeUint8
alias.
v14.10.0, v12.19.0
Optional
offset: numberNumber of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1
.
offset
plus the number of bytes written.
v0.5.0
-Writes byteLength
bytes of value
to buf
at the specified offset
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when value
is anything other than an unsigned integer.
This function is also available under the writeUintBE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer 12 34 56 78 90 ab>
@@ -733,7 +733,7 @@ Since
v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.5.5
-Writes byteLength
bytes of value
to buf
at the specified offset
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when value
is anything other than an unsigned integer.
This function is also available under the writeUintLE
alias.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(6);
buf.writeUIntLE(0x1234567890ab, 0, 6);
console.log(buf);
// Prints: <Buffer ab 90 78 56 34 12>
@@ -743,18 +743,18 @@ Since
v14.10.0, v12.19.0
Number of bytes to write. Must satisfy 0 < byteLength <= 6
.
offset
plus the number of bytes written.
v0.5.5
-Generated using TypeDoc
Generated using TypeDoc
Raw data is stored in instances of the Buffer class. +
Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'
-Allocates a new buffer containing the given {str}.
+Allocates a new buffer containing the given {str}.
String to store in buffer.
Optional
encoding: BufferEncodingencoding to use, optional. Default is 'utf8'
since v10.0.0 - Use Buffer.from(string[, encoding])
instead.
Allocates a new buffer of {size} octets.
+Allocates a new buffer of {size} octets.
count of octets to allocate.
since v10.0.0 - Use Buffer.alloc()
instead (also see Buffer.allocUnsafe()
).
Allocates a new buffer containing the given {array} of octets.
+Allocates a new buffer containing the given {array} of octets.
The octets to store.
since v10.0.0 - Use Buffer.from(array)
instead.
Produces a Buffer backed by the same allocated memory as +
Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}/{SharedArrayBuffer}.
The ArrayBuffer with which to share memory.
since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]])
instead.
Allocates a new buffer containing the given {array} of octets.
+Allocates a new buffer containing the given {array} of octets.
The octets to store.
since v10.0.0 - Use Buffer.from(array)
instead.
Copies the passed {buffer} data onto a new {Buffer} instance.
+Copies the passed {buffer} data onto a new {Buffer} instance.
The buffer to copy.
since v10.0.0 - Use Buffer.from(buffer)
instead.
This is the size (in bytes) of pre-allocated internal Buffer
instances used
+
This is the size (in bytes) of pre-allocated internal Buffer
instances used
for pooling. This value may be modified.
v0.11.3
-Allocates a new Buffer
of size
bytes. If fill
is undefined
, theBuffer
will be zero-filled.
Allocates a new Buffer
of size
bytes. If fill
is undefined
, theBuffer
will be zero-filled.
import { Buffer } from 'node:buffer';
const buf = Buffer.alloc(5);
console.log(buf);
// Prints: <Buffer 00 00 00 00 00>
If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown.
Optional
fill: string | number | Uint8ArrayA value to pre-fill the new Buffer
with.
Optional
encoding: BufferEncodingIf fill
is a string, this is its encoding.
v5.10.0
-Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown.
Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown.
The underlying memory for Buffer
instances created in this way is not
initialized. The contents of the newly created Buffer
are unknown and may contain sensitive data. Use Buffer.alloc()
instead to initializeBuffer
instances with zeroes.
import { Buffer } from 'node:buffer';
const buf = Buffer.allocUnsafe(10);
console.log(buf);
// Prints (contents may vary): <Buffer a0 8b 28 3f 01 00 00 00 50 32>
buf.fill(0);
console.log(buf);
// Prints: <Buffer 00 00 00 00 00 00 00 00 00 00>
@@ -73,7 +73,7 @@
additional performance that Buffer.allocUnsafe()
provides.
The desired length of the new Buffer
.
v5.10.0
-Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown. A zero-length Buffer
is created if
+
Allocates a new Buffer
of size
bytes. If size
is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE
is thrown. A zero-length Buffer
is created if
size
is 0.
The underlying memory for Buffer
instances created in this way is not
initialized. The contents of the newly created Buffer
are unknown and may contain sensitive data. Use buf.fill(0)
to initialize
@@ -93,7 +93,7 @@
A TypeError
will be thrown if size
is not a number.
The desired length of the new Buffer
.
v5.12.0
-Returns the byte length of a string when encoded using encoding
.
This is not the same as String.prototype.length
, which does not account
for the encoding that is used to convert the string into bytes.
For 'base64'
, 'base64url'
, and 'hex'
, this function assumes valid input.
@@ -110,12 +110,12 @@
Optional
encoding: BufferEncodingIf string
is a string, this is its encoding.
The number of bytes contained within string
.
v0.1.90
-Compares buf1
to buf2
, typically for the purpose of sorting arrays ofBuffer
instances. This is equivalent to calling buf1.compare(buf2)
.
import { Buffer } from 'node:buffer';
const buf1 = Buffer.from('1234');
const buf2 = Buffer.from('0123');
const arr = [buf1, buf2];
console.log(arr.sort(Buffer.compare));
// Prints: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
// (This result is equal to: [buf2, buf1].)
Either -1
, 0
, or 1
, depending on the result of the comparison. See compare
for details.
v0.11.13
-Returns a new Buffer
which is the result of concatenating all the Buffer
instances in the list
together.
Returns a new Buffer
which is the result of concatenating all the Buffer
instances in the list
together.
If the list has no items, or if the totalLength
is 0, then a new zero-lengthBuffer
is returned.
If totalLength
is not provided, it is calculated from the Buffer
instances
in list
by adding their lengths.
List of Buffer
or Uint8Array instances to concatenate.
Optional
totalLength: numberTotal length of the Buffer
instances in list
when concatenated.
v0.7.11
-Copies the underlying memory of view
into a new Buffer
.
Copies the underlying memory of view
into a new Buffer
.
const u16 = new Uint16Array([0, 0xffff]);
const buf = Buffer.copyBytesFrom(u16, 1, 1);
u16[1] = 0;
console.log(buf.length); // 2
console.log(buf[0]); // 255
console.log(buf[1]); // 255
The {TypedArray} to copy.
Optional
offset: numberThe starting offset within view
.
Optional
length: numberThe number of elements from view
to copy.
v19.8.0
-Allocates a new Buffer
using an array
of bytes in the range 0
– 255
.
+
Allocates a new Buffer
using an array
of bytes in the range 0
– 255
.
Array entries outside that range will be truncated to fit into it.
import { Buffer } from 'node:buffer';
// Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
@@ -146,20 +146,20 @@
appropriate for Buffer.from()
variants.
Buffer.from(array)
and Buffer.from(string)
may also use the internalBuffer
pool like Buffer.allocUnsafe()
does.
Optional
byteOffset: numberOptional
length: numberv5.10.0
-Creates a new Buffer using the passed {data}
+Creates a new Buffer using the passed {data}
data to create a new Buffer
-Creates a new Buffer containing the given JavaScript string {str}. +
Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.
-Optional
encoding: BufferEncodingReturns true
if obj
is a Buffer
, false
otherwise.
Optional
encoding: BufferEncodingReturns true
if obj
is a Buffer
, false
otherwise.
import { Buffer } from 'node:buffer';
Buffer.isBuffer(Buffer.alloc(10)); // true
Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false
v0.1.101
-Returns true
if encoding
is the name of a supported character encoding,
+
Returns true
if encoding
is the name of a supported character encoding,
or false
otherwise.
import { Buffer } from 'node:buffer';
console.log(Buffer.isEncoding('utf8'));
// Prints: true
console.log(Buffer.isEncoding('hex'));
// Prints: true
console.log(Buffer.isEncoding('utf/8'));
// Prints: false
console.log(Buffer.isEncoding(''));
// Prints: false
A character encoding name to check.
v0.9.1
-Generated using TypeDoc
Generated using TypeDoc
Rest
...args: [] | [undefined]Optional
returnOptional
value: anyOptional
throwOptional
e: anyGenerated using TypeDoc
Rest
...args: [] | [undefined]Optional
returnOptional
value: anyOptional
throwOptional
e: anyGenerated using TypeDoc
Rest
...args: [] | [TNext]Optional
returnOptional
value: TReturnOptional
throwOptional
e: anyGenerated using TypeDoc
Rest
...args: [] | [TNext]Optional
returnOptional
value: TReturnOptional
throwOptional
e: anyGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional
noncesOptional
randsOptional
verifyGenerated using TypeDoc
Optional
noncesOptional
randsOptional
verifyGenerated using TypeDoc
Readonly
[species]Readonly
[toReadonly
byteRead-only. The length of the ArrayBuffer (in bytes).
-Returns a section of an SharedArrayBuffer.
-Optional
end: numberGenerated using TypeDoc
Readonly
[species]Readonly
[toReadonly
byteRead-only. The length of the ArrayBuffer (in bytes).
+Returns a section of an SharedArrayBuffer.
+Optional
end: numberGenerated using TypeDoc
Readonly
prototypeGenerated using TypeDoc
Readonly
prototypeGenerated using TypeDoc
The main
branch is under continuous development and will usually be partway between DAP and VDAF
@@ -104,4 +104,4 @@
<script
src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
crossorigin="anonymous"
integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The main
branch is under continuous development and will usually be partway between DAP and VDAF
@@ -104,13 +104,13 @@
<script
src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
crossorigin="anonymous"
integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The main
branch is under continuous development and will usually be partway between DAP and VDAF
@@ -104,10 +104,10 @@
<script
src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
crossorigin="anonymous"
integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The main
branch is under continuous development and will usually be partway between DAP and VDAF
@@ -104,10 +104,10 @@
<script
src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
crossorigin="anonymous"
integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The main
branch is under continuous development and will usually be partway between DAP and VDAF
@@ -104,12 +104,12 @@
<script
src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
crossorigin="anonymous"
integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional
init: RequestInitGenerated using TypeDoc
Optional
init: RequestInitGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Const
The supported Authenticated Encryption with Associated Data (AEAD) identifiers.
-Readonly
Aes128Readonly
Aes256Readonly
Chacha20Readonly
ExportGenerated using TypeDoc
Const
The supported Authenticated Encryption with Associated Data (AEAD) identifiers.
+Readonly
Aes128Readonly
Aes256Readonly
Chacha20Readonly
ExportGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Const
The supported Key Derivation Function (KDF) identifiers.
-Readonly
HkdfReadonly
HkdfReadonly
HkdfGenerated using TypeDoc
Const
The supported Key Derivation Function (KDF) identifiers.
+Readonly
HkdfReadonly
HkdfReadonly
HkdfGenerated using TypeDoc
Const
The supported Key Encapsulation Mechanism (KEM) identifiers.
-Readonly
DhkemReadonly
DhkemReadonly
DhkemReadonly
DhkemReadonly
DhkemReadonly
DhkemReadonly
HybridkemReadonly
NotGenerated using TypeDoc
Const
The supported Key Encapsulation Mechanism (KEM) identifiers.
+Readonly
DhkemReadonly
DhkemReadonly
DhkemReadonly
DhkemReadonly
DhkemReadonly
DhkemReadonly
HybridkemReadonly
NotGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Const
Generated using TypeDoc
Const
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional override for formatting stack traces
-