Class Query

constructor

• new Query(
      query?:
          | string
          | Query
          | Record<string, string>
          | Record<string, ReturnParam>,
  ): Query

  Parameters

  • Optionalquery: string | Query | Record<string, string> | Record<string, ReturnParam>

  Returns Query

Optionaloriginal

params

clear

• clear(): void

  Clear the query string parameters.

  Returns void

delete

• delete(key: string): void

  Delete a value from the query string parameters.

  Parameters

  • key: string

  Returns void

get

• get<T>(key: string, defaultValue?: T): T

  Get a value from the query string parameters and optionally provide a default value if the key is not found.

  Type Parameters

  • T

  Parameters

  • key: string

    The key to get the value from.
  • OptionaldefaultValue: T

    The default value to return if the key is not found.

  Returns T

goto

• goto(path: string): void

  Parameters

  • path: string

  Returns void

set

• set(key: string, value: string): void

  Set a value in the query string parameters.

  Parameters

  • key: string
  • value: string

  Returns void

test

• test(inbound: Query): QueryEvaluationResult

  Parameters

  • inbound: Query

  Returns QueryEvaluationResult

toJSON

• toJSON(preserveOriginal?: boolean): { [k: string]: string }

  Convert the query string parameters to a JSON object given we may have parameter values that are not json serializable out of the box.

  Parameters

  • OptionalpreserveOriginal: boolean

  Returns { [k: string]: string }

toString

• toString(): string

  Convert the query string parameters to a string.

  Returns string