diff --git a/package-lock.json b/package-lock.json index 97c2d17..986513b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -41,7 +41,7 @@ "jsdom": "^26.0.0", "lint-staged": "^15.2.9", "prettier": "^3.4.2", - "typescript": "^4.7.4", + "typescript": "^4.9.5", "vitest": "^3.0.7" } }, @@ -6465,6 +6465,34 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/typedoc": { + "version": "0.19.2", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.19.2.tgz", + "integrity": "sha512-oDEg1BLEzi1qvgdQXc658EYgJ5qJLVSeZ0hQ57Eq4JXy6Vj2VX4RVo18qYxRWz75ifAaYuYNBUCnbhjd37TfOg==", + "license": "Apache-2.0", + "dependencies": { + "fs-extra": "^9.0.1", + "handlebars": "^4.7.6", + "highlight.js": "^10.2.0", + "lodash": "^4.17.20", + "lunr": "^2.3.9", + "marked": "^1.1.1", + "minimatch": "^3.0.0", + "progress": "^2.0.3", + "semver": "^7.3.2", + "shelljs": "^0.8.4", + "typedoc-default-themes": "^0.11.4" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 10.0.0" + }, + "peerDependencies": { + "typescript": "3.9.x || 4.0.x" + } + }, "node_modules/typedoc-default-themes": { "version": "0.11.4", "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.11.4.tgz", diff --git a/package.json b/package.json index 4460663..aa04a0d 100644 --- a/package.json +++ b/package.json @@ -49,9 +49,12 @@ "jsdom": "^26.0.0", "lint-staged": "^15.2.9", "prettier": "^3.4.2", - "typescript": "^4.7.4", + "typescript": "^4.9.5", "vitest": "^3.0.7" }, + "overrides": { + "typescript": "^4.9.5" + }, "lint-staged": { "*.{js,jsx,ts,tsx}": [ "eslint --fix" diff --git a/scripts/generate-doc.js b/scripts/generate-doc.js index 7786f2d..65b631b 100755 --- a/scripts/generate-doc.js +++ b/scripts/generate-doc.js @@ -1,25 +1,11 @@ #!/usr/bin/env node // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -const { documentTestUtils } = require('@cloudscape-design/documenter'); -const fs = require('node:fs'); +const { writeTestUtilsDocumentation } = require('@cloudscape-design/documenter'); -const outputPath = './lib/core/test-utils-doc'; -if (!fs.existsSync(outputPath)) { - fs.mkdirSync(outputPath, { recursive: true }); -} - -const testUtilTypes = ['dom', 'selectors']; -testUtilTypes.forEach(testUtilType => { - const wrapperDefinitions = documentTestUtils( - { - tsconfig: require.resolve('../tsconfig.docs.json'), - includeDeclarations: true, - excludeExternals: true, - }, - `./lib/core/**/${testUtilType}.d.ts`, - ); - - const fileContent = `module.exports = ${JSON.stringify(wrapperDefinitions)}`; - fs.writeFileSync(`${outputPath}/${testUtilType}.js`, fileContent); +writeTestUtilsDocumentation({ + outDir: './lib/core/test-utils-doc', + tsconfigPath: require.resolve('../tsconfig.docs.json'), + domUtils: { root: 'src/core/dom.ts', extraExports: ['createWrapper', 'usesDom'] }, + selectorsUtils: { root: 'src/core/selectors.ts', extraExports: ['createWrapper'] }, }); diff --git a/src/core/test/__snapshots__/documenter.test.ts.snap b/src/core/test/__snapshots__/documenter.test.ts.snap index 466195b..61b4259 100644 --- a/src/core/test/__snapshots__/documenter.test.ts.snap +++ b/src/core/test/__snapshots__/documenter.test.ts.snap @@ -1,1804 +1,1671 @@ // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html exports[`documenter output > dom 1`] = ` -[ - { - "methods": [ - { - "name": "blur", - "parameters": [], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "description": "Performs a click by triggering a mouse event. +{ + "classes": [ + { + "methods": [ + { + "name": "blur", + "parameters": [], + "returnType": { + "name": "void", + }, + }, + { + "description": "Performs a click by triggering a mouse event. Note that programmatic events ignore disabled attribute and will trigger listeners even if the element is disabled.", - "name": "click", - "parameters": [ - { - "flags": { - "isOptional": true, - }, - "name": "params", - "typeName": "MouseEventInit", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "name": "find", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper | null", - "type": "union", - }, - }, - { - "name": "findAll", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "array", - "type": "reference", - }, - }, - { - "name": "findAllByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "array", - "type": "reference", - }, - }, - { - "description": "Returns the wrappers of all components that match the specified component type and the specified CSS selector. + "name": "click", + "parameters": [ + { + "flags": { + "isOptional": true, + }, + "name": "params", + "typeName": "MouseEventInit", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "name": "find", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper | null", + }, + }, + { + "name": "findAll", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "Array>", + }, + }, + { + "name": "findAllByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "Array>", + }, + }, + { + "description": "Returns the wrappers of all components that match the specified component type and the specified CSS selector. If no CSS selector is specified, returns all of the components that match the specified component type. If no matching component is found, returns an empty array.", - "name": "findAllComponents", - "parameters": [ - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "ComponentWrapperClass", - }, - { - "flags": { - "isOptional": true, - }, - "name": "selector", - }, - ], - "returnType": { - "name": "Array", - "type": "reference", - "typeArguments": [ - { - "name": "Wrapper", - "type": "typeParameter", - }, - ], - }, - }, - { - "name": "findAny", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selectors", - "typeName": "Array", - }, - ], - "returnType": { - "name": "ElementWrapper | null", - "type": "union", - }, - }, - { - "name": "findByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper | null", - "type": "union", - }, - }, - { - "description": "Returns the component wrapper matching the specified selector. + "name": "findAllComponents", + "parameters": [ + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "ComponentWrapperClass", + }, + { + "description": "CSS selector", + "flags": { + "isOptional": true, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "Array", + }, + }, + { + "name": "findAny", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selectors", + "typeName": "Array", + }, + ], + "returnType": { + "name": "ElementWrapper | null", + }, + }, + { + "name": "findByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper | null", + }, + }, + { + "description": "Returns the component wrapper matching the specified selector. If the specified selector doesn't match any element, it returns \`null\`. -Note: This function returns the specified component's wrapper even if the specified selector points to a different component type. -", - "name": "findComponent", - "parameters": [ - { - "description": " -CSS selector", - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "WrapperClass", - }, - ], - "returnType": { - "name": "Wrapper | null", - "type": "union", - }, - }, - { - "name": "fireEvent", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "event", - "typeName": "Event", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "name": "focus", - "parameters": [], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "name": "getElement", - "parameters": [], - "returnType": { - "name": "ElementType", - "type": "typeParameter", - }, - }, - { - "name": "keydown", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "keyCode", - "typeName": "KeyCode", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "name": "keypress", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "keyCode", - "typeName": "KeyCode", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "name": "keyup", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "keyCode", - "typeName": "KeyCode", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "name": "matches", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "this | null", - "type": "union", - }, - }, - ], - "name": "AbstractWrapper", - }, - { - "methods": [ - { - "inheritedFrom": { - "name": "AbstractWrapper.blur", - }, - "name": "blur", - "parameters": [], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "description": "Performs a click by triggering a mouse event. + +Note: This function returns the specified component's wrapper even if the specified selector points to a different component type.", + "name": "findComponent", + "parameters": [ + { + "description": "CSS selector", + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "WrapperClass", + }, + ], + "returnType": { + "name": "Wrapper | null", + }, + }, + { + "name": "fireEvent", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "event", + "typeName": "Event", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "name": "focus", + "parameters": [], + "returnType": { + "name": "void", + }, + }, + { + "name": "getElement", + "parameters": [], + "returnType": { + "name": "ElementType", + }, + }, + { + "name": "keydown", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyCode", + "typeName": "KeyCode", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "name": "keydown", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyboardEventProps", + "typeName": "KeyboardEventInit", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "name": "keypress", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyCode", + "typeName": "KeyCode", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "name": "keyup", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyCode", + "typeName": "KeyCode", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "name": "matches", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "this | null", + }, + }, + ], + "name": "AbstractWrapper", + }, + { + "methods": [ + { + "inheritedFrom": { + "name": "AbstractWrapper.blur", + }, + "name": "blur", + "parameters": [], + "returnType": { + "name": "void", + }, + }, + { + "description": "Performs a click by triggering a mouse event. Note that programmatic events ignore disabled attribute and will trigger listeners even if the element is disabled.", - "inheritedFrom": { - "name": "AbstractWrapper.click", - }, - "name": "click", - "parameters": [ - { - "flags": { - "isOptional": true, - }, - "name": "params", - "typeName": "MouseEventInit", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.find", - }, - "name": "find", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper | null", - "type": "union", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAll", - }, - "name": "findAll", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "array", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAllByClassName", - }, - "name": "findAllByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "array", - "type": "reference", - }, - }, - { - "description": "Returns the wrappers of all components that match the specified component type and the specified CSS selector. + "inheritedFrom": { + "name": "AbstractWrapper.click", + }, + "name": "click", + "parameters": [ + { + "flags": { + "isOptional": true, + }, + "name": "params", + "typeName": "MouseEventInit", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.find", + }, + "name": "find", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper | null", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAll", + }, + "name": "findAll", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "Array>", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAllByClassName", + }, + "name": "findAllByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "Array>", + }, + }, + { + "description": "Returns the wrappers of all components that match the specified component type and the specified CSS selector. If no CSS selector is specified, returns all of the components that match the specified component type. If no matching component is found, returns an empty array.", - "inheritedFrom": { - "name": "AbstractWrapper.findAllComponents", - }, - "name": "findAllComponents", - "parameters": [ - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "ComponentWrapperClass", - }, - { - "flags": { - "isOptional": true, - }, - "name": "selector", - }, - ], - "returnType": { - "name": "Array", - "type": "reference", - "typeArguments": [ - { - "name": "Wrapper", - "type": "typeParameter", - }, - ], - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAny", - }, - "name": "findAny", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selectors", - "typeName": "Array", - }, - ], - "returnType": { - "name": "ElementWrapper | null", - "type": "union", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findByClassName", - }, - "name": "findByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper | null", - "type": "union", - }, - }, - { - "description": "Returns the component wrapper matching the specified selector. + "inheritedFrom": { + "name": "AbstractWrapper.findAllComponents", + }, + "name": "findAllComponents", + "parameters": [ + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "ComponentWrapperClass", + }, + { + "description": "CSS selector", + "flags": { + "isOptional": true, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "Array", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAny", + }, + "name": "findAny", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selectors", + "typeName": "Array", + }, + ], + "returnType": { + "name": "ElementWrapper | null", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findByClassName", + }, + "name": "findByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper | null", + }, + }, + { + "description": "Returns the component wrapper matching the specified selector. If the specified selector doesn't match any element, it returns \`null\`. -Note: This function returns the specified component's wrapper even if the specified selector points to a different component type. -", - "inheritedFrom": { - "name": "AbstractWrapper.findComponent", - }, - "name": "findComponent", - "parameters": [ - { - "description": " -CSS selector", - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "WrapperClass", - }, - ], - "returnType": { - "name": "Wrapper | null", - "type": "union", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.fireEvent", - }, - "name": "fireEvent", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "event", - "typeName": "Event", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.focus", - }, - "name": "focus", - "parameters": [], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.getElement", - }, - "name": "getElement", - "parameters": [], - "returnType": { - "name": "ElementType", - "type": "typeParameter", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.keydown", - }, - "name": "keydown", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "keyCode", - "typeName": "KeyCode", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.keypress", - }, - "name": "keypress", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "keyCode", - "typeName": "KeyCode", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.keyup", - }, - "name": "keyup", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "keyCode", - "typeName": "KeyCode", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.matches", - }, - "name": "matches", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "this | null", - "type": "union", - }, - }, - ], - "name": "ComponentWrapper", - }, - { - "methods": [ - { - "inheritedFrom": { - "name": "AbstractWrapper.blur", - }, - "name": "blur", - "parameters": [], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "description": "Performs a click by triggering a mouse event. + +Note: This function returns the specified component's wrapper even if the specified selector points to a different component type.", + "inheritedFrom": { + "name": "AbstractWrapper.findComponent", + }, + "name": "findComponent", + "parameters": [ + { + "description": "CSS selector", + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "WrapperClass", + }, + ], + "returnType": { + "name": "Wrapper | null", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.fireEvent", + }, + "name": "fireEvent", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "event", + "typeName": "Event", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.focus", + }, + "name": "focus", + "parameters": [], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.getElement", + }, + "name": "getElement", + "parameters": [], + "returnType": { + "name": "ElementType", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.keydown", + }, + "name": "keydown", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyCode", + "typeName": "KeyCode", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.keydown", + }, + "name": "keydown", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyboardEventProps", + "typeName": "KeyboardEventInit", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.keypress", + }, + "name": "keypress", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyCode", + "typeName": "KeyCode", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.keyup", + }, + "name": "keyup", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyCode", + "typeName": "KeyCode", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.matches", + }, + "name": "matches", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "this | null", + }, + }, + ], + "name": "ElementWrapper", + }, + { + "methods": [ + { + "inheritedFrom": { + "name": "AbstractWrapper.blur", + }, + "name": "blur", + "parameters": [], + "returnType": { + "name": "void", + }, + }, + { + "description": "Performs a click by triggering a mouse event. Note that programmatic events ignore disabled attribute and will trigger listeners even if the element is disabled.", - "inheritedFrom": { - "name": "AbstractWrapper.click", - }, - "name": "click", - "parameters": [ - { - "flags": { - "isOptional": true, - }, - "name": "params", - "typeName": "MouseEventInit", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.find", - }, - "name": "find", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper | null", - "type": "union", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAll", - }, - "name": "findAll", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "array", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAllByClassName", - }, - "name": "findAllByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "array", - "type": "reference", - }, - }, - { - "description": "Returns the wrappers of all components that match the specified component type and the specified CSS selector. + "inheritedFrom": { + "name": "AbstractWrapper.click", + }, + "name": "click", + "parameters": [ + { + "flags": { + "isOptional": true, + }, + "name": "params", + "typeName": "MouseEventInit", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.find", + }, + "name": "find", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper | null", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAll", + }, + "name": "findAll", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "Array>", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAllByClassName", + }, + "name": "findAllByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "Array>", + }, + }, + { + "description": "Returns the wrappers of all components that match the specified component type and the specified CSS selector. If no CSS selector is specified, returns all of the components that match the specified component type. If no matching component is found, returns an empty array.", - "inheritedFrom": { - "name": "AbstractWrapper.findAllComponents", - }, - "name": "findAllComponents", - "parameters": [ - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "ComponentWrapperClass", - }, - { - "flags": { - "isOptional": true, - }, - "name": "selector", - }, - ], - "returnType": { - "name": "Array", - "type": "reference", - "typeArguments": [ - { - "name": "Wrapper", - "type": "typeParameter", - }, - ], - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAny", - }, - "name": "findAny", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selectors", - "typeName": "Array", - }, - ], - "returnType": { - "name": "ElementWrapper | null", - "type": "union", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findByClassName", - }, - "name": "findByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper | null", - "type": "union", - }, - }, - { - "description": "Returns the component wrapper matching the specified selector. + "inheritedFrom": { + "name": "AbstractWrapper.findAllComponents", + }, + "name": "findAllComponents", + "parameters": [ + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "ComponentWrapperClass", + }, + { + "description": "CSS selector", + "flags": { + "isOptional": true, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "Array", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAny", + }, + "name": "findAny", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selectors", + "typeName": "Array", + }, + ], + "returnType": { + "name": "ElementWrapper | null", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findByClassName", + }, + "name": "findByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper | null", + }, + }, + { + "description": "Returns the component wrapper matching the specified selector. If the specified selector doesn't match any element, it returns \`null\`. -Note: This function returns the specified component's wrapper even if the specified selector points to a different component type. -", - "inheritedFrom": { - "name": "AbstractWrapper.findComponent", - }, - "name": "findComponent", - "parameters": [ - { - "description": " -CSS selector", - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "WrapperClass", - }, - ], - "returnType": { - "name": "Wrapper | null", - "type": "union", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.fireEvent", - }, - "name": "fireEvent", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "event", - "typeName": "Event", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.focus", - }, - "name": "focus", - "parameters": [], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.getElement", - }, - "name": "getElement", - "parameters": [], - "returnType": { - "name": "ElementType", - "type": "typeParameter", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.keydown", - }, - "name": "keydown", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "keyCode", - "typeName": "KeyCode", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.keypress", - }, - "name": "keypress", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "keyCode", - "typeName": "KeyCode", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.keyup", - }, - "name": "keyup", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "keyCode", - "typeName": "KeyCode", - }, - ], - "returnType": { - "name": "void", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.matches", - }, - "name": "matches", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "this | null", - "type": "union", - }, - }, - ], - "name": "ElementWrapper", - }, -] + +Note: This function returns the specified component's wrapper even if the specified selector points to a different component type.", + "inheritedFrom": { + "name": "AbstractWrapper.findComponent", + }, + "name": "findComponent", + "parameters": [ + { + "description": "CSS selector", + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "WrapperClass", + }, + ], + "returnType": { + "name": "Wrapper | null", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.fireEvent", + }, + "name": "fireEvent", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "event", + "typeName": "Event", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.focus", + }, + "name": "focus", + "parameters": [], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.getElement", + }, + "name": "getElement", + "parameters": [], + "returnType": { + "name": "ElementType", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.keydown", + }, + "name": "keydown", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyCode", + "typeName": "KeyCode", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.keydown", + }, + "name": "keydown", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyboardEventProps", + "typeName": "KeyboardEventInit", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.keypress", + }, + "name": "keypress", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyCode", + "typeName": "KeyCode", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.keyup", + }, + "name": "keyup", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "keyCode", + "typeName": "KeyCode", + }, + ], + "returnType": { + "name": "void", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.matches", + }, + "name": "matches", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "this | null", + }, + }, + ], + "name": "ComponentWrapper", + }, + ], +} `; exports[`documenter output > selectors 1`] = ` -[ - { - "methods": [ - { - "name": "find", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "name": "findAll", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "ElementWrapper", - "type": "reference", - }, - ], - }, - }, - { - "name": "findAllByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "ElementWrapper", - "type": "reference", - }, - ], - }, - }, - { - "description": "Returns a multi-element wrapper that matches the specified component type with the specified CSS selector. +{ + "classes": [ + { + "methods": [ + { + "name": "find", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "name": "findAll", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "name": "findAllByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "description": "Returns a multi-element wrapper that matches the specified component type with the specified CSS selector. If no CSS selector is specified, returns a multi-element wrapper that matches the specified component type.", - "name": "findAllComponents", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "ComponentWrapperClass", - }, - { - "flags": { - "isOptional": true, - }, - "name": "selector", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "Wrapper", - "type": "typeParameter", - }, - ], - }, - }, - { - "name": "findAny", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selectors", - "typeName": "Array", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "name": "findByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "description": "Returns a wrapper that matches the specified component type with the specified CSS selector. -Note: This function returns the specified component's wrapper even if the specified selector points to a different component type. -", - "name": "findComponent", - "parameters": [ - { - "description": " -CSS selector", - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "WrapperClass", - }, - ], - "returnType": { - "name": "Wrapper", - "type": "typeParameter", - }, - }, - { - "name": "getElement", - "parameters": [], - "returnType": { - "name": "string", - "type": "intrinsic", - }, - }, - { - "name": "matches", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "name": "toSelector", - "parameters": [], - "returnType": { - "name": "string", - "type": "intrinsic", - }, - }, - ], - "name": "AbstractWrapper", - }, - { - "methods": [ - { - "inheritedFrom": { - "name": "AbstractWrapper.find", - }, - "name": "find", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAll", - }, - "name": "findAll", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "ElementWrapper", - "type": "reference", - }, - ], - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAllByClassName", - }, - "name": "findAllByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "ElementWrapper", - "type": "reference", - }, - ], - }, - }, - { - "description": "Returns a multi-element wrapper that matches the specified component type with the specified CSS selector. + "name": "findAllComponents", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "ComponentWrapperClass", + }, + { + "description": "CSS Selector", + "flags": { + "isOptional": true, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "name": "findAny", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selectors", + "typeName": "Array", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "name": "findByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "description": "Returns a wrapper that matches the specified component type with the specified CSS selector. + +Note: This function returns the specified component's wrapper even if the specified selector points to a different component type.", + "name": "findComponent", + "parameters": [ + { + "description": "CSS selector", + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "WrapperClass", + }, + ], + "returnType": { + "name": "Wrapper", + }, + }, + { + "name": "getElement", + "parameters": [], + "returnType": { + "name": "string", + }, + }, + { + "name": "matches", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "name": "toSelector", + "parameters": [], + "returnType": { + "name": "string", + }, + }, + ], + "name": "AbstractWrapper", + }, + { + "methods": [ + { + "inheritedFrom": { + "name": "AbstractWrapper.find", + }, + "name": "find", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAll", + }, + "name": "findAll", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAllByClassName", + }, + "name": "findAllByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "description": "Returns a multi-element wrapper that matches the specified component type with the specified CSS selector. If no CSS selector is specified, returns a multi-element wrapper that matches the specified component type.", - "inheritedFrom": { - "name": "AbstractWrapper.findAllComponents", - }, - "name": "findAllComponents", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "ComponentWrapperClass", - }, - { - "flags": { - "isOptional": true, - }, - "name": "selector", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "Wrapper", - "type": "typeParameter", - }, - ], - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAny", - }, - "name": "findAny", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selectors", - "typeName": "Array", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findByClassName", - }, - "name": "findByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "description": "Returns a wrapper that matches the specified component type with the specified CSS selector. -Note: This function returns the specified component's wrapper even if the specified selector points to a different component type. -", - "inheritedFrom": { - "name": "AbstractWrapper.findComponent", - }, - "name": "findComponent", - "parameters": [ - { - "description": " -CSS selector", - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "WrapperClass", - }, - ], - "returnType": { - "name": "Wrapper", - "type": "typeParameter", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.getElement", - }, - "name": "getElement", - "parameters": [], - "returnType": { - "name": "string", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.matches", - }, - "name": "matches", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.toSelector", - }, - "name": "toSelector", - "parameters": [], - "returnType": { - "name": "string", - "type": "intrinsic", - }, - }, - ], - "name": "ComponentWrapper", - }, - { - "methods": [ - { - "inheritedFrom": { - "name": "AbstractWrapper.find", - }, - "name": "find", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAll", - }, - "name": "findAll", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "ElementWrapper", - "type": "reference", - }, - ], - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAllByClassName", - }, - "name": "findAllByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "ElementWrapper", - "type": "reference", - }, - ], - }, - }, - { - "description": "Returns a multi-element wrapper that matches the specified component type with the specified CSS selector. + "inheritedFrom": { + "name": "AbstractWrapper.findAllComponents", + }, + "name": "findAllComponents", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "ComponentWrapperClass", + }, + { + "description": "CSS Selector", + "flags": { + "isOptional": true, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAny", + }, + "name": "findAny", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selectors", + "typeName": "Array", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findByClassName", + }, + "name": "findByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "description": "Returns a wrapper that matches the specified component type with the specified CSS selector. + +Note: This function returns the specified component's wrapper even if the specified selector points to a different component type.", + "inheritedFrom": { + "name": "AbstractWrapper.findComponent", + }, + "name": "findComponent", + "parameters": [ + { + "description": "CSS selector", + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "WrapperClass", + }, + ], + "returnType": { + "name": "Wrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.getElement", + }, + "name": "getElement", + "parameters": [], + "returnType": { + "name": "string", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.matches", + }, + "name": "matches", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.toSelector", + }, + "name": "toSelector", + "parameters": [], + "returnType": { + "name": "string", + }, + }, + ], + "name": "ElementWrapper", + }, + { + "methods": [ + { + "inheritedFrom": { + "name": "AbstractWrapper.find", + }, + "name": "find", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAll", + }, + "name": "findAll", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAllByClassName", + }, + "name": "findAllByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "description": "Returns a multi-element wrapper that matches the specified component type with the specified CSS selector. If no CSS selector is specified, returns a multi-element wrapper that matches the specified component type.", - "inheritedFrom": { - "name": "AbstractWrapper.findAllComponents", - }, - "name": "findAllComponents", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "ComponentWrapperClass", - }, - { - "flags": { - "isOptional": true, - }, - "name": "selector", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "Wrapper", - "type": "typeParameter", - }, - ], - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAny", - }, - "name": "findAny", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selectors", - "typeName": "Array", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findByClassName", - }, - "name": "findByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "description": "Returns a wrapper that matches the specified component type with the specified CSS selector. -Note: This function returns the specified component's wrapper even if the specified selector points to a different component type. -", - "inheritedFrom": { - "name": "AbstractWrapper.findComponent", - }, - "name": "findComponent", - "parameters": [ - { - "description": " -CSS selector", - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "WrapperClass", - }, - ], - "returnType": { - "name": "Wrapper", - "type": "typeParameter", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.getElement", - }, - "name": "getElement", - "parameters": [], - "returnType": { - "name": "string", - "type": "intrinsic", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.matches", - }, - "name": "matches", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.toSelector", - }, - "name": "toSelector", - "parameters": [], - "returnType": { - "name": "string", - "type": "intrinsic", - }, - }, - ], - "name": "ElementWrapper", - }, - { - "methods": [ - { - "inheritedFrom": { - "name": "AbstractWrapper.find", - }, - "name": "find", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAll", - }, - "name": "findAll", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "ElementWrapper", - "type": "reference", - }, - ], - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAllByClassName", - }, - "name": "findAllByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "ElementWrapper", - "type": "reference", - }, - ], - }, - }, - { - "description": "Returns a multi-element wrapper that matches the specified component type with the specified CSS selector. + "inheritedFrom": { + "name": "AbstractWrapper.findAllComponents", + }, + "name": "findAllComponents", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "ComponentWrapperClass", + }, + { + "description": "CSS Selector", + "flags": { + "isOptional": true, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAny", + }, + "name": "findAny", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selectors", + "typeName": "Array", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findByClassName", + }, + "name": "findByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "description": "Returns a wrapper that matches the specified component type with the specified CSS selector. + +Note: This function returns the specified component's wrapper even if the specified selector points to a different component type.", + "inheritedFrom": { + "name": "AbstractWrapper.findComponent", + }, + "name": "findComponent", + "parameters": [ + { + "description": "CSS selector", + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "WrapperClass", + }, + ], + "returnType": { + "name": "Wrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.getElement", + }, + "name": "getElement", + "parameters": [], + "returnType": { + "name": "string", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.matches", + }, + "name": "matches", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.toSelector", + }, + "name": "toSelector", + "parameters": [], + "returnType": { + "name": "string", + }, + }, + ], + "name": "ComponentWrapper", + }, + { + "methods": [ + { + "inheritedFrom": { + "name": "AbstractWrapper.find", + }, + "name": "find", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAll", + }, + "name": "findAll", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAllByClassName", + }, + "name": "findAllByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "description": "Returns a multi-element wrapper that matches the specified component type with the specified CSS selector. If no CSS selector is specified, returns a multi-element wrapper that matches the specified component type.", - "inheritedFrom": { - "name": "AbstractWrapper.findAllComponents", - }, - "name": "findAllComponents", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "ComponentWrapperClass", - }, - { - "flags": { - "isOptional": true, - }, - "name": "selector", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "Wrapper", - "type": "typeParameter", - }, - ], - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findAny", - }, - "name": "findAny", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selectors", - "typeName": "Array", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.findByClassName", - }, - "name": "findByClassName", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "className", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "description": "Returns a wrapper that matches the specified component type with the specified CSS selector. -Note: This function returns the specified component's wrapper even if the specified selector points to a different component type. -", - "inheritedFrom": { - "name": "AbstractWrapper.findComponent", - }, - "name": "findComponent", - "parameters": [ - { - "description": " -CSS selector", - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - { - "description": " -Component's wrapper class", - "flags": { - "isOptional": false, - }, - "name": "ComponentClass", - "typeName": "WrapperClass", - }, - ], - "returnType": { - "name": "Wrapper", - "type": "typeParameter", - }, - }, - { - "description": "Index is one-based because the method uses the :nth-child() CSS pseudo-class.", - "name": "get", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "index", - "typeName": "number", - }, - ], - "returnType": { - "name": "T", - "type": "typeParameter", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.getElement", - }, - "name": "getElement", - "parameters": [], - "returnType": { - "name": "string", - "type": "intrinsic", - }, - }, - { - "name": "map", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "factory", - }, - ], - "returnType": { - "name": "MultiElementWrapper", - "type": "reference", - "typeArguments": [ - { - "name": "T", - "type": "typeParameter", - }, - ], - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.matches", - }, - "name": "matches", - "parameters": [ - { - "flags": { - "isOptional": false, - }, - "name": "selector", - "typeName": "string", - }, - ], - "returnType": { - "name": "ElementWrapper", - "type": "reference", - }, - }, - { - "inheritedFrom": { - "name": "AbstractWrapper.toSelector", - }, - "name": "toSelector", - "parameters": [], - "returnType": { - "name": "string", - "type": "intrinsic", - }, - }, - ], - "name": "MultiElementWrapper", - }, -] + "inheritedFrom": { + "name": "AbstractWrapper.findAllComponents", + }, + "name": "findAllComponents", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "ComponentWrapperClass", + }, + { + "description": "CSS Selector", + "flags": { + "isOptional": true, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findAny", + }, + "name": "findAny", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selectors", + "typeName": "Array", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.findByClassName", + }, + "name": "findByClassName", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "className", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "description": "Returns a wrapper that matches the specified component type with the specified CSS selector. + +Note: This function returns the specified component's wrapper even if the specified selector points to a different component type.", + "inheritedFrom": { + "name": "AbstractWrapper.findComponent", + }, + "name": "findComponent", + "parameters": [ + { + "description": "CSS selector", + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + { + "description": "Component's wrapper class", + "flags": { + "isOptional": false, + }, + "name": "ComponentClass", + "typeName": "WrapperClass", + }, + ], + "returnType": { + "name": "Wrapper", + }, + }, + { + "description": "Index is one-based because the method uses the :nth-child() CSS pseudo-class.", + "name": "get", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "index", + "typeName": "number", + }, + ], + "returnType": { + "name": "T", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.getElement", + }, + "name": "getElement", + "parameters": [], + "returnType": { + "name": "string", + }, + }, + { + "name": "map", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "factory", + "typeName": "(wrapper: ElementWrapper) => T", + }, + ], + "returnType": { + "name": "MultiElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.matches", + }, + "name": "matches", + "parameters": [ + { + "flags": { + "isOptional": false, + }, + "name": "selector", + "typeName": "string", + }, + ], + "returnType": { + "name": "ElementWrapper", + }, + }, + { + "inheritedFrom": { + "name": "AbstractWrapper.toSelector", + }, + "name": "toSelector", + "parameters": [], + "returnType": { + "name": "string", + }, + }, + ], + "name": "MultiElementWrapper", + }, + ], +} `; diff --git a/tsconfig.docs.json b/tsconfig.docs.json index da46e84..5c8d183 100644 --- a/tsconfig.docs.json +++ b/tsconfig.docs.json @@ -9,5 +9,6 @@ "target": "es2018", "lib": ["es2018", "dom"] }, - "include": ["./lib/core/**/*.d.ts"] + "include": ["./src/core/**/*.ts"], + "exclude": ["./src/core/test"] }