vue-qs v0.1.18

---

vue-qs / QueryRefOptions

Type Alias: QueryRefOptions<T>

QueryRefOptions<T> = QueryParameterOptions<T> & object

Defined in: types.ts:105

Options for queryRef composable

Type declaration

historyStrategy?

optional historyStrategy: "replace" | "push"

History strategy when updating the URL ('replace' | 'push')

queryAdapter?

optional queryAdapter: QueryAdapter

Optional custom query adapter to use

Type Parameters

T

T

The type of the query parameter value

Example

const options: QueryRefOptions<number> = {
  defaultValue: 1,
  codec: numberCodec,
  historyStrategy: 'replace',
  shouldOmitDefault: true
};