温馨提示:本站仅提供公开网络链接索引服务,不存储、不篡改任何第三方内容,所有内容版权归原作者所有
AI智能索引来源:http://www.bun.com/reference/bun/BodyInit
点击访问原文链接

Bun.BodyInit TypeScript type alias | API Reference | Bun

Bun.BodyInit TypeScript type alias | API Reference | BunBuildDocsReferenceGuidesBlogDiscord/Bun/BodyInitTBodyInit

Search the reference...

/

BuildDocsReferenceGuidesBlogDiscord/Bun/BodyInitTBodyInit

type

BodyInittype BodyInit = ReadableStream | Bun.XMLHttpRequestBodyInit | AsyncIterablestring | ArrayBuffer | ArrayBufferView> | AsyncGeneratorstring | ArrayBuffer | ArrayBufferView> | () => AsyncGeneratorstring | ArrayBuffer | ArrayBufferView> | ImageReferenced typesclass 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[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIteratorR>;cancel(reason?: any): Promisevoid>;getReader(options: { mode: 'byob' }): ReadableStreamBYOBReader;getReader(): ReadableStreamDefaultReaderR>;getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReaderR>;pipeThroughT>(transform: ReadableWritablePairT, R>,options?: StreamPipeOptions): ReadableStreamT>;pipeTo(destination: WritableStreamR>,options?: StreamPipeOptions): Promisevoid>;tee(): [ReadableStreamR>, ReadableStreamR>];values(options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIteratorR>;type XMLHttpRequestBodyInit = Blob | BufferSource | FormData | URLSearchParams | stringclass ArrayBuffer

Represents a raw buffer of binary data, which is used to store data for the different typed arrays. ArrayBuffers cannot be read from or written to directly, but can be passed to a typed array or DataView Object to interpret the raw buffer as needed.

readonly [Symbol.toStringTag]: stringreadonly byteLength: number

Read-only. The length of the ArrayBuffer (in bytes).

resize(newByteLength?: number): void;

Resizes the ArrayBuffer to the specified size (in bytes).

MDN

resize(byteLength: number): ArrayBuffer;

Resize an ArrayBuffer in-place.

slice(begin: number,end?: number): ArrayBuffer;

Returns a section of an ArrayBuffer.

transfer(newByteLength?: number): ArrayBuffer;

Creates a new ArrayBuffer with the same byte content as this buffer, then detaches this buffer.

MDN

transferToFixedLength(newByteLength?: number): ArrayBuffer;

Creates a new non-resizable ArrayBuffer with the same byte content as this buffer, then detaches this buffer.

MDN

type ArrayBufferViewTArrayBuffer extends ArrayBufferLike = ArrayBufferLike> = NodeJS.TypedArrayTArrayBuffer> | DataViewTArrayBuffer>namespace Imageinterface ConstructorOptionsautoOrient?: boolean

Apply EXIF Orientation (JPEG) before any other operation.

maxPixels?: number

Reject inputs whose width × height exceeds this many pixels. The check runs after the header is read but before any pixel buffer is allocated, so a tiny file claiming a huge canvas is refused cheaply.

interface Metadataformat: Formatheight: numberwidth: numberinterface ModulateOptionsbrightness?: number

Multiplier; 1 leaves brightness unchanged.

1` = more saturated." data-algolia-static="false" data-algolia-merged="false" data-type="Property">saturation?: number

0 = greyscale, 1 = unchanged, >1 = more saturated.

interface ResizeOptionsfilter?: Filter

Resampling kernel.

fit?: 'fill' | 'inside'

"fill" stretches to exactly width×height. "inside" preserves aspect ratio so the result fits within width×height.

withoutEnlargement?: boolean

Never upscale — if the source is already smaller, leave it.

type ErrorCode = 'ERR_IMAGE_FORMAT_UNSUPPORTED' | 'ERR_IMAGE_TOO_MANY_PIXELS' | 'ERR_IMAGE_DECODE_FAILED' | 'ERR_IMAGE_ENCODE_FAILED' | 'ERR_IMAGE_UNKNOWN_FORMAT' | 'ERR_INVALID_STATE'

Stable error.code values set on rejections from Bun.Image terminals. Branch on these instead of parsing the message.

ERR_IMAGE_FORMAT_UNSUPPORTED — the requested format isn't available on this machine (HEIC/AVIF without the OS codec, TIFF on Linux). Catch this to fall back to a portable format.ERR_IMAGE_TOO_MANY_PIXELS — header dimensions or resize output exceed maxPixels, or a path-backed input is over the 256 MiB cap.ERR_IMAGE_DECODE_FAILED / ERR_IMAGE_ENCODE_FAILED — codec error.ERR_IMAGE_UNKNOWN_FORMAT — input bytes didn't match any sniffer.ERR_INVALID_STATE — the input ArrayBuffer was transferred between construction and the terminal call.File-backed inputs surface the underlying syscall code (ENOENT, EACCES, …) directly.
type Filter = 'nearest' | 'box' | 'bilinear' | 'linear' | 'cubic' | 'mitchell' | 'lanczos2' | 'lanczos3' | 'mks2013' | 'mks2021'type Format = 'jpeg' | 'png' | 'webp' | 'heic' | 'avif' | 'bmp' | 'tiff' | 'gif'

bmp/tiff/gif are decode-only — metadata().format may report them but there are no .bmp()/.tiff()/.gif() encoder methods. tiff decode rejects with error.code === "ERR_IMAGE_FORMAT_UNSUPPORTED" on Linux; gif decodes the first frame everywhere.

Resources

ReferenceDocsGuidesDiscordMerch StoreGitHubBlog 

Toolkit

RuntimePackage managerTest runnerBundlerPackage runner

Project

Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicense

Baked with ❤️ in San Francisco

We're hiring →

Bun.BodyInit TypeScript type alias | API Reference | Bun,AI智能索引,全网链接索引,智能导航,网页索引

    API documentation for type bun.BodyInit | Bun