Fix waitFor return value documentation

[pcambra]

No description provided.

[Turbo87]

@pcambra you're right that it returns a Promise, but that Promise does not resolve "when settled". It resolves when the element(s) appear on the page and it resolves with those elements. I think the correct return type would be Promise<Element|Element[]> in TypeScript, but no idea if JSDoc can handle that.

You will also need to adjust the documentation in the code itself:

ember-test-helpers/addon-test-support/@ember/test-helpers/dom/wait-for.js

Lines 7 to 17 in 3e91a29

	/**
	Used to wait for a particular selector to appear in the DOM. Due to the fact
	that it does not wait for general settledness, this is quite useful for testing
	interim DOM states (e.g. loading states, pending promises, etc).
	@param {string} selector the selector to wait for
	@param {Object} [options] the options to be used
	@param {number} [options.timeout=1000] the time to wait (in ms) for a match
	@param {number} [options.count=null] the number of elements that should match the provided selector (null means one or more)
	@returns {Element|Array<Element>} the element (or array of elements) that were being waited upon
	*/

... and then you can regenerate the documentation using yarn docs

[pcambra]

Thanks for the pointers @Turbo87!
Makes sense, but this is all very new to me, {Promise<Element|Element[]>} has generated some weird stuff :)

[Turbo87]

looks great now, thanks :)