docs: update

lmiller1990 · lmiller1990 · commit 726262c10077 · 2020-01-16T23:17:25.000+10:00
diff --git a/docs/api/wrapper/find.md b/docs/api/wrapper/find.md
@@ -31,3 +31,5 @@ expect(barByName.is(Bar)).toBe(true)
 const fooRef = wrapper.find({ ref: 'foo' })
 expect(fooRef.is(Foo)).toBe(true)
 ```
+
+See also: [get](../get.md).
diff --git a/docs/api/wrapper/get.md b/docs/api/wrapper/get.md
@@ -10,6 +10,10 @@ import { mount } from '@vue/test-utils'
 
 const wrapper = mount(Foo)
 
+// similar to `wrapper.find`.
+`get` will throw an error if an element is not found. `find` will do nothing.
+expect(wrapper.get('.does-exist'))
+
 expect(() => wrapper.get('.does-not-exist'))
   .to.throw()
   .with.property(
diff --git a/packages/test-utils/src/error-wrapper.js b/packages/test-utils/src/error-wrapper.js
@@ -17,41 +17,31 @@ export default class ErrorWrapper implements BaseWrapper {
 
   attributes(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call attributes() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call attributes() on empty Wrapper`
     )
   }
 
   classes(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call classes() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call classes() on empty Wrapper`
     )
   }
 
   contains(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call contains() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call contains() on empty Wrapper`
     )
   }
 
   emitted(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call emitted() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call emitted() on empty Wrapper`
     )
   }
 
   emittedByOrder(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call emittedByOrder() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call emittedByOrder() on empty Wrapper`
     )
   }
 
@@ -61,73 +51,55 @@ export default class ErrorWrapper implements BaseWrapper {
 
   filter(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call filter() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call filter() on empty Wrapper`
     )
   }
 
   visible(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call visible() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call visible() on empty Wrapper`
     )
   }
 
   hasAttribute(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call hasAttribute() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call hasAttribute() on empty Wrapper`
     )
   }
 
   hasClass(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call hasClass() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call hasClass() on empty Wrapper`
     )
   }
 
   hasProp(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call hasProp() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call hasProp() on empty Wrapper`
     )
   }
 
   hasStyle(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call hasStyle() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call hasStyle() on empty Wrapper`
     )
   }
 
   findAll(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call findAll() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call findAll() on empty Wrapper`
     )
   }
 
   find(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call find() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call find() on empty Wrapper`
     )
   }
 
   html(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call html() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call html() on empty Wrapper`
     )
   }
 
@@ -139,121 +111,91 @@ export default class ErrorWrapper implements BaseWrapper {
 
   isEmpty(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call isEmpty() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call isEmpty() on empty Wrapper`
     )
   }
 
   isVisible(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call isVisible() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call isVisible() on empty Wrapper`
     )
   }
 
   isVueInstance(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call isVueInstance() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call isVueInstance() on empty Wrapper`
     )
   }
 
   name(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call name() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call name() on empty Wrapper`
     )
   }
 
   props(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call props() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call props() on empty Wrapper`
     )
   }
 
   text(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call text() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call text() on empty Wrapper`
     )
   }
 
   setComputed(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call setComputed() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call setComputed() on empty Wrapper`
     )
   }
 
   setData(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call setData() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call setData() on empty Wrapper`
     )
   }
 
   setMethods(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call setMethods() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call setMethods() on empty Wrapper`
     )
   }
 
   setProps(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call setProps() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call setProps() on empty Wrapper`
     )
   }
 
   setValue(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call setValue() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call setValue() on empty Wrapper`
     )
   }
 
   setChecked(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call setChecked() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call setChecked() on empty Wrapper`
     )
   }
 
   setSelected(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call setSelected() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call setSelected() on empty Wrapper`
     )
   }
 
   trigger(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call trigger() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call trigger() on empty Wrapper`
     )
   }
 
   destroy(): void {
     throwError(
-      `find did not return ${
-        this.selector
-      }, cannot call destroy() on empty Wrapper`
+      `find did not return ${this.selector}, cannot call destroy() on empty Wrapper`
     )
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -17,41 +17,31 @@ export default class ErrorWrapper implements BaseWrapper {`
`17`	`17`
`18`	`18`	`attributes(): void {`
`19`	`19`	`throwError(`
`20`		- `find did not return ${
`21`		`- this.selector`
`22`		- }, cannot call attributes() on empty Wrapper`
	`20`	+ `find did not return ${this.selector}, cannot call attributes() on empty Wrapper`
`23`	`21`	`)`
`24`	`22`	`}`
`25`	`23`
`26`	`24`	`classes(): void {`
`27`	`25`	`throwError(`
`28`		- `find did not return ${
`29`		`- this.selector`
`30`		- }, cannot call classes() on empty Wrapper`
	`26`	+ `find did not return ${this.selector}, cannot call classes() on empty Wrapper`
`31`	`27`	`)`
`32`	`28`	`}`
`33`	`29`
`34`	`30`	`contains(): void {`
`35`	`31`	`throwError(`
`36`		- `find did not return ${
`37`		`- this.selector`
`38`		- }, cannot call contains() on empty Wrapper`
	`32`	+ `find did not return ${this.selector}, cannot call contains() on empty Wrapper`
`39`	`33`	`)`
`40`	`34`	`}`
`41`	`35`
`42`	`36`	`emitted(): void {`
`43`	`37`	`throwError(`
`44`		- `find did not return ${
`45`		`- this.selector`
`46`		- }, cannot call emitted() on empty Wrapper`
	`38`	+ `find did not return ${this.selector}, cannot call emitted() on empty Wrapper`
`47`	`39`	`)`
`48`	`40`	`}`
`49`	`41`
`50`	`42`	`emittedByOrder(): void {`
`51`	`43`	`throwError(`
`52`		- `find did not return ${
`53`		`- this.selector`
`54`		- }, cannot call emittedByOrder() on empty Wrapper`
	`44`	+ `find did not return ${this.selector}, cannot call emittedByOrder() on empty Wrapper`
`55`	`45`	`)`
`56`	`46`	`}`
`57`	`47`
`@@ -61,73 +51,55 @@ export default class ErrorWrapper implements BaseWrapper {`
`61`	`51`
`62`	`52`	`filter(): void {`
`63`	`53`	`throwError(`
`64`		- `find did not return ${
`65`		`- this.selector`
`66`		- }, cannot call filter() on empty Wrapper`
	`54`	+ `find did not return ${this.selector}, cannot call filter() on empty Wrapper`
`67`	`55`	`)`
`68`	`56`	`}`
`69`	`57`
`70`	`58`	`visible(): void {`
`71`	`59`	`throwError(`
`72`		- `find did not return ${
`73`		`- this.selector`
`74`		- }, cannot call visible() on empty Wrapper`
	`60`	+ `find did not return ${this.selector}, cannot call visible() on empty Wrapper`
`75`	`61`	`)`
`76`	`62`	`}`
`77`	`63`
`78`	`64`	`hasAttribute(): void {`
`79`	`65`	`throwError(`
`80`		- `find did not return ${
`81`		`- this.selector`
`82`		- }, cannot call hasAttribute() on empty Wrapper`
	`66`	+ `find did not return ${this.selector}, cannot call hasAttribute() on empty Wrapper`
`83`	`67`	`)`
`84`	`68`	`}`
`85`	`69`
`86`	`70`	`hasClass(): void {`
`87`	`71`	`throwError(`
`88`		- `find did not return ${
`89`		`- this.selector`
`90`		- }, cannot call hasClass() on empty Wrapper`
	`72`	+ `find did not return ${this.selector}, cannot call hasClass() on empty Wrapper`
`91`	`73`	`)`
`92`	`74`	`}`
`93`	`75`
`94`	`76`	`hasProp(): void {`
`95`	`77`	`throwError(`
`96`		- `find did not return ${
`97`		`- this.selector`
`98`		- }, cannot call hasProp() on empty Wrapper`
	`78`	+ `find did not return ${this.selector}, cannot call hasProp() on empty Wrapper`
`99`	`79`	`)`
`100`	`80`	`}`
`101`	`81`
`102`	`82`	`hasStyle(): void {`
`103`	`83`	`throwError(`
`104`		- `find did not return ${
`105`		`- this.selector`
`106`		- }, cannot call hasStyle() on empty Wrapper`
	`84`	+ `find did not return ${this.selector}, cannot call hasStyle() on empty Wrapper`
`107`	`85`	`)`
`108`	`86`	`}`
`109`	`87`
`110`	`88`	`findAll(): void {`
`111`	`89`	`throwError(`
`112`		- `find did not return ${
`113`		`- this.selector`
`114`		- }, cannot call findAll() on empty Wrapper`
	`90`	+ `find did not return ${this.selector}, cannot call findAll() on empty Wrapper`
`115`	`91`	`)`
`116`	`92`	`}`
`117`	`93`
`118`	`94`	`find(): void {`
`119`	`95`	`throwError(`
`120`		- `find did not return ${
`121`		`- this.selector`
`122`		- }, cannot call find() on empty Wrapper`
	`96`	+ `find did not return ${this.selector}, cannot call find() on empty Wrapper`
`123`	`97`	`)`
`124`	`98`	`}`
`125`	`99`
`126`	`100`	`html(): void {`
`127`	`101`	`throwError(`
`128`		- `find did not return ${
`129`		`- this.selector`
`130`		- }, cannot call html() on empty Wrapper`
	`102`	+ `find did not return ${this.selector}, cannot call html() on empty Wrapper`
`131`	`103`	`)`
`132`	`104`	`}`
`133`	`105`
`@@ -139,121 +111,91 @@ export default class ErrorWrapper implements BaseWrapper {`
`139`	`111`
`140`	`112`	`isEmpty(): void {`
`141`	`113`	`throwError(`
`142`		- `find did not return ${
`143`		`- this.selector`
`144`		- }, cannot call isEmpty() on empty Wrapper`
	`114`	+ `find did not return ${this.selector}, cannot call isEmpty() on empty Wrapper`
`145`	`115`	`)`
`146`	`116`	`}`
`147`	`117`
`148`	`118`	`isVisible(): void {`
`149`	`119`	`throwError(`
`150`		- `find did not return ${
`151`		`- this.selector`
`152`		- }, cannot call isVisible() on empty Wrapper`
	`120`	+ `find did not return ${this.selector}, cannot call isVisible() on empty Wrapper`
`153`	`121`	`)`
`154`	`122`	`}`
`155`	`123`
`156`	`124`	`isVueInstance(): void {`
`157`	`125`	`throwError(`
`158`		- `find did not return ${
`159`		`- this.selector`
`160`		- }, cannot call isVueInstance() on empty Wrapper`
	`126`	+ `find did not return ${this.selector}, cannot call isVueInstance() on empty Wrapper`
`161`	`127`	`)`
`162`	`128`	`}`
`163`	`129`
`164`	`130`	`name(): void {`
`165`	`131`	`throwError(`
`166`		- `find did not return ${
`167`		`- this.selector`
`168`		- }, cannot call name() on empty Wrapper`
	`132`	+ `find did not return ${this.selector}, cannot call name() on empty Wrapper`
`169`	`133`	`)`
`170`	`134`	`}`
`171`	`135`
`172`	`136`	`props(): void {`
`173`	`137`	`throwError(`
`174`		- `find did not return ${
`175`		`- this.selector`
`176`		- }, cannot call props() on empty Wrapper`
	`138`	+ `find did not return ${this.selector}, cannot call props() on empty Wrapper`
`177`	`139`	`)`
`178`	`140`	`}`
`179`	`141`
`180`	`142`	`text(): void {`
`181`	`143`	`throwError(`
`182`		- `find did not return ${
`183`		`- this.selector`
`184`		- }, cannot call text() on empty Wrapper`
	`144`	+ `find did not return ${this.selector}, cannot call text() on empty Wrapper`
`185`	`145`	`)`
`186`	`146`	`}`
`187`	`147`
`188`	`148`	`setComputed(): void {`
`189`	`149`	`throwError(`
`190`		- `find did not return ${
`191`		`- this.selector`
`192`		- }, cannot call setComputed() on empty Wrapper`
	`150`	+ `find did not return ${this.selector}, cannot call setComputed() on empty Wrapper`
`193`	`151`	`)`
`194`	`152`	`}`
`195`	`153`
`196`	`154`	`setData(): void {`
`197`	`155`	`throwError(`
`198`		- `find did not return ${
`199`		`- this.selector`
`200`		- }, cannot call setData() on empty Wrapper`
	`156`	+ `find did not return ${this.selector}, cannot call setData() on empty Wrapper`
`201`	`157`	`)`
`202`	`158`	`}`
`203`	`159`
`204`	`160`	`setMethods(): void {`
`205`	`161`	`throwError(`
`206`		- `find did not return ${
`207`		`- this.selector`
`208`		- }, cannot call setMethods() on empty Wrapper`
	`162`	+ `find did not return ${this.selector}, cannot call setMethods() on empty Wrapper`
`209`	`163`	`)`
`210`	`164`	`}`
`211`	`165`
`212`	`166`	`setProps(): void {`
`213`	`167`	`throwError(`
`214`		- `find did not return ${
`215`		`- this.selector`
`216`		- }, cannot call setProps() on empty Wrapper`
	`168`	+ `find did not return ${this.selector}, cannot call setProps() on empty Wrapper`
`217`	`169`	`)`
`218`	`170`	`}`
`219`	`171`
`220`	`172`	`setValue(): void {`
`221`	`173`	`throwError(`
`222`		- `find did not return ${
`223`		`- this.selector`
`224`		- }, cannot call setValue() on empty Wrapper`
	`174`	+ `find did not return ${this.selector}, cannot call setValue() on empty Wrapper`
`225`	`175`	`)`
`226`	`176`	`}`
`227`	`177`
`228`	`178`	`setChecked(): void {`
`229`	`179`	`throwError(`
`230`		- `find did not return ${
`231`		`- this.selector`
`232`		- }, cannot call setChecked() on empty Wrapper`
	`180`	+ `find did not return ${this.selector}, cannot call setChecked() on empty Wrapper`
`233`	`181`	`)`
`234`	`182`	`}`
`235`	`183`
`236`	`184`	`setSelected(): void {`
`237`	`185`	`throwError(`
`238`		- `find did not return ${
`239`		`- this.selector`
`240`		- }, cannot call setSelected() on empty Wrapper`
	`186`	+ `find did not return ${this.selector}, cannot call setSelected() on empty Wrapper`
`241`	`187`	`)`
`242`	`188`	`}`
`243`	`189`
`244`	`190`	`trigger(): void {`
`245`	`191`	`throwError(`
`246`		- `find did not return ${
`247`		`- this.selector`
`248`		- }, cannot call trigger() on empty Wrapper`
	`192`	+ `find did not return ${this.selector}, cannot call trigger() on empty Wrapper`
`249`	`193`	`)`
`250`	`194`	`}`
`251`	`195`
`252`	`196`	`destroy(): void {`
`253`	`197`	`throwError(`
`254`		- `find did not return ${
`255`		`- this.selector`
`256`		- }, cannot call destroy() on empty Wrapper`
	`198`	+ `find did not return ${this.selector}, cannot call destroy() on empty Wrapper`
`257`	`199`	`)`
`258`	`200`	`}`
`259`	`201`	`}`