@caido/quickjs-types / caido/http

caido/http

Classes

Blob

A Blob encapsulates immutable, raw data.

Extended by

• File

Constructors

Constructor

new Blob(parts: (string | Blob | ArrayBuffer)[], opts?: BlobOpts): Blob

Creates a new Blob object containing a concatenation of the given sources.

{ArrayBuffer}, and {Blob} sources are copied into the 'Blob' and can therefore be safely modified after the 'Blob' is created.

String sources are also copied into the Blob.

Parameters

Parameter	Type
parts	(string | Blob | ArrayBuffer)[]
opts?	BlobOpts

Returns

Blob

Properties

size

readonly size: number

The total size of the Blob in bytes.

type

readonly type: string

The content-type of the Blob.

Methods

arrayBuffer()

arrayBuffer(): Promise<ArrayBuffer>

Returns a promise that fulfills with an ArrayBuffer containing a copy of the Blob data.

Returns

Promise<ArrayBuffer>

bytes()

bytes(): Promise<Uint8Array>

Returns a promise that resolves with an Uint8Array containing the contents of the Blob.

Returns

Promise<Uint8Array>

slice()

slice(start?: number, end?: number, type?: string): Blob

Creates and returns a new Blob containing a subset of this Blob objects data. The original Blob is not altered.

Parameters

Parameter	Type	Description
start?	number	The starting index.
end?	number	The ending index.
type?	string	The content-type for the new Blob

Returns

Blob

text()

text(): Promise<string>

Returns a promise that fulfills with the contents of the Blob decoded as a UTF-8 string.

Returns

Promise<string>

---

File

A Blob encapsulates immutable, raw data.

Extends

• Blob

Constructors

Constructor

new File(data: (string | Blob | ArrayBuffer)[], fileName: string, opts?: FileOpts): File

Returns a newly constructed File.

Parameters

Parameter	Type
data	(string | Blob | ArrayBuffer)[]
fileName	string
opts?	FileOpts

Returns

File

Overrides

Blob.constructor

Properties

lastModified

readonly lastModified: number

The last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date.

name

readonly name: string

Name of the file referenced by the File object.

size

readonly size: number

The total size of the Blob in bytes.

Inherited from

Blob.size

type

readonly type: string

The content-type of the Blob.

Inherited from

Blob.type

Methods

arrayBuffer()

arrayBuffer(): Promise<ArrayBuffer>

Returns a promise that fulfills with an ArrayBuffer containing a copy of the Blob data.

Returns

Promise<ArrayBuffer>

Inherited from

Blob.arrayBuffer

bytes()

bytes(): Promise<Uint8Array>

Returns a promise that resolves with an Uint8Array containing the contents of the Blob.

Returns

Promise<Uint8Array>

Inherited from

Blob.bytes

slice()

slice(start?: number, end?: number, type?: string): Blob

Creates and returns a new Blob containing a subset of this Blob objects data. The original Blob is not altered.

Parameters

Parameter	Type	Description
start?	number	The starting index.
end?	number	The ending index.
type?	string	The content-type for the new Blob

Returns

Blob

Inherited from

Blob.slice

text()

text(): Promise<string>

Returns a promise that fulfills with the contents of the Blob decoded as a UTF-8 string.

Returns

Promise<string>

Inherited from

Blob.text

---

Headers

Implements

• Iterable<[string, string]>

Constructors

Constructor

new Headers(opts?: HeadersOpts): Headers

Creates a new Headers object.

Parameters

Parameter	Type
opts?	HeadersOpts

Returns

Headers

Properties

[iterator]()

readonly [iterator]: () => Iterator<[string, string]>

Returns

Iterator<[string, string]>

Implementation of

Iterable.[iterator]

append()

readonly append: (name: string, value: string) => void

Appends a new value onto an existing header inside a Headers object, or adds the header if it does not already exist.

Parameters

Parameter	Type
name	string
value	string

Returns

void

delete()

readonly delete: (name: string) => void

Deletes a header from a Headers object.

Parameters

Parameter	Type
name	string

Returns

void

entries()

readonly entries: () => IterableIterator<[string, string]>

Returns an iterator allowing to go through all key/value pairs contained in this object.

Returns

IterableIterator<[string, string]>

forEach()

readonly forEach: (callbackfn: (value: string, key: string) => void) => void

Executes a provided function once for each key/value pair in this Headers object.

Parameters

Parameter	Type
callbackfn	(value: string, key: string) => void

Returns

void

get()

readonly get: (name: string) => string | null

A String sequence representing the values of the retrieved header or null if this header is not set.

Parameters

Parameter	Type
name	string

Returns

string | null

getSetCookie()

readonly getSetCookie: () => string[]

Returns an array containing the values of all Set-Cookie headers associated with a response.

Returns

string[]

has()

readonly has: (name: string) => boolean

Returns a boolean stating whether a Headers object contains a certain header.

Parameters

Parameter	Type
name	string

Returns

boolean

keys()

readonly keys: () => IterableIterator<string>

Returns an iterator allowing you to go through all keys of the key/value pairs contained in this object.

Returns

IterableIterator<string>

set()

readonly set: (name: string, value: string) => void

Sets a new value for an existing header inside a Headers object, or adds the header if it does not already exist.

Parameters

Parameter	Type
name	string
value	string

Returns

void

values()

readonly values: () => IterableIterator<string>

Returns an iterator allowing you to go through all values of the key/value pairs contained in this object.

Returns

IterableIterator<string>

---

Request

The Request interface of the Fetch API represents a resource request.

Constructors

Constructor

new Request(input: string | Request, init?: RequestOpts): Request

Creates a new Request object.

Parameters

Parameter	Type
input	string | Request
init?	RequestOpts

Returns

Request

Properties

arrayBuffer()

readonly arrayBuffer: () => Promise<ArrayBuffer>

Returns a promise that resolves with an ArrayBuffer representation of the request body.

Returns

Promise<ArrayBuffer>

blob()

readonly blob: () => Promise<Blob>

Returns a promise that resolves with a Blob representation of the request body.

Returns

Promise<Blob>

body

readonly body: Body

The body content.

bodyUsed

readonly bodyUsed: boolean

Stores true or false to indicate whether or not the body has been used in a request yet.

bytes()

readonly bytes: () => Promise<Uint8Array>

Returns a promise that resolves with a Uint8Array representation of the request body.

Returns

Promise<Uint8Array>

cache

readonly cache: "no-cache"

Contains the cache mode of the request

clone()

readonly clone: () => Request

Creates a copy of the current Request object.

Returns

Request

headers

readonly headers: Headers

Contains the associated Headers object of the request.

json()

readonly json: () => Promise<unknown>

Returns a promise that resolves with the result of parsing the request body as JSON.

Returns

Promise<unknown>

keepalive

readonly keepalive: boolean

Contains the request's keepalive setting (true or false), which indicates whether llrt will keep the associated connection alive.

method

readonly method: string

Contains the request's method (GET, POST, etc.)

mode

readonly mode: "navigate"

Contains the mode of the request

signal

readonly signal: AbortSignal

Returns the AbortSignal associated with the request

text()

readonly text: () => Promise<string>

Returns a promise that resolves with a text representation of the request body.

Returns

Promise<string>

url

readonly url: string

Contains the URL of the request.

---

Response

The Response interface of the Fetch API represents the response to a request.

Constructors

Constructor

new Response(body?: Body, opts?: ResponseOpts): Response

Creates a new Response object.

Parameters

Parameter	Type
body?	Body
opts?	ResponseOpts

Returns

Response

Properties

arrayBuffer()

readonly arrayBuffer: () => Promise<ArrayBuffer>

Returns a promise that resolves with an ArrayBuffer representation of the response body.

Returns

Promise<ArrayBuffer>

blob()

readonly blob: () => Promise<Blob>

Returns a promise that resolves with a Blob representation of the response body.

Returns

Promise<Blob>

body

readonly body: null

The body content (NOT IMPLEMENTED YET).

bodyUsed

readonly bodyUsed: boolean

Stores a boolean value that declares whether the body has been used in a response yet.

clone()

readonly clone: () => Response

Creates a clone of a Response object.

Returns

Response

headers

readonly headers: Headers

The Headers object associated with the response.

json()

readonly json: () => Promise<unknown>

Returns a promise that resolves with the result of parsing the response body text as JSON.

Returns

Promise<unknown>

ok

readonly ok: boolean

A boolean indicating whether the response was successful (status in the range 200 – 299) or not.

redirected

readonly redirected: boolean

Indicates whether or not the response is the result of a redirect (that is, its URL list has more than one entry).

status

readonly status: number

The status code of the response. (This will be 200 for a success).

statusText

readonly statusText: string

The status message corresponding to the status code. (e.g., OK for 200).

text()

readonly text: () => Promise<string>

Returns a promise that resolves with a text representation of the response body.

Returns

Promise<string>

type

readonly type: ResponseType

The type of the response.

url

readonly url: string

Methods

error()

static error(): Response

Returns a new Response object associated with a network error.

Returns

Response

json()

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

Returns a new Response object for returning the provided JSON encoded data.

Parameters

Parameter	Type
data	any
init?	ResponseInit

Returns

Response

redirect()

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

Returns a new Response with a different URL.

Parameters

Parameter	Type
url	string
status?	number

Returns

Response

Interfaces

BlobOpts

Extended by

• FileOpts

Properties

endings?

optional endings: "transparent" | "native"

One of either 'transparent' or 'native'. When set to 'native', line endings in string source parts will be converted to the platform native line-ending as specified by import { EOL } from 'os'.

type?

optional type: string

The Blob content-type. The intent is for type to convey the MIME media type of the data, however no validation of the type format is performed.

---

FileOpts

Extends

• BlobOpts

Properties

endings?

optional endings: "transparent" | "native"

One of either 'transparent' or 'native'. When set to 'native', line endings in string source parts will be converted to the platform native line-ending as specified by import { EOL } from 'os'.

Inherited from

BlobOpts.endings

lastModified?

optional lastModified: number

The last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date.

type?

optional type: string

The Blob content-type. The intent is for type to convey the MIME media type of the data, however no validation of the type format is performed.

Inherited from

BlobOpts.type

---

RequestOpts

Properties

body?

optional body: Blob

headers?

optional headers: HeadersLike

method?

optional method: string

signal?

optional signal: AbortSignal

url?

optional url: string

---

ResponseInit

Extended by

• ResponseOpts

Properties

headers?

readonly optional headers: HeadersLike

status?

readonly optional status: number

statusText?

readonly optional statusText: string

---

ResponseOpts

Extends

• ResponseInit

Properties

headers?

readonly optional headers: HeadersLike

Inherited from

ResponseInit.headers

signal?

readonly optional signal: AbortSignal

status?

readonly optional status: number

Inherited from

ResponseInit.status

statusText?

readonly optional statusText: string

Inherited from

ResponseInit.statusText

url?

readonly optional url: string

Type Aliases

Body

Body = ArrayBufferView | Blob | null

The Body of a Response or Request. Currently NOT a ReadableStream.

---

HeadersLike

HeadersLike = Record<string, string> | Headers

---

HeadersOpts

HeadersOpts = string[][] | HeadersLike

---

RequestCache

RequestCache = "no-cache"

---

RequestMode

RequestMode = "navigate"

---

ResponseType

ResponseType = "basic" | "error"

Functions

fetch()

fetch(input: string | Request, init?: RequestOpts): Promise<Response>

Parameters

Parameter	Type
input	string | Request
init?	RequestOpts

Returns

Promise<Response>