github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: mark Locator constructor as private (#10322)

Browse Source
This commit is contained in:
Alex Rudenko 2023-06-06 11:51:34 +02:00 committed by GitHub
parent 272f6c79f4
commit b81b019083
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 23 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/api/puppeteer.locator._constructor_.md
View File

@ -1,27 +0,0 @@
---
sidebar_label: Locator.(constructor)
---
# Locator.(constructor)
Constructs a new instance of the `Locator` class
#### Signature:
```typescript
class Locator {
constructor(
pageOrFrame: Page | Frame,
selector: string,
options?: LocatorOptions
);
}
```
## Parameters
| Parameter | Type | Description |
| ----------- | ------------------------------------------------------------ | ------------ |
| pageOrFrame | [Page](./puppeteer.page.md) \| [Frame](./puppeteer.frame.md) | |
| selector | string | |
| options | [LocatorOptions](./puppeteer.locatoroptions.md) | _(Optional)_ |

6
docs/api/puppeteer.locator.md
View File

@ -14,12 +14,6 @@ export declare class Locator extends EventEmitter
**Extends:** [EventEmitter](./puppeteer.eventemitter.md)
## Constructors
| Constructor | Modifiers | Description |
| ------------------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- |
| [(constructor)(pageOrFrame, selector, options)](./puppeteer.locator._constructor_.md) | | Constructs a new instance of the <code>Locator</code> class |
## Methods
| Method | Modifiers | Description |

2
packages/puppeteer-core/src/api/Frame.ts
View File

@ -356,7 +356,7 @@ export class Frame {
* change in the Locators API.
*/
locator(selector: string): Locator {
return new Locator(this, selector);
return Locator.create(this, selector);
}
/**

22
packages/puppeteer-core/src/api/Locator.ts
View File

@ -117,11 +117,31 @@ export interface LocatorEventObject {
* @public
*/
export class Locator extends EventEmitter {
/**
* @internal
*/
static create(
pageOrFrame: Page | Frame,
selector: string,
options: LocatorOptions = {
visibility: 'visible',
timeout:
'getDefaultTimeout' in pageOrFrame
? pageOrFrame.getDefaultTimeout()
: pageOrFrame.page().getDefaultTimeout(),
ensureElementIsInTheViewport: true,
waitForEnabled: true,
waitForStableBoundingBox: true,
}
): Locator {
return new Locator(pageOrFrame, selector, options);
}
#pageOrFrame: Page | Frame;
#selector: string;
#options: LocatorOptions;
constructor(
private constructor(
pageOrFrame: Page | Frame,
selector: string,
options: LocatorOptions = {

2
packages/puppeteer-core/src/api/Page.ts
View File

@ -827,7 +827,7 @@ export class Page extends EventEmitter {
* change in the Locators API.
*/
locator(selector: string): Locator {
return new Locator(this, selector);
return Locator.create(this, selector);
}
/**