extractObjectFromLocator

function extractObjectFromLocator(locator, options): Promise<Record<string, string | null> | null>

Extracts a structured object from a locator.

​

Examples

​

Parameters

• locator: Locator

The Playwright Locator object from which to extract the data.

• options

• options.entityName: string

The name of the entity being extracted. it must be between 1 and 50 characters long and can only contain letters, digits, periods, underscores, and hyphens.

• options.entitySchema: SimpleObjectSchema

The schema of the entity being extracted.

• options.label: string

A label for this extraction process, used for billing and monitoring.

• options.optionalPropertiesInvalidator?

Optional. A function to invalidate optional properties.

• options.prompt?: string

Optional. A prompt to guide the extraction process.

• options.strategy?: ImageStrategy | HtmlStrategy

Optional. The strategy to use for extraction, if not provided, the html strategy with claude haiku will be used.

• options.variantKey?: string

Optional. A variant key for the extraction process.

​

Returns

Promise<Record<string, string | null> | null>

A promise that resolves to the extracted object.