From 386ae86a666948a433423405bfd12d69f79f264d Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot <> Date: Mon, 10 Jul 2023 09:35:37 +0000 Subject: [PATCH] Update API doc --- doc/common/apidoc/index.json | 178 +++++++++++++++++++++++++++++++---- package-lock.json | 1 - 2 files changed, 161 insertions(+), 18 deletions(-) diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index f243de30f..2df704d59 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -4261,7 +4261,7 @@ "name": "hooks", "optional": true, "readonly": false, - "type": "DirectiveHooks", + "type": "DirectiveHooks", "default": "", "description": "Uses to manage all lifecycle hooks" } @@ -4367,42 +4367,42 @@ "props": [], "methods": [ { - "name": "beforeCreate", + "name": "onBeforeCreate", "parameters": [], "returnType": "void" }, { - "name": "created", + "name": "onCreated", "parameters": [], "returnType": "void" }, { - "name": "beforeMount", + "name": "onBeforeMount", "parameters": [], "returnType": "void" }, { - "name": "mounted", + "name": "onMounted", "parameters": [], "returnType": "void" }, { - "name": "beforeUpdate", + "name": "onBeforeUpdate", "parameters": [], "returnType": "void" }, { - "name": "updated", + "name": "onUpdated", "parameters": [], "returnType": "void" }, { - "name": "beforeUnmount", + "name": "onBeforeUnmount", "parameters": [], "returnType": "void" }, { - "name": "unmounted", + "name": "onUnmounted", "parameters": [], "returnType": "void" } @@ -4459,11 +4459,155 @@ "methodDescription": "Defines methods that can be accessed by the component's reference.", "typeDescription": "Defines the custom types used by the module.", "values": { + "DirectiveInstance": { + "relatedProp": "", + "props": [ + { + "name": "$name", + "optional": false, + "readonly": false, + "type": "undefined | string", + "default": "" + }, + { + "name": "$host", + "optional": false, + "readonly": false, + "type": "T", + "default": "" + }, + { + "name": "$binding", + "optional": false, + "readonly": false, + "type": "DirectiveBinding", + "default": "" + }, + { + "name": "$el", + "optional": false, + "readonly": false, + "type": "undefined | HTMLElement", + "default": "" + }, + { + "name": "$css", + "optional": true, + "readonly": false, + "type": "Object", + "default": "" + }, + { + "name": "defaultPT", + "optional": false, + "readonly": false, + "type": "any", + "default": "" + }, + { + "name": "isUnstyled", + "optional": false, + "readonly": false, + "type": "boolean", + "default": "" + }, + { + "name": "[key: string]", + "optional": false, + "readonly": false, + "type": "any" + } + ], + "methods": [] + }, + "DirectiveOptions": { + "relatedProp": "", + "props": [ + { + "name": "el", + "optional": false, + "readonly": false, + "type": "T", + "default": "" + }, + { + "name": "binding", + "optional": false, + "readonly": false, + "type": "DirectiveBinding", + "default": "" + }, + { + "name": "vnode", + "optional": false, + "readonly": false, + "type": "VNode", + "default": "" + }, + { + "name": "prevVNode", + "optional": false, + "readonly": false, + "type": "Prev", + "default": "" + } + ], + "methods": [] + }, "DirectiveHooks": { "relatedProp": "", - "props": [], - "methods": [], - "extendedTypes": "Omit" + "props": [ + { + "name": "onCreated", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "onBeforeMount", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "onMounted", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "onBeforeUpdate", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "onUpdated", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "onBeforeUnmount", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + }, + { + "name": "onUnmounted", + "optional": true, + "readonly": false, + "type": "Function", + "default": "" + } + ], + "methods": [] }, "BaseDirectivePassThroughOptions": { "relatedProp": "", @@ -4472,7 +4616,7 @@ "name": "hooks", "optional": true, "readonly": false, - "type": "DirectiveHooks", + "type": "DirectiveHooks", "default": "" } ], @@ -20432,7 +20576,7 @@ "name": "hooks", "optional": true, "readonly": false, - "type": "DirectiveHooks", + "type": "DirectiveHooks", "default": "", "description": "Uses to manage all lifecycle hooks" } @@ -33035,7 +33179,7 @@ "name": "hooks", "optional": true, "readonly": false, - "type": "DirectiveHooks", + "type": "DirectiveHooks", "default": "", "description": "Uses to manage all lifecycle hooks" } @@ -36376,7 +36520,7 @@ "name": "hooks", "optional": true, "readonly": false, - "type": "DirectiveHooks", + "type": "DirectiveHooks", "default": "", "description": "Uses to manage all lifecycle hooks" } @@ -39872,7 +40016,7 @@ "name": "hooks", "optional": true, "readonly": false, - "type": "DirectiveHooks", + "type": "DirectiveHooks", "default": "", "description": "Uses to manage all lifecycle hooks" } diff --git a/package-lock.json b/package-lock.json index f9a228204..475b39bc5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -18695,7 +18695,6 @@ "@babel/core": { "version": "7.22.6", "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.22.6.tgz", - "integrity": "sha512-HPIyDa6n+HKw5dEuway3vVAhBboYCtREBMp+IWeseZy6TFtzn6MHkCH2KKYUOC/vKKwgSMHQW4htBOrmuRPXfw==", "dev": true, "requires": { "@ampproject/remapping": "^2.2.0",