type

ArchiveInput

type ArchiveInput = Record<string, BlobPart> | Blob | ArrayBufferView | ArrayBufferLike

Input data for creating an archive. Can be:

An object mapping paths to file contents (string, Blob, TypedArray, or ArrayBuffer)
A Blob containing existing archive data
A TypedArray or ArrayBuffer containing existing archive data

Referenced types

type BlobPart = string | Blob | BufferSource

class Blob

A file-like object of immutable, raw data. Blobs represent data that isn't necessarily in a JavaScript-native format. The File interface is based on Blob, inheriting blob functionality and expanding it to support files on the user's system.

MDN Reference

readonly size: number
MDN Reference
readonly type: string
MDN Reference
arrayBuffer(): Promise<ArrayBuffer>;
Returns a promise that resolves to the contents of the blob as an ArrayBuffer
bytes(): Promise<Uint8Array<ArrayBufferLike>>;
MDN Reference
bytes(): Promise<Uint8Array<ArrayBuffer>>;
Returns a promise that resolves to the contents of the blob as a Uint8Array (array of bytes) its the same as new Uint8Array(await blob.arrayBuffer())
formData(): Promise<FormData>;
Read the data from the blob as a FormData object.
This first decodes the data from UTF-8, then parses it as a multipart/form-data body or a application/x-www-form-urlencoded body.
The type property of the blob is used to determine the format of the body.
This is a non-standard addition to the Blob API, to make it conform more closely to the BodyMixin API.
image(
options?: ConstructorOptions
): Image;
Wrap this blob in a Bun.Image pipeline. Equivalent to new Bun.Image(this, options) — the constructor is synchronous (the underlying read happens lazily when an Image terminal is awaited), so this works on Bun.file(), Bun.s3(), fd-backed and in-memory blobs alike:
await Bun.file("photo.jpg").image().resize(400).webp().write("thumb.webp");
json(): Promise<any>;
Read the data from the blob as a JSON object.
This first decodes the data from UTF-8, then parses it as JSON.
slice(
start?: number,
end?: number,
contentType?: string
): Blob;
MDN Reference
stream(): ReadableStream<Uint8Array<ArrayBufferLike>>;
MDN Reference
stream(): ReadableStream<Uint8Array<ArrayBuffer>>;
Returns a readable stream of the blob's contents
text(): Promise<string>;
Returns a promise that resolves to the contents of the blob as a string

type ArrayBufferView<TArrayBuffer extends ArrayBufferLike = ArrayBufferLike> = NodeJS.TypedArray<TArrayBuffer> | DataView<TArrayBuffer>