@std/http@0.215.0

latest

Works with

•JSR Score70%•

Published2 years ago (0.215.0)

@std/http

default

Classes

ServerSentEventStream()

Transforms server-sent message objects into strings for the client.

UserAgent(ua: string | null)

A representation of user agent string, which can be used to determine environmental information represented by the string. All properties are determined lazily.

browser(): Browser
The name and version of the browser extracted from the user agent string.
cpu(): Cpu
The architecture of the CPU extracted from the user agent string.
device(): Device
The model, type, and vendor of a device if present in a user agent string.
engine(): Engine
The name and version of the browser engine in a user agent string.
os(): Os
The name and version of the operating system in a user agent string.
toJSON(): { browser: Browser; cpu: Cpu; device: Device; engine: Engine; os: Os; ua: string; }
Converts the current instance to a JSON representation.
toString(): string
Converts the current instance to a string.
ua(): string
A read only version of the user agent string related to the instance.

Server(serverInit: ServerInit)

Used to construct an HTTP server.

addrs(): Deno.Addr[]
Get the list of network addresses the server is listening on.
close(): void
Immediately close the server listeners and associated HTTP connections.
closed(): boolean
Get whether the server is closed.
listenAndServe(): Promise<void>
Create a listener on the server, accept incoming connections, and handle requests on these connections with the given handler.
listenAndServeTls(
certFile: string,
keyFile: string
): Promise<void>
Create a listener on the server, accept incoming connections, upgrade them to TLS, and handle requests on these connections with the given handler.
serve(listener: Deno.Listener): Promise<void>
Accept incoming connections on the given listener, and handle requests on these connections with the given handler.

Functions

accepts(

request: Request,

...types: string[]

): string | string[] | undefined

2 overloads

Returns an array of media types accepted by the request, in order of preference. If there are no media types supplied in the request, then any media type selector will be returned.

acceptsEncodings(

request: Request,

...encodings: string[]

): string | string[] | undefined

2 overloads

Returns an array of content encodings accepted by the request, in order of preference. If there are no encoding supplied in the request, then ["*"] is returned, implying any encoding is accepted.

acceptsLanguages(

request: Request,

...langs: string[]

): string | string[] | undefined

2 overloads

Returns an array of languages accepted by the request, in order of preference. If there are no languages supplied in the request, then ["*"] is returned, imply any language is accepted.

calculate(

entity: Entity,

options?: ETagOptions

): Promise<string | undefined>

Calculate an ETag for an entity. When the entity is a specific set of data it will be fingerprinted as a "strong" tag, otherwise if it is just file information, it will be calculated as a weak tag.

deleteCookie(

headers: Headers,

name: string,

attributes?: { path?: string; domain?: string; }

): void

Set the cookie header with empty value in the headers to delete it

getCookies(headers: Headers): Record<string, string>

Parse cookies of a header

getSetCookies(headers: Headers): Cookie[]

Parse set-cookies of a header

ifMatch(

value: string | null,

etag: string | undefined

): boolean

A helper function that takes the value from the If-Match header and a calculated etag for the target. By using strong comparison, return true if the values match, otherwise false.

ifNoneMatch(

value: string | null,

etag: string | undefined

): boolean

A helper function that takes the value from the If-None-Match header and a calculated etag for the target entity and returns false if the etag for the entity matches the supplied value, otherwise true.

isClientErrorStatus(status: number): status is ClientErrorStatus

A type guard that determines if the status code is a client error.

isErrorStatus(status: number): status is ErrorStatus

A type guard that determines if the status code is an error.

isInformationalStatus(status: number): status is InformationalStatus

A type guard that determines if the status code is informational.

isRedirectStatus(status: number): status is RedirectStatus

A type guard that determines if the status code is a redirection.

isServerErrorStatus(status: number): status is ServerErrorStatus

A type guard that determines if the status code is a server error.

isStatus(status: number): status is StatusCode

Returns whether the provided number is a valid HTTP status code.

isSuccessfulStatus(status: number): status is SuccessfulStatus

A type guard that determines if the status code is successful.

parseSignedCookie(signedCookie: string): string

Parses a signed cookie to get its value.

serveDir(

req: Request,

opts?: ServeDirOptions

): Promise<Response>

Serves the files under the given directory root (opts.fsRoot).

serveFile(

req: Request,

filePath: string,

unnamed 2?: ServeFileOptions

): Promise<Response>

Returns an HTTP Response with the requested file as the body.

setCookie(

headers: Headers,

cookie: Cookie

): void

Set the cookie header properly in the headers

signCookie(

value: string,

key: CryptoKey

): Promise<string>

Returns a promise with the signed cookie value from the given cryptographic key.

verifyCookie(

signedCookie: string,

key: CryptoKey

): Promise<boolean>

Returns a promise of a boolean indicating whether the signed cookie is valid.

serve(

handler: Handler,

options?: ServeInit

): Promise<void>

Serves HTTP requests with the given handler.

serveListener(

listener: Deno.Listener,

handler: Handler,

options?: ServeListenerOptions

): Promise<void>

Constructs a server, accepts incoming connections on the given listener, and handles requests on these connections with the given handler.

serveTls(

handler: Handler,

options: ServeTlsInit

): Promise<void>

Serves HTTPS requests with the given handler.

Interfaces

Browser

The browser as described by a user agent string.

major: string | undefined
The major version of a browser.
name: string | undefined
The name of a browser.
version: string | undefined
The version of a browser.

Represents an HTTP Cookie.

domain: string
The cookie's Domain attribute. Specifies those hosts to which the cookie will be sent.
expires: Date | number
The cookie's Expires attribute, either as an explicit date or UTC milliseconds.
httpOnly: boolean
The cookie's HTTPOnly attribute. If true, the cookie cannot be accessed via JavaScript.
maxAge: number
The cookie's Max-Age attribute, in seconds. Must be a non-negative integer. A cookie with a maxAge of 0 expires immediately.
name: string
Name of the cookie.
path: string
The cookie's Path attribute. A cookie with a path will only be included in the Cookie request header if the requested URL matches that path.
sameSite: "Strict" | "Lax" | "None"
Allows servers to assert that a cookie ought not to be sent along with cross-site requests.
secure: boolean
The cookie's Secure attribute. If true, the cookie will only be included in the Cookie request header if the connection uses SSL and HTTPS.
unparsed: string[]
Additional key value pairs with the form "key=value"
value: string
Value of the cookie.

Cpu

The CPU information as described by a user agent string.

architecture: string | undefined
The CPU architecture.

Device

The device as described by a user agent string.

model: string | undefined
The model of the device.
type:
"console"
| "mobile"
| "table"
| "smartv"
| "wearable"
| "embedded"
| undefined
The type of device.
vendor: string | undefined
The vendor of the device.

Engine

The browser engine as described by a user agent string.

name: string | undefined
The browser engine name.
version: string | undefined
The browser engine version.

ETagOptions

Options for calculate.

algorithm: AlgorithmIdentifier
A digest algorithm to use to calculate the etag.
weak: boolean
Override the default behavior of calculating the ETag, either forcing a tag to be labelled weak or not.

FileInfo

Just the part of Deno.FileInfo that is required to calculate an ETag, so partial or user generated file information can be passed.

mtime: Date | null
The last modification time of the file. This corresponds to the mtime field from stat on Linux/Mac OS and ftLastWriteTime on Windows. This may not be available on all platforms.
size: number
The size of the file, in bytes.

The OS as described by a user agent string.

name: string | undefined
The OS name.
version: string | undefined
The OS version.

ServeDirOptions

Interface for serveDir options.

enableCors: boolean
Enable CORS via the "Access-Control-Allow-Origin" header.
etagAlgorithm: AlgorithmIdentifier
The algorithm to use for generating the ETag.
fsRoot: string
Serves the files under the given directory root. Defaults to your current directory.
headers: string[]
Headers to add to each response
quiet: boolean
Do not print request level logs. Defaults to false.
showDirListing: boolean
Enable directory listing.
showDotfiles: boolean
Serves dotfiles.
showIndex: boolean
Serves index.html as the index file of the directory.
urlRoot: string
Specified that part is stripped from the beginning of the requested pathname.

ServeFileOptions

Interface for serveFile options.

etagAlgorithm: AlgorithmIdentifier
The algorithm to use for generating the ETag.
fileInfo: Deno.FileInfo
An optional FileInfo object returned by Deno.stat. It is used for optimization purposes.

ServerSentEventMessage

Represents a message in the Server-Sent Event (SSE) protocol.

comment: string
Ignored by the client.
data: string
The data field for the message. Split by new lines.
event: string
A string identifying the type of event described.
id: string | number
The event ID to set the EventSource object's last event ID value.
retry: number
The reconnection time.

ConnInfo

Information about the connection a request arrived on.

localAddr: Deno.Addr
The local address of the connection.
remoteAddr: Deno.Addr
The remote address of the connection.

ServeInit

Additional serve options.

onError: (error: unknown) => Response | Promise<Response>
The handler to invoke when route handlers throw an error.
onListen: (params: { hostname: string; port: number; }) => void
The callback which is called when the server started listening
signal: AbortSignal
An AbortSignal to close the server and all connections.

ServeListenerOptions

Additional serve listener options.

onError: (error: unknown) => Response | Promise<Response>
The handler to invoke when route handlers throw an error.
onListen: (params: { hostname: string; port: number; }) => void
The callback which is called when the server started listening
signal: AbortSignal
An AbortSignal to close the server and all connections.

ServerInit

Options for running an HTTP server.

handler: Handler
The handler to invoke for individual HTTP requests.
onError: (error: unknown) => Response | Promise<Response>
The handler to invoke when route handlers throw an error.

ServeTlsInit

Initialization parameters for serveTls.

cert: string
Cert chain in PEM format
certFile: string
The path to the file containing the TLS certificate
key: string
Server private key in PEM format
keyFile: string
The path to the file containing the TLS private key.

Type Aliases

ClientErrorStatus =

An HTTP status that is a client error (4XX).

Entity = string | Uint8Array | FileInfo

Represents an entity that can be used for generating an ETag.

ErrorStatus = ClientErrorStatus | ServerErrorStatus

An HTTP status that is an error (4XX and 5XX).

InformationalStatus =

STATUS_CODE.Continue
| STATUS_CODE.SwitchingProtocols
| STATUS_CODE.Processing
| STATUS_CODE.EarlyHints

An HTTP status that is a informational (1XX).

RedirectStatus =

An HTTP status that is a redirect (3XX).

Request = { headers: { get(key: string): string | null; }; }

Loose copy of Request.

headers: { get(key: string): string | null; }
No documentation available

ServerErrorStatus =

An HTTP status that is a server error (5XX).

StatusCode = STATUS_CODE[keyof STATUS_CODE]

An HTTP status code.

StatusText = STATUS_TEXT[keyof STATUS_TEXT]

An HTTP status text.

SuccessfulStatus =

An HTTP status that is a success (2XX).

Handler = (

request: Request,

connInfo: ConnInfo

) => Response | Promise<Response>

A handler for HTTP requests. Consumes a request and connection information and returns a response.

Variables

STATUS_CODE: { Continue: number; SwitchingProtocols: number; Processing: number; EarlyHints: number; OK: number; Created: number; Accepted: number; NonAuthoritativeInfo: number; NoContent: number; ResetContent: number; PartialContent: number; MultiStatus: number; AlreadyReported: number; IMUsed: number; MultipleChoices: number; MovedPermanently: number; Found: number; SeeOther: number; NotModified: number; UseProxy: number; TemporaryRedirect: number; PermanentRedirect: number; BadRequest: number; Unauthorized: number; PaymentRequired: number; Forbidden: number; NotFound: number; MethodNotAllowed: number; NotAcceptable: number; ProxyAuthRequired: number; RequestTimeout: number; Conflict: number; Gone: number; LengthRequired: number; PreconditionFailed: number; ContentTooLarge: number; URITooLong: number; UnsupportedMediaType: number; RangeNotSatisfiable: number; ExpectationFailed: number; Teapot: number; MisdirectedRequest: number; UnprocessableEntity: number; Locked: number; FailedDependency: number; TooEarly: number; UpgradeRequired: number; PreconditionRequired: number; TooManyRequests: number; RequestHeaderFieldsTooLarge: number; UnavailableForLegalReasons: number; InternalServerError: number; NotImplemented: number; BadGateway: number; ServiceUnavailable: number; GatewayTimeout: number; HTTPVersionNotSupported: number; VariantAlsoNegotiates: number; InsufficientStorage: number; LoopDetected: number; NotExtended: number; NetworkAuthenticationRequired: number; }

Contains the STATUS_CODE object which contains standard HTTP status codes and provides several type guards for handling status codes with type safety.

Accepted: number
No documentation available
AlreadyReported: number
No documentation available
BadGateway: number
No documentation available
BadRequest: number
No documentation available
Conflict: number
No documentation available
ContentTooLarge: number
No documentation available
Continue: number
No documentation available
Created: number
No documentation available
EarlyHints: number
No documentation available
ExpectationFailed: number
No documentation available
FailedDependency: number
No documentation available
Forbidden: number
No documentation available
Found: number
No documentation available
GatewayTimeout: number
No documentation available
Gone: number
No documentation available
HTTPVersionNotSupported: number
No documentation available
IMUsed: number
No documentation available
InsufficientStorage: number
No documentation available
InternalServerError: number
No documentation available
LengthRequired: number
No documentation available
Locked: number
No documentation available
LoopDetected: number
No documentation available
MethodNotAllowed: number
No documentation available
MisdirectedRequest: number
No documentation available
MovedPermanently: number
No documentation available
MultiStatus: number
No documentation available
MultipleChoices: number
No documentation available
NetworkAuthenticationRequired: number
No documentation available
NoContent: number
No documentation available
NonAuthoritativeInfo: number
No documentation available
NotAcceptable: number
No documentation available
NotExtended: number
No documentation available
NotFound: number
No documentation available
NotImplemented: number
No documentation available
NotModified: number
No documentation available
OK: number
No documentation available
PartialContent: number
No documentation available
PaymentRequired: number
No documentation available
PermanentRedirect: number
No documentation available
PreconditionFailed: number
No documentation available
PreconditionRequired: number
No documentation available
Processing: number
No documentation available
ProxyAuthRequired: number
No documentation available
RangeNotSatisfiable: number
No documentation available
RequestHeaderFieldsTooLarge: number
No documentation available
RequestTimeout: number
No documentation available
ResetContent: number
No documentation available
SeeOther: number
No documentation available
ServiceUnavailable: number
No documentation available
SwitchingProtocols: number
No documentation available
Teapot: number
No documentation available
TemporaryRedirect: number
No documentation available
TooEarly: number
No documentation available
TooManyRequests: number
No documentation available
URITooLong: number
No documentation available
Unauthorized: number
No documentation available
UnavailableForLegalReasons: number
No documentation available
UnprocessableEntity: number
No documentation available
UnsupportedMediaType: number
No documentation available
UpgradeRequired: number
No documentation available
UseProxy: number
No documentation available
VariantAlsoNegotiates: number
No documentation available

STATUS_TEXT: { [[STATUS_CODE.Accepted]]: string; [[STATUS_CODE.AlreadyReported]]: string; [[STATUS_CODE.BadGateway]]: string; [[STATUS_CODE.BadRequest]]: string; [[STATUS_CODE.Conflict]]: string; [[STATUS_CODE.Continue]]: string; [[STATUS_CODE.Created]]: string; [[STATUS_CODE.EarlyHints]]: string; [[STATUS_CODE.ExpectationFailed]]: string; [[STATUS_CODE.FailedDependency]]: string; [[STATUS_CODE.Forbidden]]: string; [[STATUS_CODE.Found]]: string; [[STATUS_CODE.GatewayTimeout]]: string; [[STATUS_CODE.Gone]]: string; [[STATUS_CODE.HTTPVersionNotSupported]]: string; [[STATUS_CODE.IMUsed]]: string; [[STATUS_CODE.InsufficientStorage]]: string; [[STATUS_CODE.InternalServerError]]: string; [[STATUS_CODE.LengthRequired]]: string; [[STATUS_CODE.Locked]]: string; [[STATUS_CODE.LoopDetected]]: string; [[STATUS_CODE.MethodNotAllowed]]: string; [[STATUS_CODE.MisdirectedRequest]]: string; [[STATUS_CODE.MovedPermanently]]: string; [[STATUS_CODE.MultiStatus]]: string; [[STATUS_CODE.MultipleChoices]]: string; [[STATUS_CODE.NetworkAuthenticationRequired]]: string; [[STATUS_CODE.NoContent]]: string; [[STATUS_CODE.NonAuthoritativeInfo]]: string; [[STATUS_CODE.NotAcceptable]]: string; [[STATUS_CODE.NotExtended]]: string; [[STATUS_CODE.NotFound]]: string; [[STATUS_CODE.NotImplemented]]: string; [[STATUS_CODE.NotModified]]: string; [[STATUS_CODE.OK]]: string; [[STATUS_CODE.PartialContent]]: string; [[STATUS_CODE.PaymentRequired]]: string; [[STATUS_CODE.PermanentRedirect]]: string; [[STATUS_CODE.PreconditionFailed]]: string; [[STATUS_CODE.PreconditionRequired]]: string; [[STATUS_CODE.Processing]]: string; [[STATUS_CODE.ProxyAuthRequired]]: string; [[STATUS_CODE.ContentTooLarge]]: string; [[STATUS_CODE.RequestHeaderFieldsTooLarge]]: string; [[STATUS_CODE.RequestTimeout]]: string; [[STATUS_CODE.URITooLong]]: string; [[STATUS_CODE.RangeNotSatisfiable]]: string; [[STATUS_CODE.ResetContent]]: string; [[STATUS_CODE.SeeOther]]: string; [[STATUS_CODE.ServiceUnavailable]]: string; [[STATUS_CODE.SwitchingProtocols]]: string; [[STATUS_CODE.Teapot]]: string; [[STATUS_CODE.TemporaryRedirect]]: string; [[STATUS_CODE.TooEarly]]: string; [[STATUS_CODE.TooManyRequests]]: string; [[STATUS_CODE.Unauthorized]]: string; [[STATUS_CODE.UnavailableForLegalReasons]]: string; [[STATUS_CODE.UnprocessableEntity]]: string; [[STATUS_CODE.UnsupportedMediaType]]: string; [[STATUS_CODE.UpgradeRequired]]: string; [[STATUS_CODE.UseProxy]]: string; [[STATUS_CODE.VariantAlsoNegotiates]]: string; }

A record of all the status codes text.