API reference

Reference for every entry point. For usage guides, see the Guide and Modules sections.

Entry points

Entry point	Import	Purpose
`@vuqs/core`	`import { … } from '@vuqs/core'`	The core: codecs, composables, adapters, serializer.
`@vuqs/core/adapters/browser-history`	`import { … } from '@vuqs/core/adapters/browser-history'`	The browser History API adapter.
`@vuqs/core/adapters/vue-router`	`import { … } from '@vuqs/core/adapters/vue-router'`	The vue-router adapter.
`@vuqs/core/modules`	`import { … } from '@vuqs/core/modules'`	Composable modules applied with `.use()`.
`@vuqs/core/shared`	`import { … } from '@vuqs/core/shared'`	Helpers for writing your own module.
`@vuqs/core/adapters/testing`	`import { … } from '@vuqs/core/adapters/testing'`	The testing adapter and helpers.
`@vuqs/core/testing`	`import { … } from '@vuqs/core/testing'`	Codec bijectivity test helpers.
`@vuqs/core/debug`	`import '@vuqs/core/debug'`	Opt-in console debug rendering: `enableDebug`/`disableDebug`.
`@vuqs/core/debug/console`	`import { … } from '@vuqs/core/debug/console'`	Side-effect-free console/performance reporter factories for framework integrations.
`@vuqs/core/debug-protocol`	`import type { … } from '@vuqs/core/debug-protocol'`	Type-only, experimental event protocol for tooling (`DebugEventMap`), governed by `DEBUG_PROTOCOL_VERSION`.
`@vuqs/nuxt`	`modules: ['@vuqs/nuxt']`	The Nuxt module: auto-imports and an app-wide adapter.

Reference pages

Area	References
Composables	useQueryState, useQueryStates, toQueryRefs, toQueryRef
Params and schemas	queryParam, queryParam.object, defineQuerySchema, normalizeQueryStateSchema
Codecs	codecs, createCodec, codecs.arrayOf, codecs.literal, codecs.enum, codecs.json
Adapters	QueryAdapter, createVueRouterAdapter, provideVueRouterAdapter, createBrowserHistoryAdapter, provideBrowserHistoryAdapter, installQueryAdapter, provideQueryAdapter, useQueryAdapter
Modules	withRuntimeDefaults, withContext, withActiveParams, withStorage, createWebStorage
Module authoring	defineQueryModule, QueryCore, QueryModuleRegistry, QueryHookBus, QueryPipelineBus
Serialization	createSerializer, parseQueryStates, serializeQueryStates, buildQuery, dropDefaults, getManagedKeys, omitManagedKeys, assertUniquePaths
Utilities	getPath, setPath, deletePath, getQueryString, getQueryStringArray, structuralEq, pickBy, omitBy, definedOnly, toReadonlyState
Testing	createTestingAdapter, withVuqsTestingAdapter, isCodecBijective, testSerializeThenParse, testParseThenSerialize
Debugging	enableDebug, disableDebug, addDebugReporter, retainDebugHistory, getDebugChannel, getDebugSnapshot, isDebugArmed, createDebugLogger, createConsoleReporter, addConsoleDebugReporter, createPerformanceReporter, readStoredConsoleDebugConfig
Advanced	createQueryStateEngine
Shared types	Query types, debug events

Module walkthroughs remain in the Modules guides.

Full export list

`@vuqs/core`

Export
`useQueryState`
`useQueryStates`
`toQueryRef`
`toQueryRefs`
`installQueryAdapter`
`provideQueryAdapter`
`useQueryAdapter`
`codecs`
`createCodec`
`queryParam`
`defineQuerySchema`
`defineQueryModule`
`createSerializer`
`parseQueryStates`
`serializeQueryStates`
`buildQuery`
`dropDefaults`
`getManagedKeys`
`omitManagedKeys`
`normalizeQueryStateSchema`
`assertUniquePaths`
`getPath`
`setPath`
`deletePath`
`getQueryString`
`getQueryStringArray`
`structuralEq`
`createQueryStateEngine`
`addDebugReporter`
`retainDebugHistory`
`getDebugChannel`
`getDebugSnapshot`
`isDebugArmed`
`createDebugLogger`
`DEBUG_PROTOCOL_VERSION`
`Codec`
`CodecInput`
`CodecWithDefault`
`DefinedQueryParam`
`DefinedQueryParamWithDefault`
`AnyDefinedQueryParam`
`ParamContract`
`ExplicitValueOf`
`ResolvedValueOf`
`ContributionOf`
`GuaranteedOf`
`QueryParamReadContext`
`QueryParamBuilder`
`QueryParamBuilderWithDefault`
`QueryParamObjectBuilder`
`QueryParamObjectBuilderFor`
`ObjectExplicitValue`
`ObjectResolvedValue`
`ObjectContribution`
`PrefixedQueryParamBuilder`
`QueryParamTransform`
`QueryStateRef`
`UseQueryStateReturn`
`QueryComposable`
`QueryStatesValues`
`QueryStatesActions`
`UseQueryStatesOptions`
`UseQueryStatesReturn`
`QueryRef`
`ToQueryRefs`
`QueryBinding`
`QueryBindingSource`
`QueryStateSchema`
`QueryStateSchemaInput`
`NormalizeQueryStateSchema`
`QueryStateValues`
`QueryStateWriteValues`
`QueryStateResolvedValues`
`QueryStateContributions`
`QueryStateContributionAt`
`QueryStateRefInput`
`QueryStateValueOf`
`QueryStateValueAt`
`QueryStateRefValue`
`QueryCore`
`QueryStatesModule`
`DefinedQueryStateModule`
`QueryModuleFacade`
`QueryStatesFacadeModule`
`QueryStateFacadeModule`
`QueryFacadeModule`
`QueryRegisteredStatesModule`
`QueryRegisteredStateModule`
`QueryRegisteredDualModule`
`QueryModuleFactory`
`PlainQueryModuleFactory`
`QueryModuleProducers`
`QueryModuleResult`
`QueryDefaultSource`
`QueryModulePipelineDescriptor`
`QueryModuleRegistry`
`QueryModuleName`
`ModuleOptions`
`QueryModuleStatesContract`
`QueryModuleStateContract`
`QueryModuleStatesParam`
`QueryModuleStateParam`
`QueryModuleStatesSetup`
`QueryModuleStateSetup`
`QueryModuleStatesResult`
`QueryModuleStateResult`
`QueryModuleStatesApi`
`QueryModuleStateApi`
`VerifiedStatesProducer`
`VerifiedStateProducer`
`QueryHooks`
`QueryHookBus`
`QueryPipeline`
`QueryPipelineBus`
`QueryPipelineStage`
`QueryValues`
`Enforce`
`PipelineDescriptor`
`PipelinePath`
`ReadProjection`
`OrderedPipelineDescriptors`
`ApplyPipelineEffects`
`PipelineView`
`PipelineReadContext`
`PipelineWriteContext`
`PipelineWriteRequest`
`PipelinePresence`
`PipelineReadOptions`
`PipelineWriteOptions`
`QueryTransaction`
`QueryTransactionBus`
`QueryTransactionObserver`
`QueryTransactionDefaultPolicy`
`QueryTransactionOrigin`
`QueryTransactionRequest`
`QueryWriteOptions`
`QueryAdapter`
`QueryAdapterDefaultOptions`
`NavigateOptions`
`QueryStateNavigate`
`ParsedQuery`
`ParsedQueryRaw`
`ParsedQueryValue`
`Serializer`
`CreateSerializerOptions`
`SerializerStringify`
`SerializerParse`
`QueryStateEngine`
`QueryStateEngineOptions`
`QueryStateReads`
`QueryDefaultsBus`
`ResolvedQueryStateOptions`
`DebugEvent`
`DebugContext`
`DebugEmissionContext`
`DebugLevel`
`Reporter`
`DebugChannelHandle`
`AddReporterOptions`
`RetainHistoryOptions`
`DebugSnapshot`
`DebugSnapshotKind`
`DebugLogger`
`DebugLoggerOptions`

`@vuqs/core/debug`

Export
`enableDebug`
`disableDebug`
`addConsoleDebugReporter`
`createConsoleReporter`
`createPerformanceReporter`
`readStoredConsoleDebugConfig`
`VUQS_DEBUG_CONFIG_VERSION`
`VUQS_DEBUG_STORAGE_KEY`
`EnableDebugOptions`
`AddConsoleDebugReporterOptions`
`ConsoleReporterOptions`
`ConsoleDebugPreset`
`DebugEventFilter`
`DebugEventSelector`
`DebugPayloadMode`
`PerformanceDebugReporter`
`PerformanceReporterOptions`
`StoredDebugConfigV1`
`StoredConsoleDebugConfig`
`StoredConsoleDebugResolution`
`StoredConsoleReporterOptions`
`StoredDebugEventFilter`
`StoredDebugEventSelector`
`StoredDebugPayloadMode`

`@vuqs/core/debug/console`

Export
`addConsoleDebugReporter`
`createConsoleReporter`
`createPerformanceReporter`
`readStoredConsoleDebugConfig`
`VUQS_DEBUG_CONFIG_VERSION`
`VUQS_DEBUG_STORAGE_KEY`
`AddConsoleDebugReporterOptions`
`ConsoleReporterOptions`
`ConsoleDebugPreset`
`DebugEventFilter`
`DebugEventSelector`
`DebugPayloadMode`
`PerformanceDebugReporter`
`PerformanceReporterOptions`
`StoredDebugConfigV1`
`StoredConsoleDebugConfig`
`StoredConsoleDebugResolution`
`StoredConsoleReporterOptions`
`StoredDebugEventFilter`
`StoredDebugEventSelector`
`StoredDebugPayloadMode`

`@vuqs/core/debug-protocol`

Export
`DebugEventMap`
`DebugEventCode`
`DebugScope`
`LogDebugCode`
`WarnDebugCode`
`KnownDebugEvent`
`DebugSnapshot`
`DebugSnapshotByKind`
`DebugSnapshotKind`
`EngineSnapshot`
`QueueSnapshot`
`StorageSnapshot`

`@vuqs/core/adapters/vue-router`

Export
`createVueRouterAdapter`
`provideVueRouterAdapter`
`VueRouterAdapterOptions`

`@vuqs/core/adapters/browser-history`

Export
`createBrowserHistoryAdapter`
`provideBrowserHistoryAdapter`
`BrowserHistoryAdapter`
`BrowserHistoryAdapterOptions`

`@vuqs/core/modules`

Export
`createWebStorage`
`withActiveParams`
`withContext`
`withRuntimeDefaults`
`withStorage`
`ActiveParamsOptions`
`ActiveParamsStatesApi`
`ActiveParamsStateApi`
`ContextBaseOptions`
`ContextNavigate`
`ContextStatesApi`
`ContextStateApi`
`QueryStatesContextOptions`
`QueryStateContextOptions`
`RuntimeDefaultsStatesApi`
`RuntimeDefaultsStateApi`
`Awaitable`
`QueryStorage`
`StoredQuerySnapshot`
`StorageOptions`
`StorageRestorePolicy`
`StorageStatus`
`StorageControls`
`StorageApi`

`@vuqs/core/shared`

Export
`pickBy`
`omitBy`
`definedOnly`
`toReadonlyState`

`@vuqs/core/adapters/testing`

Export
`createTestingAdapter`
`withVuqsTestingAdapter`
`TestingAdapter`
`TestingAdapterOptions`
`UrlUpdateEvent`
`OnUrlUpdateFunction`

`@vuqs/core/testing`

Export
`isCodecBijective`
`testSerializeThenParse`
`testParseThenSerialize`

`@vuqs/nuxt`

Export
`AdapterOptions`
`AutoImportsOptions`
`DebugOptions`
`DebugTargetOption`
`ModuleOptions`

API reference ​

Entry points ​

Reference pages ​

Full export list ​

@vuqs/core ​

@vuqs/core/debug ​

@vuqs/core/debug/console ​

@vuqs/core/debug-protocol ​

@vuqs/core/adapters/vue-router ​

@vuqs/core/adapters/browser-history ​

@vuqs/core/modules ​

@vuqs/core/shared ​

@vuqs/core/adapters/testing ​

@vuqs/core/testing ​

@vuqs/nuxt ​

API reference

Entry points

Reference pages

Full export list

`@vuqs/core`

`@vuqs/core/debug`

`@vuqs/core/debug/console`

`@vuqs/core/debug-protocol`

`@vuqs/core/adapters/vue-router`

`@vuqs/core/adapters/browser-history`

`@vuqs/core/modules`

`@vuqs/core/shared`

`@vuqs/core/adapters/testing`

`@vuqs/core/testing`

`@vuqs/nuxt`