docs: add arguments to createWrapper.md (#869)

Author: eddyerburgh

.circleci/config.yml

@@ -103,7 +103,7 @@ jobs:
       - attach_workspace:
           at: ~/repo
       - *restore_node_modules
-      - run: yarn test:compat "2.5.13"
+      - run: yarn test:compat "2.5.16"
 workflows:
   version: 2
   install-tests:

docs/README.md

@@ -78,5 +78,6 @@ Vue Test Utils is the official unit testing utility library for Vue.js.
     * [TransitionGroupStub](api/components/TransitionGroupStub.md)
     * [RouterLinkStub](api/components/RouterLinkStub.md)
   * [Selectors](api/selectors.md)
+  * [createWrapper](api/createWrapper.md)
   * [createLocalVue](api/createLocalVue.md)
   * [config](api/config.md)

docs/api/createWrapper.md

@@ -1,4 +1,11 @@
-## createWrapper()
+## createWrapper(node, options)
+
+- **Arguments:**
+
+  - `{vm|HTMLElement} node`
+  - `{Object} options`
+    - `{Boolean} sync`
+    - `{Boolean} attachedToDocument
 
 - **Returns:**
   - `{Wrapper}`

packages/test-utils/types/index.d.ts

@@ -81,7 +81,7 @@ interface BaseWrapper {
   destroy (): void
 }
 
-export interface Wrapper<V extends Vue> extends BaseWrapper {
+export interface Wrapper<V extends Vue | null> extends BaseWrapper {
   readonly vm: V
   readonly element: HTMLElement
   readonly options: WrapperOptions
@@ -117,8 +117,8 @@ export interface WrapperArray<V extends Vue> extends BaseWrapper {
 }
 
 interface WrapperOptions {
-  attachedToDocument: boolean
-  sync: boolean
+  attachedToDocument?: boolean
+  sync?: boolean
 }
 
 interface MountOptions<V extends Vue> extends ComponentOptions<V> {
@@ -161,6 +161,9 @@ export declare function shallowMount<V extends Vue> (component: VueClass<V>, opt
 export declare function shallowMount<V extends Vue> (component: ComponentOptions<V>, options?: ThisTypedShallowMountOptions<V>): Wrapper<V>
 export declare function shallowMount (component: FunctionalComponentOptions, options?: ShallowMountOptions<Vue>): Wrapper<Vue>
 
+export declare function createWrapper(node: Vue, options?: WrapperOptions): Wrapper<Vue>
+export declare function createWrapper(node: HTMLElement, options?: WrapperOptions): Wrapper<null>
+
 export declare let TransitionStub: Component | string | true
 export declare let TransitionGroupStub: Component | string | true
 export declare let RouterLinkStub: VueClass<Vue>

packages/test-utils/types/test/wrapper.ts

@@ -1,5 +1,6 @@
-import { mount } from '../'
+import { mount, createWrapper } from '../'
 import { normalOptions, functionalOptions, Normal, ClassComponent } from './resources'
+import Vue from 'vue'
 
 /**
  * Tests for BaseWrapper API
@@ -47,8 +48,6 @@ wrapper.vm.$emit('event', 'arg')
 
 let el: HTMLElement = wrapper.element
 
-bool = wrapper.options.attachedToDocument
-
 let found = wrapper.find('.foo')
 found = wrapper.find(normalOptions)
 found = wrapper.find(functionalOptions)
@@ -78,3 +77,14 @@ str = wrapper.name()
 let num: number = array.length
 found = array.at(1)
 array = array.filter((a: any) => a === true)
+
+let createdWrapper = createWrapper(new Vue().$mount())
+createdWrapper.text()
+createWrapper(document.createElement('div'))
+createWrapper(document.createElement('div'), {
+  sync: false,
+  attachedToDocument: true
+})
+createWrapper(document.createElement('div'), {
+  attachedToDocument: true
+})

scripts/test-compat-all.sh

@@ -7,4 +7,4 @@ scripts/test-compat.sh "2.1.10"
 scripts/test-compat.sh "2.2.6"
 scripts/test-compat.sh "2.3.4"
 scripts/test-compat.sh "2.4.2"
-scripts/test-compat.sh "2.5.13"
+scripts/test-compat.sh "2.5.16"

test/specs/create-wrapper.spec.js

@@ -4,12 +4,28 @@ import Component from '~resources/components/component.vue'
 import { describeRunIf } from 'conditional-specs'
 
 describeRunIf(process.env.TEST_ENV !== 'node', 'mount', () => {
-  it.only('exports createWrapper', () => {
+  it('exports createWrapper', () => {
     const Constructor = Vue.extend(Component)
     const vm = new Constructor().$mount()
     const wrapper = createWrapper(vm)
     expect(wrapper.is(Component)).to.equal(true)
     expect(wrapper).instanceof(Wrapper)
     expect(wrapper.findAll('div')).instanceof(WrapperArray)
   })
+
+  it('handles HTMLElement', () => {
+    const wrapper = createWrapper(document.createElement('div'))
+    expect(wrapper.is('div')).to.equal(true)
+  })
+
+  it('handles options', () => {
+    const Constructor = Vue.extend(Component)
+    const vm = new Constructor().$mount()
+    const wrapper = createWrapper(vm, {
+      sync: true,
+      attachToDocument: true
+    })
+    expect(wrapper.options.attachToDocument).to.equal(true)
+    expect(wrapper.options.sync).to.equal(true)
+  })
 })