Spec-Zone.ru › Angular 2

URLSearchParams

Experimental Class

Обзор класса

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
}

Описание класса

Представляет параметры поиска URL в виде объекта, основанного на URLSearchParams из спецификации URL, с несколькими расширениями для объединения объектов URLSearchParams:

  • setAll()
  • appendAll()
  • replaceAll()

Этот класс принимает необязательный второй параметр $QueryEncoder, который используется для сериализации параметров перед отправкой запроса. По умолчанию QueryEncoder кодирует ключи и значения параметров с помощью encodeURIComponent, а затем декодирует определённые символы, которые разрешены в запросе согласно RFC 3986: https://tools.ietf.org/html/rfc3986.

Эти символы не кодируются: ! $ \' ( ) * + , ; A 9 - . _ ~ ? /

Если набор разрешённых символов запроса не подходит для конкретного бэкенда, QueryEncoder можно расширить и использовать в качестве второго аргумента 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(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

экспортировано из @angular/http/index, определено в @angular/http/src/url_search_params.ts

© 2010–2017 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v2.angular.io/docs/ts/latest/api/http/index/URLSearchParams-class.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API