UNPKG

@angular/cdk

Version:

Angular Material Component Development Kit

1,263 lines 70.5 kB
{ "repo": "angular/components", "moduleLabel": "@angular/cdk/testing/testbed", "moduleName": "@angular/cdk/testing/testbed", "normalizedModuleName": "angular_cdk_testing_testbed", "entries": [ { "name": "TestbedHarnessEnvironmentOptions", "isAbstract": false, "entryType": "interface", "members": [ { "name": "queryFn", "type": "(selector: string, root: Element) => Iterable<Element> | ArrayLike<Element>", "memberType": "property", "memberTags": [], "description": "The query function used to find DOM elements.", "jsdocTags": [] } ], "generics": [], "description": "Options to configure the environment.", "jsdocTags": [], "rawComment": "/** Options to configure the environment. */", "implements": [], "source": { "filePath": "/src/cdk/testing/testbed/testbed-harness-environment.ts", "startLine": 25, "endLine": 28 } }, { "name": "TestbedHarnessEnvironment", "isAbstract": false, "entryType": "undecorated_class", "members": [ { "name": "constructor", "signatures": [], "implementation": { "params": [ { "name": "rawRootElement", "description": "", "type": "Element", "isOptional": false, "isRestParam": false }, { "name": "_fixture", "description": "", "type": "ComponentFixture<unknown>", "isOptional": false, "isRestParam": false }, { "name": "options", "description": "", "type": "TestbedHarnessEnvironmentOptions | undefined", "isOptional": true, "isRestParam": false } ], "isNewType": false, "returnType": "TestbedHarnessEnvironment", "generics": [], "name": "constructor", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [ "protected" ] }, { "name": "forceStabilize", "signatures": [ { "name": "forceStabilize", "entryType": "function", "description": "Flushes change detection and async tasks captured in the Angular zone.\nIn most cases it should not be necessary to call this manually. However, there may be some edge\ncases where it is needed to fully flush animation events.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "/**\n * Flushes change detection and async tasks captured in the Angular zone.\n * In most cases it should not be necessary to call this manually. However, there may be some edge\n * cases where it is needed to fully flush animation events.\n */", "returnType": "Promise<void>" } ], "implementation": { "params": [], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "forceStabilize", "description": "Flushes change detection and async tasks captured in the Angular zone.\nIn most cases it should not be necessary to call this manually. However, there may be some edge\ncases where it is needed to fully flush animation events.", "entryType": "function", "jsdocTags": [], "rawComment": "/**\n * Flushes change detection and async tasks captured in the Angular zone.\n * In most cases it should not be necessary to call this manually. However, there may be some edge\n * cases where it is needed to fully flush animation events.\n */" }, "entryType": "function", "description": "Flushes change detection and async tasks captured in the Angular zone.\nIn most cases it should not be necessary to call this manually. However, there may be some edge\ncases where it is needed to fully flush animation events.", "jsdocTags": [], "rawComment": "/**\n * Flushes change detection and async tasks captured in the Angular zone.\n * In most cases it should not be necessary to call this manually. However, there may be some edge\n * cases where it is needed to fully flush animation events.\n */", "memberType": "method", "memberTags": [] }, { "name": "waitForTasksOutsideAngular", "signatures": [ { "name": "waitForTasksOutsideAngular", "entryType": "function", "description": "Waits for all scheduled or running async tasks to complete. This allows harness\nauthors to wait for async tasks outside of the Angular zone.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "/**\n * Waits for all scheduled or running async tasks to complete. This allows harness\n * authors to wait for async tasks outside of the Angular zone.\n */", "returnType": "Promise<void>" } ], "implementation": { "params": [], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "waitForTasksOutsideAngular", "description": "Waits for all scheduled or running async tasks to complete. This allows harness\nauthors to wait for async tasks outside of the Angular zone.", "entryType": "function", "jsdocTags": [], "rawComment": "/**\n * Waits for all scheduled or running async tasks to complete. This allows harness\n * authors to wait for async tasks outside of the Angular zone.\n */" }, "entryType": "function", "description": "Waits for all scheduled or running async tasks to complete. This allows harness\nauthors to wait for async tasks outside of the Angular zone.", "jsdocTags": [], "rawComment": "/**\n * Waits for all scheduled or running async tasks to complete. This allows harness\n * authors to wait for async tasks outside of the Angular zone.\n */", "memberType": "method", "memberTags": [] }, { "name": "getDocumentRoot", "signatures": [ { "name": "getDocumentRoot", "entryType": "function", "description": "Gets the root element for the document.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "/** Gets the root element for the document. */", "returnType": "Element" } ], "implementation": { "params": [], "isNewType": false, "returnType": "Element", "generics": [], "name": "getDocumentRoot", "description": "Gets the root element for the document.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Gets the root element for the document. */" }, "entryType": "function", "description": "Gets the root element for the document.", "jsdocTags": [], "rawComment": "/** Gets the root element for the document. */", "memberType": "method", "memberTags": [ "protected" ] }, { "name": "createTestElement", "signatures": [ { "name": "createTestElement", "entryType": "function", "description": "Creates a `TestElement` from a raw element.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "element", "description": "", "type": "Element", "isOptional": false, "isRestParam": false } ], "rawComment": "/** Creates a `TestElement` from a raw element. */", "returnType": "TestElement" } ], "implementation": { "params": [ { "name": "element", "description": "", "type": "Element", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "TestElement", "generics": [], "name": "createTestElement", "description": "Creates a `TestElement` from a raw element.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Creates a `TestElement` from a raw element. */" }, "entryType": "function", "description": "Creates a `TestElement` from a raw element.", "jsdocTags": [], "rawComment": "/** Creates a `TestElement` from a raw element. */", "memberType": "method", "memberTags": [ "protected" ] }, { "name": "createEnvironment", "signatures": [ { "name": "createEnvironment", "entryType": "function", "description": "Creates a `HarnessLoader` rooted at the given raw element.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "element", "description": "", "type": "Element", "isOptional": false, "isRestParam": false } ], "rawComment": "/** Creates a `HarnessLoader` rooted at the given raw element. */", "returnType": "HarnessEnvironment<Element>" } ], "implementation": { "params": [ { "name": "element", "description": "", "type": "Element", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "HarnessEnvironment<Element>", "generics": [], "name": "createEnvironment", "description": "Creates a `HarnessLoader` rooted at the given raw element.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Creates a `HarnessLoader` rooted at the given raw element. */" }, "entryType": "function", "description": "Creates a `HarnessLoader` rooted at the given raw element.", "jsdocTags": [], "rawComment": "/** Creates a `HarnessLoader` rooted at the given raw element. */", "memberType": "method", "memberTags": [ "protected" ] }, { "name": "getAllRawElements", "signatures": [ { "name": "getAllRawElements", "entryType": "function", "description": "Gets a list of all elements matching the given selector under this environment's root element.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "selector", "description": "", "type": "string", "isOptional": false, "isRestParam": false } ], "rawComment": "/**\n * Gets a list of all elements matching the given selector under this environment's root element.\n */", "returnType": "Promise<Element[]>" } ], "implementation": { "params": [ { "name": "selector", "description": "", "type": "string", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "Promise<Element[]>", "generics": [], "name": "getAllRawElements", "description": "Gets a list of all elements matching the given selector under this environment's root element.", "entryType": "function", "jsdocTags": [], "rawComment": "/**\n * Gets a list of all elements matching the given selector under this environment's root element.\n */" }, "entryType": "function", "description": "Gets a list of all elements matching the given selector under this environment's root element.", "jsdocTags": [], "rawComment": "/**\n * Gets a list of all elements matching the given selector under this environment's root element.\n */", "memberType": "method", "memberTags": [ "protected" ] }, { "name": "loader", "signatures": [ { "name": "loader", "entryType": "function", "description": "Creates a `HarnessLoader` rooted at the given fixture's root element.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "fixture", "description": "", "type": "ComponentFixture<unknown>", "isOptional": false, "isRestParam": false }, { "name": "options", "description": "", "type": "TestbedHarnessEnvironmentOptions | undefined", "isOptional": true, "isRestParam": false } ], "rawComment": "/** Creates a `HarnessLoader` rooted at the given fixture's root element. */", "returnType": "HarnessLoader" } ], "implementation": { "params": [ { "name": "fixture", "description": "", "type": "ComponentFixture<unknown>", "isOptional": false, "isRestParam": false }, { "name": "options", "description": "", "type": "TestbedHarnessEnvironmentOptions | undefined", "isOptional": true, "isRestParam": false } ], "isNewType": false, "returnType": "HarnessLoader", "generics": [], "name": "loader", "description": "Creates a `HarnessLoader` rooted at the given fixture's root element.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Creates a `HarnessLoader` rooted at the given fixture's root element. */" }, "entryType": "function", "description": "Creates a `HarnessLoader` rooted at the given fixture's root element.", "jsdocTags": [], "rawComment": "/** Creates a `HarnessLoader` rooted at the given fixture's root element. */", "memberType": "method", "memberTags": [ "static" ] }, { "name": "documentRootLoader", "signatures": [ { "name": "documentRootLoader", "entryType": "function", "description": "Creates a `HarnessLoader` at the document root. This can be used if harnesses are\nlocated outside of a fixture (e.g. overlays appended to the document body).", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "fixture", "description": "", "type": "ComponentFixture<unknown>", "isOptional": false, "isRestParam": false }, { "name": "options", "description": "", "type": "TestbedHarnessEnvironmentOptions | undefined", "isOptional": true, "isRestParam": false } ], "rawComment": "/**\n * Creates a `HarnessLoader` at the document root. This can be used if harnesses are\n * located outside of a fixture (e.g. overlays appended to the document body).\n */", "returnType": "HarnessLoader" } ], "implementation": { "params": [ { "name": "fixture", "description": "", "type": "ComponentFixture<unknown>", "isOptional": false, "isRestParam": false }, { "name": "options", "description": "", "type": "TestbedHarnessEnvironmentOptions | undefined", "isOptional": true, "isRestParam": false } ], "isNewType": false, "returnType": "HarnessLoader", "generics": [], "name": "documentRootLoader", "description": "Creates a `HarnessLoader` at the document root. This can be used if harnesses are\nlocated outside of a fixture (e.g. overlays appended to the document body).", "entryType": "function", "jsdocTags": [], "rawComment": "/**\n * Creates a `HarnessLoader` at the document root. This can be used if harnesses are\n * located outside of a fixture (e.g. overlays appended to the document body).\n */" }, "entryType": "function", "description": "Creates a `HarnessLoader` at the document root. This can be used if harnesses are\nlocated outside of a fixture (e.g. overlays appended to the document body).", "jsdocTags": [], "rawComment": "/**\n * Creates a `HarnessLoader` at the document root. This can be used if harnesses are\n * located outside of a fixture (e.g. overlays appended to the document body).\n */", "memberType": "method", "memberTags": [ "static" ] }, { "name": "getNativeElement", "signatures": [ { "name": "getNativeElement", "entryType": "function", "description": "Gets the native DOM element corresponding to the given TestElement.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "el", "description": "", "type": "TestElement", "isOptional": false, "isRestParam": false } ], "rawComment": "/** Gets the native DOM element corresponding to the given TestElement. */", "returnType": "Element" } ], "implementation": { "params": [ { "name": "el", "description": "", "type": "TestElement", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "Element", "generics": [], "name": "getNativeElement", "description": "Gets the native DOM element corresponding to the given TestElement.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Gets the native DOM element corresponding to the given TestElement. */" }, "entryType": "function", "description": "Gets the native DOM element corresponding to the given TestElement.", "jsdocTags": [], "rawComment": "/** Gets the native DOM element corresponding to the given TestElement. */", "memberType": "method", "memberTags": [ "static" ] }, { "name": "harnessForFixture", "signatures": [ { "name": "harnessForFixture", "entryType": "function", "description": "Creates an instance of the given harness type, using the fixture's root element as the\nharness's host element. This method should be used when creating a harness for the root element\nof a fixture, as components do not have the correct selector when they are created as the root\nof the fixture.", "generics": [ { "name": "T", "constraint": "ComponentHarness" } ], "isNewType": false, "jsdocTags": [], "params": [ { "name": "fixture", "description": "", "type": "ComponentFixture<unknown>", "isOptional": false, "isRestParam": false }, { "name": "harnessType", "description": "", "type": "ComponentHarnessConstructor<T>", "isOptional": false, "isRestParam": false }, { "name": "options", "description": "", "type": "TestbedHarnessEnvironmentOptions | undefined", "isOptional": true, "isRestParam": false } ], "rawComment": "/**\n * Creates an instance of the given harness type, using the fixture's root element as the\n * harness's host element. This method should be used when creating a harness for the root element\n * of a fixture, as components do not have the correct selector when they are created as the root\n * of the fixture.\n */", "returnType": "Promise<T>" } ], "implementation": { "params": [ { "name": "fixture", "description": "", "type": "ComponentFixture<unknown>", "isOptional": false, "isRestParam": false }, { "name": "harnessType", "description": "", "type": "ComponentHarnessConstructor<T>", "isOptional": false, "isRestParam": false }, { "name": "options", "description": "", "type": "TestbedHarnessEnvironmentOptions | undefined", "isOptional": true, "isRestParam": false } ], "isNewType": false, "returnType": "Promise<T>", "generics": [ { "name": "T", "constraint": "ComponentHarness" } ], "name": "harnessForFixture", "description": "Creates an instance of the given harness type, using the fixture's root element as the\nharness's host element. This method should be used when creating a harness for the root element\nof a fixture, as components do not have the correct selector when they are created as the root\nof the fixture.", "entryType": "function", "jsdocTags": [], "rawComment": "/**\n * Creates an instance of the given harness type, using the fixture's root element as the\n * harness's host element. This method should be used when creating a harness for the root element\n * of a fixture, as components do not have the correct selector when they are created as the root\n * of the fixture.\n */" }, "entryType": "function", "description": "Creates an instance of the given harness type, using the fixture's root element as the\nharness's host element. This method should be used when creating a harness for the root element\nof a fixture, as components do not have the correct selector when they are created as the root\nof the fixture.", "jsdocTags": [], "rawComment": "/**\n * Creates an instance of the given harness type, using the fixture's root element as the\n * harness's host element. This method should be used when creating a harness for the root element\n * of a fixture, as components do not have the correct selector when they are created as the root\n * of the fixture.\n */", "memberType": "method", "memberTags": [ "static" ] } ], "generics": [], "description": "A `HarnessEnvironment` implementation for Angular's Testbed.", "jsdocTags": [], "rawComment": "/** A `HarnessEnvironment` implementation for Angular's Testbed. */", "extends": "HarnessEnvironment<Element>", "implements": [], "source": { "filePath": "/src/cdk/testing/testbed/testbed-harness-environment.ts", "startLine": 89, "endLine": 222 } }, { "name": "UnitTestElement", "isAbstract": false, "entryType": "undecorated_class", "members": [ { "name": "constructor", "signatures": [], "implementation": { "params": [ { "name": "element", "description": "", "type": "Element", "isOptional": false, "isRestParam": false }, { "name": "_stabilize", "description": "", "type": "() => Promise<void>", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "UnitTestElement", "generics": [], "name": "constructor", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "blur", "signatures": [ { "name": "blur", "entryType": "function", "description": "Blur the element.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "/** Blur the element. */", "returnType": "Promise<void>" } ], "implementation": { "params": [], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "blur", "description": "Blur the element.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Blur the element. */" }, "entryType": "function", "description": "Blur the element.", "jsdocTags": [], "rawComment": "/** Blur the element. */", "memberType": "method", "memberTags": [] }, { "name": "clear", "signatures": [ { "name": "clear", "entryType": "function", "description": "Clear the element's input (for input and textarea elements only).", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "/** Clear the element's input (for input and textarea elements only). */", "returnType": "Promise<void>" } ], "implementation": { "params": [], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "clear", "description": "Clear the element's input (for input and textarea elements only).", "entryType": "function", "jsdocTags": [], "rawComment": "/** Clear the element's input (for input and textarea elements only). */" }, "entryType": "function", "description": "Clear the element's input (for input and textarea elements only).", "jsdocTags": [], "rawComment": "/** Clear the element's input (for input and textarea elements only). */", "memberType": "method", "memberTags": [] }, { "name": "click", "signatures": [ { "name": "click", "entryType": "function", "description": "Click the element at the default location for the current environment. If you need to guarantee\nthe element is clicked at a specific location, consider using `click('center')` or\n`click(x, y)` instead.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "modifiers", "description": "", "type": "any", "isOptional": true, "isRestParam": false } ], "rawComment": "/**\n * Click the element at the default location for the current environment. If you need to guarantee\n * the element is clicked at a specific location, consider using `click('center')` or\n * `click(x, y)` instead.\n */", "returnType": "Promise<void>" }, { "name": "click", "entryType": "function", "description": "Click the element at the element's center.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "location", "description": "", "type": "\"center\"", "isOptional": false, "isRestParam": false }, { "name": "modifiers", "description": "", "type": "any", "isOptional": true, "isRestParam": false } ], "rawComment": "/** Click the element at the element's center. */", "returnType": "Promise<void>" }, { "name": "click", "entryType": "function", "description": "Click the element at the specified coordinates relative to the top-left of the element.", "generics": [], "isNewType": false, "jsdocTags": [ { "name": "param", "comment": "Coordinate within the element, along the X-axis at which to click." }, { "name": "param", "comment": "Coordinate within the element, along the Y-axis at which to click." }, { "name": "param", "comment": "Modifier keys held while clicking" } ], "params": [ { "name": "relativeX", "description": "Coordinate within the element, along the X-axis at which to click.", "type": "number", "isOptional": false, "isRestParam": false }, { "name": "relativeY", "description": "Coordinate within the element, along the Y-axis at which to click.", "type": "number", "isOptional": false, "isRestParam": false }, { "name": "modifiers", "description": "Modifier keys held while clicking", "type": "any", "isOptional": true, "isRestParam": false } ], "rawComment": "/**\n * Click the element at the specified coordinates relative to the top-left of the element.\n * @param relativeX Coordinate within the element, along the X-axis at which to click.\n * @param relativeY Coordinate within the element, along the Y-axis at which to click.\n * @param modifiers Modifier keys held while clicking\n */", "returnType": "Promise<void>" } ], "implementation": { "params": [ { "name": "args", "description": "", "type": "[any?] | [\"center\", any?] | [number, number, any?]", "isOptional": false, "isRestParam": true } ], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "click", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "rightClick", "signatures": [ { "name": "rightClick", "entryType": "function", "description": "Right clicks on the element at the specified coordinates relative to the top-left of it.", "generics": [], "isNewType": false, "jsdocTags": [ { "name": "param", "comment": "Coordinate within the element, along the X-axis at which to click." }, { "name": "param", "comment": "Coordinate within the element, along the Y-axis at which to click." }, { "name": "param", "comment": "Modifier keys held while clicking" } ], "params": [ { "name": "relativeX", "description": "Coordinate within the element, along the X-axis at which to click.", "type": "number", "isOptional": false, "isRestParam": false }, { "name": "relativeY", "description": "Coordinate within the element, along the Y-axis at which to click.", "type": "number", "isOptional": false, "isRestParam": false }, { "name": "modifiers", "description": "Modifier keys held while clicking", "type": "any", "isOptional": true, "isRestParam": false } ], "rawComment": "/**\n * Right clicks on the element at the specified coordinates relative to the top-left of it.\n * @param relativeX Coordinate within the element, along the X-axis at which to click.\n * @param relativeY Coordinate within the element, along the Y-axis at which to click.\n * @param modifiers Modifier keys held while clicking\n */", "returnType": "Promise<void>" } ], "implementation": { "params": [ { "name": "args", "description": "", "type": "[any?] | [\"center\", any?] | [number, number, any?]", "isOptional": false, "isRestParam": true } ], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "rightClick", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "focus", "signatures": [ { "name": "focus", "entryType": "function", "description": "Focus the element.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "/** Focus the element. */", "returnType": "Promise<void>" } ], "implementation": { "params": [], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "focus", "description": "Focus the element.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Focus the element. */" }, "entryType": "function", "description": "Focus the element.", "jsdocTags": [], "rawComment": "/** Focus the element. */", "memberType": "method", "memberTags": [] }, { "name": "getCssValue", "signatures": [ { "name": "getCssValue", "entryType": "function", "description": "Get the computed value of the given CSS property for the element.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "property", "description": "", "type": "string", "isOptional": false, "isRestParam": false } ], "rawComment": "/** Get the computed value of the given CSS property for the element. */", "returnType": "Promise<string>" } ], "implementation": { "params": [ { "name": "property", "description": "", "type": "string", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "Promise<string>", "generics": [], "name": "getCssValue", "description": "Get the computed value of the given CSS property for the element.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Get the computed value of the given CSS property for the element. */" }, "entryType": "function", "description": "Get the computed value of the given CSS property for the element.", "jsdocTags": [], "rawComment": "/** Get the computed value of the given CSS property for the element. */", "memberType": "method", "memberTags": [] }, { "name": "hover", "signatures": [ { "name": "hover", "entryType": "function", "description": "Hovers the mouse over the element.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "/** Hovers the mouse over the element. */", "returnType": "Promise<void>" } ], "implementation": { "params": [], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "hover", "description": "Hovers the mouse over the element.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Hovers the mouse over the element. */" }, "entryType": "function", "description": "Hovers the mouse over the element.", "jsdocTags": [], "rawComment": "/** Hovers the mouse over the element. */", "memberType": "method", "memberTags": [] }, { "name": "mouseAway", "signatures": [ { "name": "mouseAway", "entryType": "function", "description": "Moves the mouse away from the element.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [], "rawComment": "/** Moves the mouse away from the element. */", "returnType": "Promise<void>" } ], "implementation": { "params": [], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "mouseAway", "description": "Moves the mouse away from the element.", "entryType": "function", "jsdocTags": [], "rawComment": "/** Moves the mouse away from the element. */" }, "entryType": "function", "description": "Moves the mouse away from the element.", "jsdocTags": [], "rawComment": "/** Moves the mouse away from the element. */", "memberType": "method", "memberTags": [] }, { "name": "sendKeys", "signatures": [ { "name": "sendKeys", "entryType": "function", "description": "Sends the given string to the input as a series of key presses. Also fires input events\nand attempts to add the string to the Element's value. Note that this cannot\nreproduce native browser behavior for keyboard shortcuts such as Tab, Ctrl + A, etc.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "keys", "description": "", "type": "any[]", "isOptional": false, "isRestParam": true } ], "rawComment": "/**\n * Sends the given string to the input as a series of key presses. Also fires input events\n * and attempts to add the string to the Element's value. Note that this cannot\n * reproduce native browser behavior for keyboard shortcuts such as Tab, Ctrl + A, etc.\n */", "returnType": "Promise<void>" }, { "name": "sendKeys", "entryType": "function", "description": "Sends the given string to the input as a series of key presses. Also fires input events\nand attempts to add the string to the Element's value.", "generics": [], "isNewType": false, "jsdocTags": [], "params": [ { "name": "modifiers", "description": "", "type": "ModifierKeys", "isOptional": false, "isRestParam": false }, { "name": "keys", "description": "", "type": "any[]", "isOptional": false, "isRestParam": true } ], "rawComment": "/**\n * Sends the given string to the input as a series of key presses. Also fires input events\n * and attempts to add the string to the Element's value.\n */", "returnType": "Promise<void>" } ], "implementation": { "params": [ { "name": "modifiersAndKeys", "description": "", "type": "any[]", "isOptional": false, "isRestParam": true } ], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "sendKeys", "description": "", "entryType": "function", "jsdocTags": [], "rawComment": "" }, "entryType": "function", "description": "", "jsdocTags": [], "rawComment": "", "memberType": "method", "memberTags": [] }, { "name": "text", "signatures": [ { "name": "text", "entryType": "function", "description": "Gets the text from the element.", "generics": [], "isNewType": false, "jsdocTags": [ { "name": "param", "comment": "Options that affect what text is included." } ], "params": [ { "name": "options", "description": "Options that affect what text is included.", "type": "any", "isOptional": true, "isRestParam": false } ], "rawComment": "/**\n * Gets the text from the element.\n * @param options Options that affect what text is included.\n */", "returnType": "Promise<string>" } ], "implementation": { "params": [ { "name": "options", "description": "Options that affect what text is included.", "type": "any", "isOptional": true, "isRestParam": false } ], "isNewType": false, "returnType": "Promise<string>", "generics": [], "name": "text", "description": "Gets the text from the element.", "entryType": "function", "jsdocTags": [ { "name": "param", "comment": "Options that affect what text is included." } ], "rawComment": "/**\n * Gets the text from the element.\n * @param options Options that affect what text is included.\n */" }, "entryType": "function", "description": "Gets the text from the element.", "jsdocTags": [ { "name": "param", "comment": "Options that affect what text is included." } ], "rawComment": "/**\n * Gets the text from the element.\n * @param options Options that affect what text is included.\n */", "memberType": "method", "memberTags": [] }, { "name": "setContenteditableValue", "signatures": [ { "name": "setContenteditableValue", "entryType": "function", "description": "Sets the value of a `contenteditable` element.", "generics": [], "isNewType": false, "jsdocTags": [ { "name": "param", "comment": "Value to be set on the element." } ], "params": [ { "name": "value", "description": "Value to be set on the element.", "type": "string", "isOptional": false, "isRestParam": false } ], "rawComment": "/**\n * Sets the value of a `contenteditable` element.\n * @param value Value to be set on the element.\n */", "returnType": "Promise<void>" } ], "implementation": { "params": [ { "name": "value", "description": "Value to be set on the element.", "type": "string", "isOptional": false, "isRestParam": false } ], "isNewType": false, "returnType": "Promise<void>", "generics": [], "name": "setContenteditableValue", "description": "Sets the value of a `contenteditable` element.", "entryType": "function", "jsdocTags": [ { "name": "param", "comment": "Value to be set on the element." } ], "rawComment": "/**\n * Sets the value of a `contenteditable` element.\n * @param value Value to be set on the element.\n */" }, "entryType": "function", "description