Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
setupHelpers (default export)
✓ import setupHelpers from 'vue-test-helpers'
✗ const setupHelpers = require('vue-test-helpers')
Package uses ESM default export; CommonJS require works if your environment supports it, but ESM is preferred.
mount (global after setup)
✓ // after import setupHelpers from 'vue-test-helpers'; setupHelpers() // mount is now globally available
✗ import { mount } from 'vue-test-helpers'
mount is re-exported globally from @vue/test-utils by setupHelpers(), but not exported from the package itself. Don't import from this package.
shallow (global after setup, alias for shallowMount)
✓ // after setupHelpers(), shallow is globally available
✗ import { shallow } from 'vue-test-helpers'
shallow is an alias for shallowMount made global by setupHelpers(). Not a direct export.
Shows global setup and usage of hasClass, hasEmitted, hasProp, and event triggers.
// Install: npm install --save-dev vue-test-helpers @vue/test-utils@^1.0.0-beta.20
// Setup file (e.g., jest setupFilesAfterEnv):
import setupHelpers from 'vue-test-helpers';
setupHelpers();
// In test:
import { shallowMount } from '@vue/test-utils'; // or use global mount/shallow
import MyComponent from './MyComponent.vue';
describe('MyComponent', () => {
it('has a button with class primary', () => {
const wrapper = shallowMount(MyComponent);
expect(wrapper.find('button').hasClass('primary')).toBe(true);
});
it('emits click event', () => {
const wrapper = shallowMount(MyComponent);
wrapper.find('button').click();
expect(wrapper.hasEmitted('click')).toBe(true);
});
it('has prop foo with value bar', () => {
const wrapper = shallowMount(MyComponent, { propsData: { foo: 'bar' } });
expect(wrapper.hasProp('foo', 'bar')).toBe(true);
});
});
Errors
Common errors & fixes
Cannot find module '@vue/test-utils'
Missing peer dependency.
fixnpm install --save-dev @vue/test-utils@^1.0.0-beta.20
TypeError: wrapper.hasClass is not a function
setupHelpers() not called before test or helpers not applied.
fixEnsure setupHelpers() is called in test setup (e.g., Jest's setupFilesAfterEnv).
Audit
Dependencies
@vue/test-utilsrequiredPeer dependency: provides mount, shallowMount, and Wrapper prototype that helpers extend.