Class WayRequest

Decorates the incoming Request with routing and parsing helpers.

app.post("/echo", async (ctx) => {
  const body = await ctx.req.parseBody();
  console.log(ctx.req.headers.get("content-type"));
  return ctx.res.json({ received: body });
});

Constructors

constructor

Properties

_bodyParseError _bodyParsed _bodyType _rawBody _rawText bodyParserDefaults bodyParserOverrides bodyValue localsStore originalRequest paramsStore parsedUrl

Accessors

body bodyParseError bodyType headers locals method original params path pathname query search url

Methods

applyBodyParserOverrides autoParseBody getBodyParserConfig isBodyParsed param parseBody rawBody rawText setBodyParseError setParsedBody tryParseJson tryParseText tryParseUrlencoded

Constructors

constructor

Properties

Private _bodyParseError

_bodyParseError: null | BodyParseErrorState = null

Private _bodyParsed

_bodyParsed: boolean = false

Private _bodyType

_bodyType: null | ParsedBodyType = null

Private _rawBody

_rawBody: null | Uint8Array = null

Private _rawText

_rawText: null | string = null

Private bodyParserDefaults

bodyParserDefaults: ResolvedBodyParserOptions

Private bodyParserOverrides

bodyParserOverrides: null | BodyParserOptions = null

Private bodyValue

bodyValue: any = null

Private Readonly localsStore

localsStore: Record<string, any> = {}

Private Readonly originalRequest

originalRequest: Request

Private paramsStore

paramsStore: Record<string, string> = {}

Private Readonly parsedUrl

parsedUrl: URL

Accessors

body

bodyParseError

  • get bodyParseError(): null | BodyParseErrorState

  • Returns null | BodyParseErrorState

bodyType

headers

locals

  • get locals(): Record<string, any>

  • Shared per-request state bag useful for communication between middleware.

    Returns Record<string, any>

method

original

params

  • get params(): Record<string, string>

  • Snapshot of current route params (mutable on purpose for express parity).

    Returns Record<string, string>

  • set params(value): void

  • Allows the router or middleware to replace params in one go.

    Parameters

    • value: Record<string, string>

    Returns void

path

  • get path(): string

  • Alias for pathname for those used to Express' req.path.

    Returns string

pathname

  • get pathname(): string

  • Path segment (no query string). Equivalent to new URL(req.url).pathname.

    Returns string

query

  • get query(): URLSearchParams

  • Live URLSearchParams view of the request query.

    Returns URLSearchParams

search

  • get search(): string

  • Raw query string portion (including leading ?).

    Returns string

url

Methods

applyBodyParserOverrides

autoParseBody

  • autoParseBody(config): Promise<void>

  • Parameters

    • config: ResolvedBodyParserOptions

    Returns Promise<void>

getBodyParserConfig

  • getBodyParserConfig(): ResolvedBodyParserOptions

  • Returns ResolvedBodyParserOptions

isBodyParsed

  • isBodyParsed(): boolean

  • True when a body parser (auto or manual) already produced a result.

    Returns boolean

param

  • param(key): undefined | string

  • Convenience helper mirroring Express' req.param(name) lookup.

    Parameters

    • key: string

    Returns undefined | string

parseBody

rawBody

  • rawBody(): Promise<Uint8Array>

  • Lazy-load the request body as bytes. Cached so multiple calls are cheap.

    Returns Promise<Uint8Array>

rawText

setBodyParseError

  • setBodyParseError(status, message): void

  • Parameters

    • status: number
    • message: string

    Returns void

setParsedBody

  • setParsedBody(value, type): void

  • Persist successful parsing state. Called by the individual parser helpers.

    Parameters

    • value: any
    • type: ParsedBodyType

    Returns void

tryParseJson

  • tryParseJson(options): Promise<boolean>

  • Parameters

    • options: Required<Required<JsonParserOptions>>

    Returns Promise<boolean>

tryParseText

  • tryParseText(options): Promise<boolean>

  • Parameters

    • options: Required<Required<TextParserOptions>>

    Returns Promise<boolean>

tryParseUrlencoded

  • tryParseUrlencoded(options): Promise<boolean>

  • Parameters

    • options: Required<Required<UrlencodedParserOptions>>

    Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

constructor_bodyParseError_bodyParsed_bodyType_rawBody_rawTextbodyParserDefaultsbodyParserOverridesbodyValuelocalsStoreoriginalRequestparamsStoreparsedUrlbodybodyParseErrorbodyTypeheaderslocalsmethodoriginalparamspathpathnamequerysearchurlapplyBodyParserOverridesautoParseBodygetBodyParserConfigisBodyParsedparamparseBodyrawBodyrawTextsetBodyParseErrorsetParsedBodytryParseJsontryParseTexttryParseUrlencoded