QueryHookBus @vuqs/core

Subscribes to and synchronously emits typed module signals.

Usage

import { defineQueryModule } from '@vuqs/core'

declare module '@vuqs/core' {
  interface QueryHooks {
    'my-lib:reset': () => void
  }
}

const withReset = defineQueryModule({
  states: (core) => {
    core.hooks.on('my-lib:reset', () => {
      core.query.transact({ mode: 'replace', values: {} })
    })

    return { api: { reset: () => core.hooks.emit('my-lib:reset') } }
  },
})

Type

interface QueryHookBus {
  on: <Event extends keyof QueryHooks>(event: Event, handler: QueryHooks[Event]) => () => void
  emit: <Event extends keyof QueryHooks>(event: Event, ...args: HookArgs<Event>) => void
}

HookArgs is an internal conditional alias extracting the arguments of a signal handler.

Methods

Method	Parameters	Return value
on(event, handler)	An augmented QueryHooks key and its handler.	Disposer that unsubscribes the handler.
emit(event, ...args)	A signal key and the arguments declared for it.	void. Invokes subscribed handlers synchronously.

Handlers are invoked synchronously in subscription order, which follows module installation order; returned promises are not awaited. Write handlers so the outcome does not depend on that order. A synchronous throw is logged and isolated from the emitter and other handlers. A subscription made through a module's core is released with that module, including one made after setup; calling the disposer earlier is safe and idempotent.

QueryHooks

interface QueryHooks {}

An open, initially empty interface. Augment @vuqs/core to declare signal keys and handler signatures. Module import declarations can add built-in signals.

Related guide

Signals.