Skip to content

Type Reference(类型总览)

本页提供最常用的公开类型速查,避免把内部实现类型暴露为常规 API。

组件与应用

RuntimeApp

createApp() 的返回类型,公开 mount/use/provide/onUnmount/unmount/config/version。它不是 Vue DOM App 的完整类型,不包含 component/directive/mixin/runWithContext

AppConfig

Wevu 应用配置类型,当前公开 globalProperties: Record<string, any>

WevuPlugin

插件可以是 (app, ...options) => any 函数,也可以是带 install(app, ...options) 的对象。

CreateAppOptions

createApp() 的参数类型。

DefineComponentOptions

defineComponent() 的参数类型。

ComponentDefinition

defineComponent() 返回定义结构类型。

SetupContext

setup(props, ctx)ctx 的类型。

RuntimeInstance

页面/组件运行时实例类型。

MiniProgram* / HostMiniProgram*

小程序宿主中立类型与底层宿主类型别名,例如 MiniProgramRouterMiniProgramSelectorQueryMiniProgramIntersectionObserverMiniProgramBoundingClientRectResultHostMiniProgramPageScrollOption

推荐业务代码优先使用 MiniProgram* 命名;只有在明确需要表达底层宿主来源时再使用 HostMiniProgram*

响应式与监听

PropType<T>

用于给运行时 props 构造器附加 TypeScript 值类型,语义与 Vue PropType<T> 对齐。

MaybeRef<T>

表示普通值、RefShallowRef 或可写计算值,适合声明可接受响应式输入的组合式函数。

Ref

基础响应式引用类型。

ShallowRef

浅层响应式引用类型。

WatchOptions

watch/watchEffect 配置类型。

WatchStopHandle

watch 停止句柄类型。

MaybeRefOrGetter

可接收值、Ref 或 getter 的联合类型。

ExtractPropTypes<T>

从 Wevu ComponentPropsOptions 推导组件内部可见的 props 类型。

ExtractPublicPropTypes<T>

从 Wevu props 配置推导父组件可传入的公开 props 类型。

ComponentCustomProps

沿用 Vue 的组件自定义 props 扩展类型,可通过模块增强补充跨组件属性。

Store

StoreManager

store 根管理器类型。

DefineStoreOptions

defineStore 选项类型。

StoreToRefsResult

storeToRefs() 返回类型。

MutationType

store mutation 类型。

运行时配置

WevuDefaults

setWevuDefaults() 配置类型。

ModelBinding

defineModel/useModel/useBindModel 相关绑定类型。

ModelBindingOptions / ModelBindingPayload

useBindModel()useChangeModel() 生成 value + handler payload 时使用的参数与返回类型。

TriggerEventOptions

事件触发选项类型。

UseElementIntersectionObserverOptions

useElementIntersectionObserver() 的参数类型。

UseBoundingClientRectOptions / UseSelectorFieldsOptions / UseScrollOffsetOptions

节点查询相关组合式 API 的参数类型。

PageStackSnapshot / UsePageStackOptions

页面栈快照和 usePageStack() 配置类型。

自定义导航栏尺寸快照和 useNavigationBarMetrics() 配置类型。

UseAsyncPullDownRefreshOptions

useAsyncPullDownRefresh() 的错误处理和停止刷新函数配置类型。

说明

更多底层与内部类型仍可在类型声明文件中找到,但不属于推荐直接依赖的公共 API 文档范围。

Released under the MIT License.