docs: Update typedoc

- add typedoc-plugin-vue
- add UseSelectReturn and UseCronReturn

Author: abichinger

core/src/components/cron-core.ts

@@ -229,11 +229,16 @@ export function useCron(options: CronOptions) {
   }
 }
 
+/**
+ * @interface
+ */
+export type UseCronReturn = ReturnType<typeof useCron>
+
 export function setupCron(
   options: CronOptions,
   modelValue: WatchSource<string | undefined>,
   { emit }: SetupContext<['update:model-value', 'error']>,
-) {
+): UseCronReturn {
   const cron = useCron(options)
 
   watch(

core/src/components/select.ts

@@ -192,11 +192,16 @@ export function useSelect<T, V>(options: SelectOptions<T, V>) {
   }
 }
 
+/**
+ * @interface
+ */
+export type UseSelectReturn<T, V> = ReturnType<typeof useSelect<T, V>>
+
 export function setupSelect<T, V>(
   options: SelectOptions<T, V>,
   modelValue: WatchSource<V>,
   { emit }: SetupContext<['update:model-value']>,
-) {
+): UseSelectReturn<T, V> {
   const s = useSelect(options)
 
   watch(s.selected, () => {

core/src/index.ts

@@ -9,13 +9,15 @@ export {
   type CronContext,
   type CronCoreProps,
   type CronOptions,
+  type UseCronReturn,
 } from './components/cron-core'
 export {
   RenderlessSelect,
   selectProps,
   setupSelect,
   useSelect,
   type SelectOptions,
+  type UseSelectReturn,
 } from './components/select'
 export { Locale, getLocale } from './locale'
 export type * from './locale/types'

core/src/types.ts

@@ -43,7 +43,14 @@ export interface Field {
 }
 
 export interface Period {
+  /**
+   * The id of the period
+   */
   id: string
+
+  /**
+   * The value determines which fields are visible
+   */
   value: string[]
 }
 

package-lock.json

@@ -29,10 +29,16 @@
     "@rushstack/eslint-patch": "^1.5.1",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^9.2.1",
+    "@tsconfig/node18": "^18.2.2",
+    "@types/jsdom": "^21.1.3",
+    "@types/node": "^18.18.5",
+    "@vitejs/plugin-vue": "^4.4.0",
     "@vue-js-cron/generated": "file:./generated",
     "@vue/cli-service": "^5.0.8",
     "@vue/eslint-config-prettier": "^8.0.0",
     "@vue/eslint-config-typescript": "^12.0.0",
+    "@vue/test-utils": "^2.4.1",
+    "@vue/tsconfig": "^0.4.0",
     "eslint": "^8.52.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-config-standard": "^17.0.0",
@@ -41,25 +47,20 @@
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-promise": "^6.0.0",
     "eslint-plugin-vue": "^9.18.1",
+    "jsdom": "^22.1.0",
     "multi-semantic-release": "^3.0.2",
+    "npm-run-all2": "^6.1.1",
     "prettier": "^3.0.3",
     "rollup": "^4.3.0",
     "rollup-plugin-css-only": "^4.5.0",
     "rollup-plugin-vue": "^6.0.0",
-    "vue": "^3.3.4",
     "typedoc": "^0.25.3",
-    "@tsconfig/node18": "^18.2.2",
-    "@types/jsdom": "^21.1.3",
-    "@types/node": "^18.18.5",
-    "@vitejs/plugin-vue": "^4.4.0",
-    "@vue/tsconfig": "^0.4.0",
-    "@vue/test-utils": "^2.4.1",
-    "jsdom": "^22.1.0",
-    "npm-run-all2": "^6.1.1",
+    "typedoc-plugin-vue": "^1.1.0",
     "typescript": "~5.2.0",
     "vite": "^4.4.11",
+    "vite-plugin-dts": "^3.6.3",
     "vitest": "^0.34.4",
-    "vue-tsc": "^1.8.19",
-    "vite-plugin-dts": "^3.6.3"
+    "vue": "^3.3.4",
+    "vue-tsc": "^1.8.19"
   }
 }

package.json

@@ -3,4 +3,5 @@
     "entryPoints": ["core", "light", "ant"],
     "entryPointStrategy": "packages",
     "out": "typedoc",
+    "plugin": ["typedoc-plugin-vue"]
 }