Skip to main content
Deprecated: This function is deprecated and will be removed in the future.
Extracts an array of structured data from a locator.
export declare function extractArrayFromLocator(
  locator: Locator,
  options: {
    label: string;
    itemEntityName: string;
    itemEntitySchema: SimpleArrayItemSchema;
    strategy?: ImageStrategy | HtmlStrategy;
    prompt?: string;
    optionalPropertiesInvalidator?: (
      result: Record<string, string>[]
    ) => string[];
    variantKey?: string;
    apiKey?: string;
  }
): Promise<Record<string, string>[]>;

Examples

import { extractArrayFromLocator } from "@intuned/browser/optimized-extractors";

await page.goto("https://books.toscrape.com/");
const books = await extractArrayFromLocator(page.locator("section"), {
  itemEntityName: "book",
  label: "books-extraction",
  itemEntitySchema: {
    type: "object",
    required: ["name"],
    properties: {
      name: {
        type: "string",
        description: "book name",
        primary: true,
      },
    },
  },
});

console.log(books);

// output:
// [
// ...
// { name: 'Olio' },
// { name: 'Mesaerion: The Best Science Fiction Stories 1800-1849' },
// { name: 'Libertarianism for Beginners' },
// { name: "It's Only the Himalayas" }
// ...
// ]

Arguments

locator
any
required
The Playwright Locator object from which to extract the data.
options
object
required

Returns: any

A promise that resolves to a list of extracted data.