Interface URLSearchParams

MDN Reference

interface URLSearchParams {
    new URLSearchParamsnew (init: string): any;
    size: number;
    append(name: string, value: string): void;
    append(key: string, value: string | number): void;
    delete(name: string, value?: string): void;
    delete(key: string): void;
    entries(): string[][];
    forEach(callbackfn: ((value: string, key: string, parent: URLSearchParams) => void), thisArg?: any): void;
    forEach(callback: ((value: string, key: string, urlSearchParams: URLSearchParams) => void)): void;
    get(name: string): null | string;
    get(key: string): null | string;
    getAll(name: string): string[];
    getAll(key: string): string;
    has(name: string, value?: string): boolean;
    has(key: string): boolean;
    keys(): string[];
    set(name: string, value: string): void;
    set(key: string, value: string | number): void;
    sort(): void;
    toString(): string;
    toString(): string;
    values(): string[];
}

Constructors

constructor

Properties

size

Methods

append delete entries forEach get getAll has keys set sort toString values

Constructors

constructor

  • new URLSearchParams(init): any

  • Parameters

    • init: string

    Returns any

Properties

Readonlysize

size: number

MDN Reference

Methods

append

  • append(name, value): void

  • Appends a specified key/value pair as a new search parameter.

    MDN Reference

    Parameters

    • name: string
    • value: string

    Returns void

  • append(key, value): void

  • 插入一个指定的键/值对作为新的搜索参数

    Parameters

    • key: string
    • value: string | number

    Returns void

delete

  • delete(name, value?): void

  • Deletes the given search parameter, and its associated value, from the list of all search parameters.

    MDN Reference

    Parameters

    • name: string
    • Optionalvalue: string

    Returns void

  • delete(key): void

  • 从搜索参数列表里删除指定的搜索参数及其对应的值

    Parameters

    • key: string

    Returns void

entries

  • entries(): string[][]

  • 返回一个 iterator 可以遍历所有键/值对的对象

    Returns string[][]

forEach

  • forEach(callbackfn, thisArg?): void

  • Parameters

    • callbackfn: ((value: string, key: string, parent: URLSearchParams) => void)
        • (value, key, parent): void

        • Parameters

          Returns void

    • OptionalthisArg: any

    Returns void

  • forEach(callback): void

  • 通过回调函数来遍历 URLSearchParams 实例对象上的键值对

    Parameters

    • callback: ((value: string, key: string, urlSearchParams: URLSearchParams) => void)
        • (value, key, urlSearchParams): void

        • Parameters

          Returns void

    Returns void

get

  • get(name): null | string

  • Returns the first value associated to the given search parameter.

    MDN Reference

    Parameters

    • name: string

    Returns null | string

  • get(key): null | string

  • 获取指定搜索参数的第一个值

    Parameters

    • key: string

    Returns null | string

getAll

  • getAll(name): string[]

  • Returns all the values association with a given search parameter.

    MDN Reference

    Parameters

    • name: string

    Returns string[]

  • getAll(key): string

  • 获取指定搜索参数的所有值，返回是一个数组

    Parameters

    • key: string

    Returns string

has

  • has(name, value?): boolean

  • Returns a Boolean indicating if such a search parameter exists.

    MDN Reference

    Parameters

    • name: string
    • Optionalvalue: string

    Returns boolean

  • has(key): boolean

  • 返回 Boolean 判断是否存在此搜索参数

    Parameters

    • key: string

    Returns boolean

keys

  • keys(): string[]

  • 返回 iterator 此对象包含了键/值对的所有键名

    Returns string[]

set

  • set(name, value): void

  • Sets the value associated to a given search parameter to the given value. If there were several values, delete the others.

    MDN Reference

    Parameters

    • name: string
    • value: string

    Returns void

  • set(key, value): void

  • 设置一个搜索参数的新值，假如原来有多个值将删除其他所有的值

    Parameters

    • key: string
    • value: string | number

    Returns void

sort

  • sort(): void

  • MDN Reference

    Returns void

toString

  • toString(): string

  • Returns a string containing a query string suitable for use in a URL. Does not include the question mark.

    Returns string

  • toString(): string

  • 返回搜索参数组成的字符串，可直接使用在 URL 上

    Returns string

values

  • values(): string[]

  • 返回 iterator 此对象包含了键/值对的所有值

    Returns string[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods