type alias Writable | Bun module | Bun

type alias Writable | Bun module | BunBuild Docs Reference Guides Blog Discord/Bun/Spawn/WritableTWritable

Search the reference...

Build Docs Reference Guides Blog Discord/Bun/Spawn/WritableTWritable

type

Option for stdin

Referenced typesinterface BunFile

Blob powered by the fastest system calls available for operating on files.

This Blob is lazy. That means it won't do any work until you read from it.

size will not be valid until the contents of the file are read at least once.type is auto-set based on the file extension when possible

const file = Bun.file("./hello.json");
console.log(file.type); // "application/json"
console.log(await file.text()); // '{"hello":"world"}'

lastModified: number

A UNIX timestamp indicating when the file was last modified.

readonly name?: string

The name or path of the file, as specified in the constructor.

readonly size: number

MDN Reference

readonly type: string

MDN Reference

arrayBuffer(): PromiseArrayBuffer>;

Returns a promise that resolves to the contents of the blob as an ArrayBuffer

bytes(): PromiseUint8ArrayArrayBufferLike>>;

MDN Reference

bytes(): PromiseUint8Array 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())

delete(): Promisevoid>;

Deletes the file (same as unlink)

exists(): Promiseboolean>;

Does the file exist?

This returns true for regular files and FIFOs. It returns false for directories. Note that a race condition can occur where the file is deleted or renamed after this is called but before you open it.

This does a system call to check if the file exists, which can be slow.

If using this in an HTTP server, it's faster to instead use return new Response(Bun.file(path)) and then an error handler to handle exceptions.

Instead of checking for a file's existence and then performing the operation, it is faster to just perform the operation and handle the error.

For empty Blob, this always returns true.

formData(): PromiseFormData>;

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(): Promiseany>;

Read the data from the blob as a JSON object.

This first decodes the data from UTF-8, then parses it as JSON.

0, () will be slower on macOS" data-algolia-static="false" data-algolia-merged="false" data-type="Method">slice(begin?: number,end?: number,contentType?: string): BunFile;

Offset any operation on the file starting at begin and ending at end. end is relative to 0

Similar to TypedArray.subarray. Does not copy the file, open the file, or modify the file.

If begin > 0, () will be slower on macOS

@param begin

start offset in bytes

@param end

absolute offset in bytes (relative to 0)

@param contentType

MIME type for the new BunFile

slice(begin?: number,contentType?: string): BunFile;

Offset any operation on the file starting at begin

Similar to TypedArray.subarray. Does not copy the file, open the file, or modify the file.

If begin > 0, Bun.write() will be slower on macOS

@param begin

start offset in bytes

@param contentType

MIME type for the new BunFile

slice(contentType?: string): BunFile;

Slice the file from the beginning to the end, optionally with a new MIME type.

@param contentType

MIME type for the new BunFile

stat(): PromiseStats>;

Provides useful information about the file.

stream(): ReadableStream Uint8ArrayArrayBufferLike>>;

MDN Reference

stream(): ReadableStream Uint8Array ArrayBuffer>>;

Returns a readable stream of the blob's contents

text(): Promisestring>;

Returns a promise that resolves to the contents of the blob as a string

unlink(): Promisevoid>;

Deletes the file.

write(data: string | ArrayBuffer | SharedArrayBuffer | BunFile | Request | Response | ArrayBufferViewArrayBufferLike>,options?: { highWaterMark: number }): Promisenumber>;

Write data to the file. This is equivalent to using Bun.write with a BunFile.

@param data

The data to write.

@param options

The options to use for the write.

writer(options?: { highWaterMark: number }): FileSink;

Incremental writer for files and pipes.

type ArrayBufferViewTArrayBuffer extends ArrayBufferLike = ArrayBufferLike> = NodeJS.TypedArrayTArrayBuffer> | DataViewTArrayBuffer>class ReadableStreamR = any>

This Streams API interface represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.

MDN Reference

readonly locked: boolean

MDN Reference

[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIteratorR>;cancel(reason?: any): Promisevoid>;

MDN Reference

getReader(options: { mode: 'byob' }): ReadableStreamBYOBReader;

MDN Reference

getReader(): ReadableStreamDefaultReaderR>;getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReaderR>;pipeThroughT>(transform: ReadableWritablePairT, R>,options?: StreamPipeOptions): ReadableStreamT>;

MDN Reference

pipeTo(destination: WritableStreamR>,options?: StreamPipeOptions): Promisevoid>;

MDN Reference

tee(): [ReadableStreamR>, ReadableStreamR>];

MDN Reference

values(options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIteratorR>;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(): PromiseArrayBuffer>;

Returns a promise that resolves to the contents of the blob as an ArrayBuffer

bytes(): PromiseUint8ArrayArrayBufferLike>>;

MDN Reference

bytes(): PromiseUint8Array 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(): PromiseFormData>;

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;

await Bun.file("photo.jpg").image().resize(400).webp().write("thumb.webp");

json(): Promiseany>;

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 Uint8ArrayArrayBufferLike>>;

MDN Reference

stream(): ReadableStream Uint8Array ArrayBuffer>>;

Returns a readable stream of the blob's contents

text(): Promisestring>;

Returns a promise that resolves to the contents of the blob as a string

class Response

This Fetch API interface represents the response to a request.

MDN Reference

readonly body: null | ReadableStream Uint8ArrayArrayBufferLike>>

MDN Reference

readonly bodyUsed: boolean

MDN Reference

readonly headers: Headers

MDN Reference

readonly ok: boolean

MDN Reference

readonly redirected: boolean

MDN Reference

readonly status: number

MDN Reference

readonly statusText: string

MDN Reference

readonly type: ResponseType

MDN Reference

readonly url: string

MDN Reference

arrayBuffer(): PromiseArrayBuffer>;

MDN Reference

blob(): PromiseBlob>;

MDN Reference

bytes(): PromiseUint8ArrayArrayBufferLike>>;

MDN Reference

clone(): Response;

MDN Reference

formData(): PromiseFormData>;

MDN Reference

json(): Promiseany>;

MDN Reference

text(): Promisestring>;

MDN Reference

static error(): Response;

MDN Reference

static json(data: any,init?: ResponseInit): Response;

MDN Reference

static redirect(url: string | URL,status?: number): Response;

MDN Reference

class Request

This Fetch API interface represents a resource request.

MDN Reference

readonly body: null | ReadableStream Uint8ArrayArrayBufferLike>>

MDN Reference

readonly bodyUsed: boolean

MDN Reference

readonly cache: RequestCache

Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching.

MDN Reference

readonly credentials: RequestCredentials

Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL.

MDN Reference

readonly destination: RequestDestination

Returns the kind of resource requested by request, e.g., "document" or "script".

MDN Reference

readonly headers: Headers

Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header.

MDN Reference

readonly integrity: string

Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI]

MDN Reference

readonly keepalive: boolean

Returns a boolean indicating whether or not request can outlive the global in which it was created.

MDN Reference

readonly method: string

Returns request's HTTP method, which is "GET" by default.

MDN Reference

readonly mode: RequestMode

Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs.

MDN Reference

readonly redirect: RequestRedirect

Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default.

MDN Reference

readonly referrer: string

Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the Referer header of the request being made.

MDN Reference

readonly referrerPolicy: ReferrerPolicy

Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer.

MDN Reference

readonly signal: AbortSignal

Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler.

MDN Reference

readonly url: string

Returns the URL of request as a string.

MDN Reference

arrayBuffer(): PromiseArrayBuffer>;

MDN Reference

blob(): PromiseBlob>;

MDN Reference

bytes(): PromiseUint8ArrayArrayBufferLike>>;

MDN Reference

clone(): Request;

MDN Reference