Class Values

It is typically used for query parameters and form values. the keys in a Values map are case-sensitive.

Hierarchy

Values

Index

Constructors

Properties

m

Accessors

Methods

_encode add addObject del encode get has object set setObject fromObject parse parseRaw

Constructors

constructor

new Values(m?: Map<string, string[]>): Values
Parameters
- Optional m: Map<string, string[]>
Returns Values
- Defined in src/net/url/url.ts:541

Properties

`Readonly` m

m: Map<string, string[]>

map listing

Accessors

length

get length(): number
return keys.length

Returns number
- Defined in src/net/url/url.ts:547

Methods

`Private` _encode

_encode(buf: string[], k: string, vs: string[]): void
Parameters
- buf: string[]
- k: string
- vs: string[]
Returns void
- Defined in src/net/url/url.ts:651

add

add(key: string, ...vals: string[]): void
adds the value to key. It appends to any existing values associated with key.
Parameters
- key: string
- Rest ...vals: string[]
Returns void
- Defined in src/net/url/url.ts:586

addObject

addObject(obj: ValuesObject): void
adds the value to key. It appends to any existing values associated with key.
Parameters
- obj: ValuesObject
Returns void
- Defined in src/net/url/url.ts:598

del

del(key: string): void
deletes the values associated with key.
Parameters
- key: string
Returns void
- Defined in src/net/url/url.ts:623

encode

encode(sortKey?: boolean | CompareCallback<string>): string
encodes the values into ``URL encoded'' form ("bar=baz&foo=quux") sorted by key.
Parameters
- Optional sortKey: boolean | CompareCallback<string>
Returns string
- Defined in src/net/url/url.ts:635

get

get(key: string): string
gets the first value associated with the given key. to access multiple values, use the map directly.
Parameters
- key: string
Returns string
- Defined in src/net/url/url.ts:555

has

has(key: string): boolean
checks whether a given key is set.
Parameters
- key: string
Returns boolean
- Defined in src/net/url/url.ts:629

object

object(): ValuesObject
convert Values to Object

Returns ValuesObject
- Defined in src/net/url/url.ts:613

set

set(key: string, ...vals: string[]): void
sets the key to vals. It replaces any existing
Parameters
- key: string
- Rest ...vals: string[]
Returns void
- Defined in src/net/url/url.ts:565

setObject

setObject(obj: ValuesObject): void
sets the key to vals. It replaces any existing
Parameters
- obj: ValuesObject
Returns void
- Defined in src/net/url/url.ts:571

`Static` fromObject

fromObject(obj: ValuesObject): Values
convert Object to Values
Parameters
- obj: ValuesObject
Returns Values
- Defined in src/net/url/url.ts:523

`Static` parse

parse(query: string): Values
parses the URL-encoded query string and returns a map listing the values specified for each key.

Returns
always returns a map containing all the valid query parameters found
Parameters
- query: string
Returns Values
- Defined in src/net/url/url.ts:508

`Static` parseRaw

parseRaw(query: string): [Values, Exception[]]
parses the URL-encoded query string and returns a map listing the values specified for each key.

Returns
always returns a map containing all the valid query parameters found
Parameters
- query: string
Returns [Values, Exception[]]
- Defined in src/net/url/url.ts:515

Generated using TypeDoc