docs: Add docstrings

Author: ntucker

packages/vue/.gitignore

@@ -1,6 +1,5 @@
 /lib
 /dist
-/ts3.4
 /index.d.ts
 node_modules
 .DS_Store

packages/vue/README.md

@@ -31,7 +31,7 @@ Schema driven. Zero updater functions.
 ## Installation
 
 ```bash
-npm install --save @data-client/vue @data-client/rest @data-client/test
+npm install --save @data-client/vue @data-client/rest
 ```
 
 For more details, see [the Installation docs page](https://dataclient.io/docs/getting-started/installation).

packages/vue/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-client/vue",
-  "version": "0.1.0",
+  "version": "0.3.1",
   "description": "Async State Management without the Management. REST, GraphQL, SSE, Websockets, Fetch",
   "homepage": "https://dataclient.io",
   "repository": {
@@ -68,13 +68,12 @@
   },
   "type": "module",
   "engines": {
-    "node": "^12.17 || ^13.7 || >=14"
+    "node": ">=14"
   },
   "files": [
     "src",
     "dist",
     "lib",
-    "ts3.4",
     "node.mjs",
     "LICENSE",
     "README.md",
@@ -87,7 +86,6 @@
     "build:js:browser": "BROWSERSLIST_ENV=legacy yarn g:rollup",
     "build:bundle": "yarn g:runs build:js:\\* && echo '{\"type\":\"commonjs\"}' > dist/package.json",
     "build:clean": "yarn g:clean index.d.ts",
-    "build:legacy-types": "yarn g:downtypes lib ts3.4",
     "build": "run build:lib && run build:bundle",
     "dev": "run build:lib -w",
     "prepare": "run build:lib",
@@ -102,11 +100,15 @@
   },
   "peerDependencies": {
     "@types/vue": "^3.0.0",
+    "@vue/test-utils": "^2.4.0",
     "vue": "^3.0.0"
   },
   "peerDependenciesMeta": {
     "@types/vue": {
       "optional": true
+    },
+    "@vue/test-utils": {
+      "optional": true
     }
   },
   "devDependencies": {

packages/vue/src/consumers/useCache.ts

@@ -17,7 +17,7 @@ import type {
 /**
  * Read an Endpoint's response if it is ready.
  *
- * `useCache` guarantees referential equality globally.
+ * `useCache` is globally memoized.
  * @see https://dataclient.io/docs/api/useCache
  */
 export default function useCache<

packages/vue/src/consumers/useFetch.ts

@@ -16,8 +16,6 @@ import type {
 
 /**
  * Fetch an Endpoint if it is not in cache or stale.
- * Non-suspense; returns the fetch Promise when a request is issued, otherwise undefined.
- * Mirrors React useFetch semantics.
  * @see https://dataclient.io/docs/api/useFetch
  */
 export default function useFetch<

packages/vue/src/consumers/useQuery.ts

@@ -9,11 +9,9 @@ import { useController, injectState } from '../context.js';
 import type { MaybeRefsOrGetters } from '../types.js';
 
 /**
- * Query the store (non-suspense).
+ * Query the store.
  *
- * Returns a readonly computed ref of the query result. The value is undefined when
- * the result is not found or invalid.
- * Mirrors React's useQuery semantics using Vue reactivity.
+ * `useQuery` results are globally memoized.
  * @see https://dataclient.io/docs/api/useQuery
  */
 export default function useQuery<S extends Queryable>(

packages/vue/src/consumers/useSuspense.ts

@@ -22,6 +22,14 @@ import type {
   MaybeRefsOrGettersNullable,
 } from '../types.js';
 
+/**
+ * Ensure an endpoint is available.
+ * Suspends until it is.
+ *
+ * @see https://dataclient.io/docs/api/useSuspense
+ * @throws {Promise} If data is not yet available.
+ * @throws {NetworkError} If fetch fails.
+ */
 export default function useSuspense<
   E extends EndpointInterface<
     FetchFunction,

packages/vue/src/providers/getDefaultManagers.ts

@@ -7,7 +7,10 @@ import {
 } from '@data-client/core';
 
 /* istanbul ignore next */
-/** Returns the default Managers used by DataProvider. */
+/** Returns the default Managers used by DataProvider.
+ *
+ * @see https://dataclient.io/docs/api/getDefaultManagers
+ */
 let getDefaultManagers: (options?: GetManagersOptions) => Manager[] = (
   options = {},
 ) => {

packages/vue/src/test/renderDataCompose.ts

@@ -9,8 +9,8 @@ import {
 
 /**
  * Renders a Vue composable with DataClient provider for testing
- * Similar to renderDataHook from @data-client/test but for Vue composables
  *
+ * @see https://dataclient.io/docs/api/renderDataCompose
  * @param composable - The composable function to test
  * @param options - Configuration including optional reactive props ref, fixtures, managers, etc.
  */

yarn.lock

@@ -3499,10 +3499,13 @@ __metadata:
     vue: "npm:^3.4.0"
   peerDependencies:
     "@types/vue": ^3.0.0
+    "@vue/test-utils": ^2.4.0
     vue: ^3.0.0
   peerDependenciesMeta:
     "@types/vue":
       optional: true
+    "@vue/test-utils":
+      optional: true
   languageName: unknown
   linkType: soft