A type that represents options for parsing the URL query component.
Members (5)
get · iOS 27.0+
parameters
TypeScript
get parameters(): (Array<string>) | null
Swift declaration
var parameters: [String]?
An array of parameter names to extract.
Use a value of `nil` to include all query items.
If you specify an array for `parameters`, the parser includes the query items in the result, in the specified order.
For example, setting `parameters` to `["id", "external"]` parses URL `http://example.com/a/b/c?external&id=123&type=abc` into `http://example.com/a/b/c?id=123&external`. Note in this example that the query separates items with the `&` character, and query items don't necessarily have a value (such as `external` in this example).
set · iOS 27.0+
parameters
TypeScript
set parameters(value: (Array<string>) | null)
Swift declaration
var parameters: [String]?
An array of parameter names to extract.
Use a value of `nil` to include all query items.
If you specify an array for `parameters`, the parser includes the query items in the result, in the specified order.
For example, setting `parameters` to `["id", "external"]` parses URL `http://example.com/a/b/c?external&id=123&type=abc` into `http://example.com/a/b/c?id=123&external`. Note in this example that the query separates items with the `&` character, and query items don't necessarily have a value (such as `external` in this example).
Creates a new query options configuration with default values.
The query options default behavior is as follows:
* Parsing includes the query.
* Parsing includes all parameters.
get · iOS 27.0+
excluded
TypeScript
get excluded(): boolean
Swift declaration
var excluded: Bool
A Boolean value that indicates whether to exclude the query component from URL parsing.
When this value is `true`, parsing ignores all other query options.
set · iOS 27.0+
excluded
TypeScript
set excluded(value: boolean)
Swift declaration
var excluded: Bool
A Boolean value that indicates whether to exclude the query component from URL parsing.
When this value is `true`, parsing ignores all other query options.
