module buffer

Supported only in the v8 engine. Introduced in Max v9.2.0.

The buffer module exposed by require("buffer"), providing the buffer.IOBuffer class for handling binary data.

IOBuffer is the binary type used throughout the v8 networking APIs. It is a Uint8Array subclass in the spirit of Node's Buffer, but is not full Node Buffer parity. There is no global Buffer alias (which would conflict with the Max buffer~ wrapper). See buffer.IOBuffer for details.

Example

const { IOBuffer } = require("buffer");
const buf = IOBuffer.from("hello");
post(buf.toString(), "\n"); // hello

Index

Classes

• IOBuffer

Type Aliases

• IOBufferEncoding

class IOBuffer

A Uint8Array subclass for binary data, used throughout the v8 networking APIs.

IOBuffer is the binary type used throughout the networking APIs. It is a subclass of Uint8Array. There is no global Buffer alias (which would conflict with the Max buffer~ wrapper), and IOBuffer is not full Node Buffer parity.

Obtain the class with const { IOBuffer } = require("buffer").

Example

const { IOBuffer } = require("buffer");
const a = IOBuffer.from("hello");
const b = IOBuffer.from("68656c6c6f", "hex");
post(a.equals(b), "\n"); // true
post(a.toString("base64"), "\n");

Constructors

• new IOBuffer(value, encoding)

Methods

• IOBuffer.alloc(size, fill)
• IOBuffer.byteLength(value, encoding)
• IOBuffer.concat(items)
• equals(other)
• IOBuffer.from(value, encoding)
• IOBuffer.from(arrayLike, mapfn, thisArg)
• IOBuffer.from(arrayLike, mapfn, thisArg)
• IOBuffer.isBuffer(value)
• slice(start, end)
• toString(encoding, start, end)
• toUint8Array()

new IOBuffer(value, encoding)

new IOBuffer(
  value?:
    number | ArrayBuffer | ArrayBufferView | string | ArrayLike<number>,
  encoding?: IOBufferEncoding,
);

Constructs a new instance of the IOBuffer class

IOBuffer.alloc(size, fill) static

Allocates a zero- or fill-initialized IOBuffer of the given size.

static alloc(size: number, fill?: number | string): IOBuffer;

IOBuffer.byteLength(value, encoding) static

Returns the byte length of a string in the given encoding.

static byteLength(value: string, encoding?: IOBufferEncoding): number;

IOBuffer.concat(items) static

Concatenates several buffers into one.

static concat(items: IOBuffer[]): IOBuffer;

equals(other)

Returns whether this buffer has the same bytes as another.

equals(other: IOBuffer): boolean;

IOBuffer.from(value, encoding) static

Creates an IOBuffer from a value.

static from(
  value: ArrayBuffer | ArrayBufferView | string | ArrayLike<number>,
  encoding?: IOBufferEncoding,
): IOBuffer;

IOBuffer.from(arrayLike, mapfn, thisArg) static

Inherited Uint8Array.from form with a map function.

static from(
  arrayLike: Iterable<number> | ArrayLike<number>,
  mapfn?: (v: number, k: number) => number,
  thisArg?: any,
): IOBuffer;

IOBuffer.from(arrayLike, mapfn, thisArg) static

Inherited Uint8Array.from form with a map function.

static from<T>(
  arrayLike: Iterable<T> | ArrayLike<T>,
  mapfn: (v: T, k: number) => number,
  thisArg?: any,
): IOBuffer;

IOBuffer.isBuffer(value) static

Returns whether a value is an IOBuffer.

static isBuffer(value: any): boolean;

slice(start, end)

Returns a new IOBuffer over a byte range (a view, like Uint8Array.slice).

slice(start?: number, end?: number): IOBuffer;

toString(encoding, start, end)

Decodes (a range of) the buffer to a string.

toString(encoding?: IOBufferEncoding, start?: number, end?: number): string;

toUint8Array()

Returns a plain Uint8Array view of the same bytes.

toUint8Array(): Uint8Array;

type IOBufferEncoding

Encodings accepted by buffer.IOBuffer construction and conversion.

type IOBufferEncoding = "utf8" | "ascii" | "base64" | "hex";