Skip to content

fix(effector-vue): correct VueEffector type to be Plugin - #1306

Open
kTelyakov wants to merge 1 commit into
effector:masterfrom
kTelyakov:fix/vue-effector-plugin-type
Open

kTelyakov wants to merge 1 commit into
effector:masterfrom
kTelyakov:fix/vue-effector-plugin-type

Conversation

@kTelyakov

Copy link
Copy Markdown

Fixes #1186

VueEffector was incorrectly typed as a function that accepts a Plugin, but it is actually an object that implements the Plugin interface.

This allows using it correctly with app.use(VueEffector) in Vue 3.

Conventions

Fixes effector#1186

VueEffector was incorrectly typed as a function that accepts a Plugin,
but it is actually an object that implements the Plugin interface.

This allows using it correctly with app.use(VueEffector) in Vue 3.
zerobias pushed a commit that referenced this pull request Sep 10, 2026
The type runner compiled every declaration file against Vue 2 typings, so
composition.d.ts and options-vue3.d.ts were never checked: they describe a
Vue 3 API and cannot share a program with the root entry point, which is
written against Vue 2. Nothing caught that options-vue3.d.ts was not even a
module, so `import {VueEffector} from 'effector-vue/options-vue3'` failed for
every Options API user on Vue 3.

The runner now makes a second compile() pass for src/types/__tests__/
effector-vue3 with vue mapped to the installed Vue 3 typings, and the reports
of both passes are merged into one file, so the snapshots keep working as
before. Existing tests keep the Vue 2 pass untouched.

The VueEffector declaration is taken from #1306 by kTelyakov. The effector
option is declared through ComponentCustomOptions, which is the first step
towards #598.

Fixes #1186
zerobias added a commit that referenced this pull request Sep 10, 2026
test(types): typecheck effector-vue Vue 3 typings, accept #1306

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

VueEffector Type Does Not Support Usage as a Vue Plugin

1 participant