Options
All
  • Public
  • Public/Protected
  • All
Menu

QueryParser handles URI query parsing and transformation. Users define the source property name and optionally the target property name and a parsing function.

Type parameters

  • T: object

Hierarchy

  • QueryParser

Index

Constructors

Methods

Constructors

constructor

Methods

parse

  • parse(query: Queries, init: T): T
  • Checks that query contains each of the possible fields, then invokes the associated Parser and appends the result to a copy of init.

    throws

    ParseError If any of the query parsers throw.

    Parameters

    • query: Queries

      The URI query object to parse.

    • init: T

      The initial state of a mapped object before reducing with the map functions. Might be used to provide required parameters.

    Returns T

    A T with all available queries mapped from query.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc