Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Query

Simple Query abstraction.

It is a wrapper over the outdated and non-intuitive Node.js URLSearchParams.

Hierarchy

  • Query

Index

Constructors

constructor

  • new Query(str?: string): Query
  • Create empty Query or parse from a string.

    Parameters

    • Default value str: string = ""

      uri string to be parsed

    Returns Query

Methods

append

  • append(key: string, value: string): void
  • Append a new param to the query.

    The difference between set is that append doesn't override existing values associated with given key.

    const query = new Query();
    query.append('tag', 'value1');
    query.append('tag', 'value2');
    query.getValue('tag'); // 'value1,value2'

    Parameters

    • key: string

      key of the param

    • value: string

      value of the param

    Returns void

clear

  • clear(): void

delete

  • delete(key: string): void
  • Delete all values associated with given key

    Parameters

    • key: string

      key of the param

    Returns void

get

getAll

getValue

  • getValue(key: string): string
  • Get param values joined by a ',' filtered by key.

    const query = new Query();
    query.set('key1', 'value1');
    query.set('key1', 'value2');
    query.getValue('key1'); // 'value1,value2'

    Parameters

    • key: string

      key of the param

    Returns string

keys

  • keys(): string[]

set

  • set(key: string, value: string): void
  • Set a new param in the query.

    The difference between append is that set overrides existing values associated with given key.

    const query = new Query();
    query.set('tag', 'value1');
    query.set('tag', 'value2');
    query.getValue('tag'); // 'value2'

    Parameters

    • key: string

      key of the param

    • value: string

      value of the param

    Returns void

toString

  • toString(): string
  • Get urlEncoded query string

    const query = new Query();
    query.set('key1', 'value1');
    query.set('key>2', 'value>2');
    query.toString(); // '?key1=value1&key%3E2=value%3E2'

    Returns string

Static merge

  • Create new Query object from 2 queries.

    const q1 = new Query('k1=val1&k2=val2');
    const q2 = new Query('k3=val3&k1=val5');
    const query = Query.merge(q1, q2);
    query.toString(); // ?k1=val1&k2=val2&k3=val3&k1=val5'

    Parameters

    • query1: Query

      first query

    • query2: Query

      second query

    Returns Query

Generated using TypeDoc