Skip to main content
Home
Browse packagesDocs
Sign In with GitHubSign In with GitLab

@std/streams@0.215.0

latest
Works with
It is unknown whether this package works with Node.js, Deno, Browsers, Cloudflare Workers, Bun
It is unknown whether this package works with Node.js
It is unknown whether this package works with Deno
It is unknown whether this package works with Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Bun
•JSR Score70%•
Published2 years ago (0.215.0)
class Buffer

A variable-sized buffer of bytes with read() and write() methods.

Buffer is almost always used with some I/O like files and sockets. It allows one to buffer up a download from a socket. Buffer grows and shrinks as necessary.

Buffer is NOT the same thing as Node's Buffer. Node's Buffer was created in 2009 before JavaScript had the concept of ArrayBuffers. It's simply a non-standard ArrayBuffer.

ArrayBuffer is a fixed memory allocation. Buffer is implemented on top of ArrayBuffer.

Based on Go Buffer.

Constructors

new Buffer(ab?: ArrayBufferLike | ArrayLike<number>)

Constructs a new instance.

Properties

readonly
capacity: number

The read only capacity of the buffer's underlying byte slice, that is, the total space allocated for the buffer's data.

readonly
length: number

A read only number of bytes of the unread portion of the buffer.

readonly
readable: ReadableStream<Uint8Array>

Getter returning the instance's ReadableStream.

readonly
writable: WritableStream<Uint8Array>

Getter returning the instance's WritableStream.

Methods

bytes(options?): Uint8Array

Returns a slice holding the unread portion of the buffer.

The slice is valid for use only until the next buffer modification (that is, only until the next call to a method like read(), write(), reset(), or truncate()). If options.copy is false the slice aliases the buffer content at least until the next buffer modification, so immediate changes to the slice will affect the result of future reads.

empty(): boolean

Returns whether the unread portion of the buffer is empty.

grow(n: number): void

Grows the buffer's capacity, if necessary, to guarantee space for another n bytes. After .grow(n), at least n bytes can be written to the buffer without another allocation. If n is negative, .grow() will throw. If the buffer can't grow it will throw an error.

Based on Go Lang's Buffer.Grow.

reset(): void

Resets to an empty buffer.

truncate(n: number): void

Discards all but the first n unread bytes from the buffer but continues to use the same allocated storage. It throws if n is negative or greater than the length of the buffer.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/streams

Import symbol

import { Buffer } from "@std/streams";
or

Import directly with a jsr specifier

import { Buffer } from "jsr:@std/streams";