Skip to content

useNotivueInstance


ts
import { useNotivueInstance } from 'notivue'

Returns an object with three properties:

  • isRunning - A readonly ref that indicates whether the instance is running or not.
  • startInstance - A function that starts the instance.
  • stopInstance - A function that stops the instance.

Usage and Configuration

Interfaces

ts
declare function useNotivue(): NotivueInstance

export inteface NotivueInstance {
  isRunning: Readonly<Ref<boolean>>
  startInstance: () => void
  stopInstance: () => void
}