@vueuse/metadata 11.0.0-beta.1 → 11.0.0-beta.3

package/index.cjs

@@ -196,7 +196,7 @@ var functions$1 = [
 	{
 		name: "computedWithControl",
 		"package": "shared",
-		lastUpdated: 1708417312000,
+		lastUpdated: 1723558604000,
 		docs: "https://vueuse.org/shared/computedWithControl/",
 		category: "Reactivity",
 		description: "explicitly define the dependencies of computed",
@@ -210,7 +210,7 @@ var functions$1 = [
 	{
 		name: "createEventHook",
 		"package": "shared",
-		lastUpdated: 1701689283000,
+		lastUpdated: 1723593622000,
 		docs: "https://vueuse.org/shared/createEventHook/",
 		category: "Utilities",
 		description: "utility for creating event hooks"
@@ -294,7 +294,7 @@ var functions$1 = [
 	{
 		name: "createTemplatePromise",
 		"package": "core",
-		lastUpdated: 1708417312000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/createTemplatePromise/",
 		category: "Component",
 		description: "template as Promise"
@@ -345,7 +345,7 @@ var functions$1 = [
 	{
 		name: "isDefined",
 		"package": "shared",
-		lastUpdated: 1682985671000,
+		lastUpdated: 1723558260000,
 		docs: "https://vueuse.org/shared/isDefined/",
 		category: "Utilities",
 		description: "non-nullish checking type guard for Ref"
@@ -435,7 +435,7 @@ var functions$1 = [
 	{
 		name: "onStartTyping",
 		"package": "core",
-		lastUpdated: 1701749721000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/onStartTyping/",
 		category: "Sensors",
 		description: "fires when users start typing on non-editable elements"
@@ -568,7 +568,7 @@ var functions$1 = [
 	{
 		name: "syncRef",
 		"package": "shared",
-		lastUpdated: 1703684940000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/shared/syncRef/",
 		category: "Reactivity",
 		description: "two-way refs synchronization",
@@ -631,7 +631,7 @@ var functions$1 = [
 		lastUpdated: 1690722634000,
 		docs: "https://vueuse.org/shared/toRefs/",
 		category: "Reactivity",
-		description: "extended [`toRefs`](https://v3.vuejs.org/api/refs-api.html#torefs) that also accepts refs of an object"
+		description: "extended [`toRefs`](https://vuejs.org/api/reactivity-utilities.html#torefs) that also accepts refs of an object"
 	},
 	{
 		name: "toValue",
@@ -698,7 +698,7 @@ var functions$1 = [
 	{
 		name: "until",
 		"package": "shared",
-		lastUpdated: 1708417312000,
+		lastUpdated: 1721223747000,
 		docs: "https://vueuse.org/shared/until/",
 		category: "Watch",
 		description: "promised one-time watch for changes"
@@ -723,7 +723,7 @@ var functions$1 = [
 	{
 		name: "useAnimate",
 		"package": "core",
-		lastUpdated: 1716810590000,
+		lastUpdated: 1721222590000,
 		docs: "https://vueuse.org/core/useAnimate/",
 		category: "Animation",
 		description: "reactive [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API)"
@@ -827,7 +827,7 @@ var functions$1 = [
 	{
 		name: "useAsyncQueue",
 		"package": "core",
-		lastUpdated: 1692963122000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/useAsyncQueue/",
 		category: "Utilities",
 		description: "executes each asynchronous task sequentially and passes the current task result to the next task"
@@ -945,7 +945,7 @@ var functions$1 = [
 	{
 		name: "useChangeCase",
 		"package": "integrations",
-		lastUpdated: 1718193380000,
+		lastUpdated: 1723558442000,
 		docs: "https://vueuse.org/integrations/useChangeCase/",
 		category: "@Integrations",
 		description: "reactive wrapper for [`change-case`](https://github.com/blakeembrey/change-case)",
@@ -993,7 +993,7 @@ var functions$1 = [
 	{
 		name: "useColorMode",
 		"package": "core",
-		lastUpdated: 1695461887000,
+		lastUpdated: 1721224504000,
 		component: true,
 		docs: "https://vueuse.org/core/useColorMode/",
 		category: "Browser",
@@ -1015,7 +1015,7 @@ var functions$1 = [
 	{
 		name: "useCookies",
 		"package": "integrations",
-		lastUpdated: 1718191421000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/integrations/useCookies/",
 		category: "@Integrations",
 		description: "wrapper for [`universal-cookie`](https://www.npmjs.com/package/universal-cookie)",
@@ -1024,7 +1024,7 @@ var functions$1 = [
 	{
 		name: "useCounter",
 		"package": "shared",
-		lastUpdated: 1708423133000,
+		lastUpdated: 1723131573000,
 		docs: "https://vueuse.org/shared/useCounter/",
 		category: "Utilities",
 		description: "basic counter with utility functions"
@@ -1032,7 +1032,7 @@ var functions$1 = [
 	{
 		name: "useCssVar",
 		"package": "core",
-		lastUpdated: 1686084007000,
+		lastUpdated: 1721220944000,
 		docs: "https://vueuse.org/core/useCssVar/",
 		category: "Browser",
 		description: "manipulate CSS variables"
@@ -1070,7 +1070,7 @@ var functions$1 = [
 	{
 		name: "useDateFormat",
 		"package": "shared",
-		lastUpdated: 1716807174000,
+		lastUpdated: 1721222844000,
 		docs: "https://vueuse.org/shared/useDateFormat/",
 		category: "Time",
 		description: "get the formatted date according to the string of tokens passed in"
@@ -1140,7 +1140,7 @@ var functions$1 = [
 	{
 		name: "useDisplayMedia",
 		"package": "core",
-		lastUpdated: 1716812994000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/useDisplayMedia/",
 		category: "Sensors",
 		description: "reactive [`mediaDevices.getDisplayMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia) streaming",
@@ -1160,7 +1160,7 @@ var functions$1 = [
 	{
 		name: "useDraggable",
 		"package": "core",
-		lastUpdated: 1709818926000,
+		lastUpdated: 1721221710000,
 		component: true,
 		docs: "https://vueuse.org/core/useDraggable/",
 		category: "Elements",
@@ -1178,7 +1178,7 @@ var functions$1 = [
 	{
 		name: "useDropZone",
 		"package": "core",
-		lastUpdated: 1703685084000,
+		lastUpdated: 1723131573000,
 		docs: "https://vueuse.org/core/useDropZone/",
 		category: "Elements",
 		description: "create a zone where files can be dropped"
@@ -1186,7 +1186,7 @@ var functions$1 = [
 	{
 		name: "useElementBounding",
 		"package": "core",
-		lastUpdated: 1703686198000,
+		lastUpdated: 1721224957000,
 		component: true,
 		docs: "https://vueuse.org/core/useElementBounding/",
 		category: "Elements",
@@ -1224,14 +1224,14 @@ var functions$1 = [
 		category: "@Motion",
 		name: "useElementStyle",
 		description: "sync a reactive object to a target element CSS styling",
-		external: "https://motion.vueuse.org/api/use-element-style.html"
+		external: "https://motion.vueuse.org/api/use-element-style"
 	},
 	{
 		"package": "motion",
 		category: "@Motion",
 		name: "useElementTransform",
 		description: "sync a reactive object to a target element CSS transform.",
-		external: "https://motion.vueuse.org/api/use-element-transform.html"
+		external: "https://motion.vueuse.org/api/use-element-transform"
 	},
 	{
 		name: "useElementVisibility",
@@ -1246,7 +1246,7 @@ var functions$1 = [
 	{
 		name: "useEventBus",
 		"package": "core",
-		lastUpdated: 1695461887000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/useEventBus/",
 		category: "Utilities",
 		description: "a basic event bus"
@@ -1254,7 +1254,7 @@ var functions$1 = [
 	{
 		name: "useEventListener",
 		"package": "core",
-		lastUpdated: 1708417312000,
+		lastUpdated: 1721221795000,
 		docs: "https://vueuse.org/core/useEventListener/",
 		category: "Browser",
 		description: "use EventListener with ease"
@@ -1262,7 +1262,7 @@ var functions$1 = [
 	{
 		name: "useEventSource",
 		"package": "core",
-		lastUpdated: 1716810208000,
+		lastUpdated: 1723131573000,
 		docs: "https://vueuse.org/core/useEventSource/",
 		category: "Network",
 		description: "an [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) or [Server-Sent-Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) instance opens a persistent connection to an HTTP server"
@@ -1344,7 +1344,7 @@ var functions$1 = [
 	{
 		name: "useFocusTrap",
 		"package": "integrations",
-		lastUpdated: 1695461887000,
+		lastUpdated: 1721222387000,
 		component: true,
 		docs: "https://vueuse.org/integrations/useFocusTrap/",
 		category: "@Integrations",
@@ -1439,7 +1439,7 @@ var functions$1 = [
 	{
 		name: "useInfiniteScroll",
 		"package": "core",
-		lastUpdated: 1701688535000,
+		lastUpdated: 1721222904000,
 		directive: true,
 		docs: "https://vueuse.org/core/useInfiniteScroll/",
 		category: "Sensors",
@@ -1448,7 +1448,7 @@ var functions$1 = [
 	{
 		name: "useIntersectionObserver",
 		"package": "core",
-		lastUpdated: 1681481790000,
+		lastUpdated: 1721221539000,
 		directive: true,
 		docs: "https://vueuse.org/core/useIntersectionObserver/",
 		category: "Elements",
@@ -1568,7 +1568,7 @@ var functions$1 = [
 	{
 		name: "useMediaControls",
 		"package": "core",
-		lastUpdated: 1716812972000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/useMediaControls/",
 		category: "Browser",
 		description: "reactive media controls for both `audio` and `video` elements"
@@ -1610,21 +1610,21 @@ var functions$1 = [
 		category: "@Motion",
 		name: "useMotion",
 		description: "putting your components in motion.",
-		external: "https://motion.vueuse.org/api/use-motion.html"
+		external: "https://motion.vueuse.org/api/use-motion"
 	},
 	{
 		"package": "motion",
 		category: "@Motion",
 		name: "useMotionProperties",
 		description: "access Motion Properties for a target element.",
-		external: "https://motion.vueuse.org/api/use-motion-properties.html"
+		external: "https://motion.vueuse.org/api/use-motion-properties"
 	},
 	{
 		"package": "motion",
 		category: "@Motion",
 		name: "useMotionVariants",
 		description: "handle the Variants state and selection.",
-		external: "https://motion.vueuse.org/api/use-motion-variants.html"
+		external: "https://motion.vueuse.org/api/use-motion-variants"
 	},
 	{
 		name: "useMounted",
@@ -1646,7 +1646,7 @@ var functions$1 = [
 	{
 		name: "useMouseInElement",
 		"package": "core",
-		lastUpdated: 1701749721000,
+		lastUpdated: 1721220667000,
 		component: true,
 		docs: "https://vueuse.org/core/useMouseInElement/",
 		category: "Elements",
@@ -1775,7 +1775,7 @@ var functions$1 = [
 	{
 		name: "usePermission",
 		"package": "core",
-		lastUpdated: 1657430593000,
+		lastUpdated: 1721221053000,
 		docs: "https://vueuse.org/core/usePermission/",
 		category: "Browser",
 		description: "reactive [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API)",
@@ -1919,7 +1919,8 @@ var functions$1 = [
 	{
 		name: "useResizeObserver",
 		"package": "core",
-		lastUpdated: 1708421922000,
+		lastUpdated: 1721221028000,
+		directive: true,
 		docs: "https://vueuse.org/core/useResizeObserver/",
 		category: "Elements",
 		description: "reports changes to the dimensions of an Element's content or the border-box"
@@ -1935,7 +1936,7 @@ var functions$1 = [
 	{
 		name: "useRouteHash",
 		"package": "router",
-		lastUpdated: 1690718020000,
+		lastUpdated: 1723558507000,
 		docs: "https://vueuse.org/router/useRouteHash/",
 		category: "@Router",
 		description: "shorthand for a reactive `route.hash`"
@@ -1943,7 +1944,7 @@ var functions$1 = [
 	{
 		name: "useRouteParams",
 		"package": "router",
-		lastUpdated: 1716812049000,
+		lastUpdated: 1723558507000,
 		docs: "https://vueuse.org/router/useRouteParams/",
 		category: "@Router",
 		description: "shorthand for a reactive `route.params`"
@@ -1951,7 +1952,7 @@ var functions$1 = [
 	{
 		name: "useRouteQuery",
 		"package": "router",
-		lastUpdated: 1708427433000,
+		lastUpdated: 1723558507000,
 		docs: "https://vueuse.org/router/useRouteQuery/",
 		category: "@Router",
 		description: "shorthand for a reactive `route.query`"
@@ -2009,7 +2010,7 @@ var functions$1 = [
 	{
 		name: "useScrollLock",
 		"package": "core",
-		lastUpdated: 1716812370000,
+		lastUpdated: 1721219567000,
 		directive: true,
 		docs: "https://vueuse.org/core/useScrollLock/",
 		category: "Sensors",
@@ -2037,7 +2038,7 @@ var functions$1 = [
 	{
 		name: "useSortable",
 		"package": "integrations",
-		lastUpdated: 1708417312000,
+		lastUpdated: 1723131573000,
 		component: true,
 		docs: "https://vueuse.org/integrations/useSortable/",
 		category: "@Integrations",
@@ -2062,7 +2063,7 @@ var functions$1 = [
 	{
 		name: "useSpeechRecognition",
 		"package": "core",
-		lastUpdated: 1716889635000,
+		lastUpdated: 1721221314000,
 		docs: "https://vueuse.org/core/useSpeechRecognition/",
 		category: "Sensors",
 		description: "reactive [SpeechRecognition](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition)"
@@ -2070,7 +2071,7 @@ var functions$1 = [
 	{
 		name: "useSpeechSynthesis",
 		"package": "core",
-		lastUpdated: 1695452523000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/useSpeechSynthesis/",
 		category: "Sensors",
 		description: "reactive [SpeechSynthesis](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis)"
@@ -2080,7 +2081,7 @@ var functions$1 = [
 		category: "@Motion",
 		name: "useSpring",
 		description: "spring animations.",
-		external: "https://motion.vueuse.org/api/use-spring.html"
+		external: "https://motion.vueuse.org/api/use-spring"
 	},
 	{
 		name: "useStepper",
@@ -2093,7 +2094,7 @@ var functions$1 = [
 	{
 		name: "useStorage",
 		"package": "core",
-		lastUpdated: 1708524637000,
+		lastUpdated: 1721221880000,
 		docs: "https://vueuse.org/core/useStorage/",
 		category: "State",
 		description: "create a reactive ref that can be used to access & modify [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) or [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)",
@@ -2151,7 +2152,7 @@ var functions$1 = [
 	{
 		name: "useSupported",
 		"package": "core",
-		lastUpdated: 1679995528000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/useSupported/",
 		category: "Utilities",
 		description: "sSR compatibility `isSupported`"
@@ -2167,7 +2168,7 @@ var functions$1 = [
 	{
 		name: "useTemplateRefsList",
 		"package": "core",
-		lastUpdated: 1708417312000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/useTemplateRefsList/",
 		category: "Component",
 		description: "shorthand for binding refs to template elements and components inside `v-for`"
@@ -2175,7 +2176,7 @@ var functions$1 = [
 	{
 		name: "useTextareaAutosize",
 		"package": "core",
-		lastUpdated: 1716812909000,
+		lastUpdated: 1721223315000,
 		docs: "https://vueuse.org/core/useTextareaAutosize/",
 		category: "Browser",
 		description: "automatically update the height of a textarea depending on the content"
@@ -2374,7 +2375,7 @@ var functions$1 = [
 	{
 		name: "useWakeLock",
 		"package": "core",
-		lastUpdated: 1680167214000,
+		lastUpdated: 1721220173000,
 		docs: "https://vueuse.org/core/useWakeLock/",
 		category: "Browser",
 		description: "reactive [Screen Wake Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API)"
@@ -2382,7 +2383,7 @@ var functions$1 = [
 	{
 		name: "useWebNotification",
 		"package": "core",
-		lastUpdated: 1716810149000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/useWebNotification/",
 		category: "Browser",
 		description: "reactive [Notification](https://developer.mozilla.org/en-US/docs/Web/API/notification)"
@@ -2390,7 +2391,7 @@ var functions$1 = [
 	{
 		name: "useWebSocket",
 		"package": "core",
-		lastUpdated: 1716811998000,
+		lastUpdated: 1721224344000,
 		docs: "https://vueuse.org/core/useWebSocket/",
 		category: "Network",
 		description: "reactive [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket) client"
@@ -2409,7 +2410,7 @@ var functions$1 = [
 	{
 		name: "useWebWorkerFn",
 		"package": "core",
-		lastUpdated: 1716811013000,
+		lastUpdated: 1721219567000,
 		docs: "https://vueuse.org/core/useWebWorkerFn/",
 		category: "Browser",
 		description: "run expensive functions without blocking the UI",
@@ -2437,7 +2438,7 @@ var functions$1 = [
 	{
 		name: "useWindowSize",
 		"package": "core",
-		lastUpdated: 1690225787000,
+		lastUpdated: 1721224323000,
 		component: true,
 		docs: "https://vueuse.org/core/useWindowSize/",
 		category: "Elements",
@@ -2495,7 +2496,7 @@ var functions$1 = [
 	{
 		name: "watchDeep",
 		"package": "shared",
-		lastUpdated: 1681929885000,
+		lastUpdated: 1721220395000,
 		docs: "https://vueuse.org/shared/watchDeep/",
 		category: "Watch",
 		description: "shorthand for watching value with `{deep: true}`"
@@ -2522,7 +2523,7 @@ var functions$1 = [
 	{
 		name: "watchImmediate",
 		"package": "shared",
-		lastUpdated: 1686083696000,
+		lastUpdated: 1721220395000,
 		docs: "https://vueuse.org/shared/watchImmediate/",
 		category: "Watch",
 		description: "shorthand for watching value with `{immediate: true}`"

package/index.d.cts

@@ -61,9 +61,9 @@ interface ContributorInfo {
 }
 
 declare const metadata: PackageIndexes;
-declare const functions: VueUseFunction[];
-declare const packages: Record<string, VueUsePackage>;
-declare const categories: string[];
+declare const functions: PackageIndexes["functions"];
+declare const packages: PackageIndexes["packages"];
+declare const categories: PackageIndexes["categories"];
 declare const functionNames: string[];
 declare const categoryNames: string[];
 declare const coreCategoryNames: string[];

package/index.d.mts

@@ -61,9 +61,9 @@ interface ContributorInfo {
 }
 
 declare const metadata: PackageIndexes;
-declare const functions: VueUseFunction[];
-declare const packages: Record<string, VueUsePackage>;
-declare const categories: string[];
+declare const functions: PackageIndexes["functions"];
+declare const packages: PackageIndexes["packages"];
+declare const categories: PackageIndexes["categories"];
 declare const functionNames: string[];
 declare const categoryNames: string[];
 declare const coreCategoryNames: string[];

package/index.d.ts

@@ -61,9 +61,9 @@ interface ContributorInfo {
 }
 
 declare const metadata: PackageIndexes;
-declare const functions: VueUseFunction[];
-declare const packages: Record<string, VueUsePackage>;
-declare const categories: string[];
+declare const functions: PackageIndexes["functions"];
+declare const packages: PackageIndexes["packages"];
+declare const categories: PackageIndexes["categories"];
 declare const functionNames: string[];
 declare const categoryNames: string[];
 declare const coreCategoryNames: string[];