Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RequestParameters

Container for request parameters

Hierarchy

  • RequestParameters

Index

Methods

Methods

body

  • Return request body when parsed. Forms are managed as

    Returns RequestParameter | null

cookieParameter

  • Get cookie parameter by name

    Parameters

    • name: string

    Returns RequestParameter | null

cookieParametersNames

  • cookieParametersNames(): string

  • Get list of all parameter names inside cookie

    Returns string

headerParameter

  • Get header parameter by name. This getter is case insensitive.

    Parameters

    • name: string

    Returns RequestParameter | null

headerParametersNames

  • headerParametersNames(): string

  • Get list of all parameter names inside header

    Returns string

pathParameter

  • Get path parameter by name

    Parameters

    • name: string

    Returns RequestParameter | null

pathParametersNames

  • pathParametersNames(): string

  • Get list of all parameter names inside path

    Returns string

queryParameter

  • Get query parameter by name

    Parameters

    • name: string

    Returns RequestParameter | null

queryParametersNames

  • queryParametersNames(): string

  • Get list of all parameter names inside query

    Returns string

toJson

  • toJson(): {}

  • This method converts RequestParameters in an unique JsonObject with 6 fields: cookie, path, query, header, form, body

    cookie, path, query, header, form are JsonObject where keys are param names and values are param values, while body depends on body's shape and may not exist

    Returns {}

    • [key: string]: any

Generated using TypeDoc