Module src/core/url/convert

Index

References

Functions

References

FromQueryStringOptions

Re-exports FromQueryStringOptions

ToQueryStringOptions

Re-exports ToQueryStringOptions

Functions

fromQueryString

fromQueryString(query: string, decode?: boolean): Dictionary
fromQueryString(query: string, opts: FromQueryStringOptions): Dictionary
fromQueryString(query: string, opts: { convert: false } & FromQueryStringOptions): Dictionary<string | null>

- Defined in src/core/url/convert.ts:169
Creates a dictionary from the specified querystring and returns it
example
```
// {a: 1}
fromQueryString('?a=1');
```
Parameters
- query: string
- Optional decode: boolean
Returns Dictionary
- Defined in src/core/url/convert.ts:183
Creates a dictionary from the specified querystring and returns it
example
```
// {a: [1, 2]}
fromQueryString('?a[]=1&a[]=2', {arraySyntax: true});
```
Parameters
- query: string
- opts: FromQueryStringOptions
  
  additional options
Returns Dictionary
- Defined in src/core/url/convert.ts:198
Creates a dictionary from the specified querystring and returns it. This overload doesn't convert key values from a string.
example
```
// {a: '1'}
fromQueryString('?a=1', {convert: false});
```
Parameters
- query: string
- opts: { convert: false } & FromQueryStringOptions
  
  additional options
Returns Dictionary<string | null>

toQueryString

toQueryString(data: unknown, encode?: boolean): string
toQueryString(data: unknown, opts: ToQueryStringOptions): string

- Defined in src/core/url/convert.ts:28
Creates a querystring from the specified data and returns it
example
```
// '?a=1'
toQueryString({a: 1});
```
Parameters
- data: unknown
- Optional encode: boolean
Returns string
- Defined in src/core/url/convert.ts:42
Creates a querystring from the specified data and returns it
example
```
// '?a[]=1&a[]=2'
toQueryString({a: [1, 2]}, {arraySyntax: true});
```
Parameters
- data: unknown
- opts: ToQueryStringOptions
  
  additional options
Returns string