URLSearchParams

Experimental Class

Class Overview

class URLSearchParams {
  constructor(rawParams?: string, queryEncoder?: QueryEncoder)
  
  
  paramsMap : Map<string, string[]>
  rawParams : string
  clone() : URLSearchParams
  has(param: string) : boolean
  get(param: string) : string
  getAll(param: string) : string[]
  set(param: string, val: string)
  setAll(searchParams: URLSearchParams)
  append(param: string, val: string) : void
  appendAll(searchParams: URLSearchParams)
  replaceAll(searchParams: URLSearchParams)
  toString() : string
  delete(param: string) : void
}

Class Description

Map-like representation of url search parameters, based on URLSearchParams in the url living standard, with several extensions for merging URLSearchParams objects:

setAll()
appendAll()
replaceAll()

This class accepts an optional second parameter of $QueryEncoder, which is used to serialize parameters before making a request. By default, QueryEncoder encodes keys and values of parameters using encodeURIComponent, and then un-encodes certain characters that are allowed to be part of the query according to IETF RFC 3986: https://tools.ietf.org/html/rfc3986.

These are the characters that are not encoded: ! $ \' ( ) * + , ; A 9 - . _ ~ ? /

If the set of allowed query characters is not acceptable for a particular backend, QueryEncoder can be subclassed and provided as the 2nd argument to URLSearchParams.

import {URLSearchParams, QueryEncoder} from '@angular/http';
class MyQueryEncoder extends QueryEncoder {
  encodeKey(k: string): string {
    return myEncodingFunction(k);
  }

  encodeValue(v: string): string {
    return myEncodingFunction(v);
  }
}

let params = new URLSearchParams('', new MyQueryEncoder());

Constructor

constructor(rawParams?: string, queryEncoder?: QueryEncoder)

Class Details

paramsMap : Map<string, string[]>

rawParams : string

clone() : URLSearchParams

has(param: string) : boolean

get(param: string) : string

getAll(param: string) : string[]

set(param: string, val: string)

setAll(searchParams: URLSearchParams)

append(param: string, val: string) : void

appendAll(searchParams: URLSearchParams)

replaceAll(searchParams: URLSearchParams)

toString() : string

delete(param: string) : void

exported from @angular/http/index, defined in @angular/http/src/url_search_params.ts

Links:

https://angular.io/docs/ts/latest/api/http/index/URLSearchParams-class.html

doc_Angular

2016-10-06 09:47:10

Comments