[I] QueryParameterOptions
Query parameter options after resolving the name and defaulting explode to false.
Extends
Section titled “Extends”Required<QueryOptions>
Properties
Section titled “Properties”| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
explode | readonly | boolean | If true send each value in the array/object as a separate query parameter. Equivalent of adding * in the path parameter as per RFC-6570 | Style | Explode | Uri Template | Primitive value id = 5 | Array id = [3, 4, 5] | Object id = {“role”: “admin”, “firstName”: “Alex”} | | ------ | ------- | -------------- | ---------------------- | ----------------------- | -------------------------------------------------- | | simple | false | /users{?id} | /users?id=5 | /users?id=3,4,5 | /users?id=role,admin,firstName,Alex | | simple | true | /users{?id*} | /users?id=5 | /users?id=3&id=4&id=5 | /users?role=admin&firstName=Alex | | Required.explode |
name | readonly | string | Name of the query when included in the url. | Required.name |
type | public | "query" | Identifies a value carried in the URI query. | - |