Class RecipeScraper

Recipe scraper class providing access to recipe scraping.

This class wraps the platform-specific implementation and provides type-safe result handling. Supported on Android, iOS, and Web.

Index

Constructors

constructor

Methods

scrapeRecipe scrapeRecipeFromHtml getSupportedHosts isHostSupported scrapeRecipeAuthenticated getSupportedAuthHosts detectAuthRequired authErrorResult errorResult exceptionError isPythonReady waitForReady

Constructors

constructor

new RecipeScraper(): RecipeScraper
Returns RecipeScraper

Methods

scrapeRecipe

scrapeRecipe(url: string, options?: ScrapeOptions): Promise<ScraperResult>
Scrapes a recipe from a URL.
Parameters
- url: string
  The recipe page URL to scrape.
- Optionaloptions: ScrapeOptions
  Optional scraping options.
Returns Promise<ScraperResult>
A result object with either the scraped recipe data or an error.
Example
```
const result = await scraper.scrapeRecipe('https://allrecipes.com/recipe/...');
if (result.success) {
  console.log(result.data.title);
  console.log(result.data.ingredients);
} else {
  console.error(result.error.message);
}
```
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:129

scrapeRecipeFromHtml

scrapeRecipeFromHtml(
    html: string,
    url: string,
    options?: ScrapeOptions,
): Promise<ScraperResult>
Scrapes a recipe from HTML content.

Useful when you've already fetched the HTML yourself and want to avoid an additional network request.
Parameters
- html: string
  The HTML content of the recipe page.
- url: string
  The original URL (used for host detection and relative URLs).
- Optionaloptions: ScrapeOptions
  Optional scraping options.
Returns Promise<ScraperResult>
A result object with either the scraped recipe data or an error.
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:173

getSupportedHosts

getSupportedHosts(): Promise<SupportedHostsResult>
Gets a list of all supported recipe website hosts.

Note: On iOS and Web, this returns an empty array as they use generic schema.org parsing.

Returns Promise<SupportedHostsResult>
A result object with an array of supported host domains.
Example
```
const result = await scraper.getSupportedHosts();
if (result.success) {
  console.log(`Supported: ${result.data.length} sites`);
}
```
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:240

isHostSupported

isHostSupported(host: string): Promise<HostSupportedResult>
Checks if a specific host is in the supported list.

Note: Even if a host is not in the supported list, scraping may still work if the site uses schema.org recipe markup. On iOS and Web, this always returns false as they use generic schema.org parsing.
Parameters
- host: string
  Domain to check (e.g., "allrecipes.com").
Returns Promise<HostSupportedResult>
A result object with a boolean indicating support.
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:272

scrapeRecipeAuthenticated

scrapeRecipeAuthenticated(
    url: string,
    username: string,
    password: string,
    options?: ScrapeOptions,
): Promise<ScraperResult>
Scrapes a recipe from an authentication-protected URL.

Logs into the site using provided credentials and scrapes the recipe.
- Android: Uses Python requests.Session via Chaquopy.
- iOS: Navigates a hidden WKWebView to the login page, then injects a same-origin JavaScript script that performs the full auth flow using WebKit's own cookie jar (WKHTTPCookieStore). The fetched recipe HTML is then parsed by Pyodide. Returns an error on unsupported platforms or unsupported auth hosts.
Parameters
- url: string
  The recipe page URL to scrape.
- username: string
  Username/email for authentication.
- password: string
  Password for authentication.
- Optionaloptions: ScrapeOptions
  Optional scraping options.
Returns Promise<ScraperResult>
A result object with either the scraped recipe data or an error.
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:311

getSupportedAuthHosts

getSupportedAuthHosts(): Promise<SupportedHostsResult>
Gets a list of hosts that support authentication.

Available on Android (via Chaquopy) and iOS (via Pyodide WebView). Returns an empty array on unsupported platforms.

Returns Promise<SupportedHostsResult>
A result object with an array of host domains supporting auth.
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:377

`Private`detectAuthRequired

detectAuthRequired(
    html: string,
    finalUrl: string,
    originalUrl: string,
): null | ScraperErrorResult
Detect if a page requires authentication. Checks for login URL patterns and page title keywords.
Parameters
- html: string
- finalUrl: string
- originalUrl: string
Returns null | ScraperErrorResult
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:398

`Private`authErrorResult

authErrorResult(host: string): ScraperErrorResult
Parameters
- host: string
Returns ScraperErrorResult
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:429

`Private`errorResult

errorResult(type: string, message: string): ScraperErrorResult
Parameters
- type: string
- message: string
Returns ScraperErrorResult
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:440

`Private`exceptionError

exceptionError(error: unknown): ScraperErrorResult
Parameters
- error: unknown
Returns ScraperErrorResult
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:447

isPythonReady

isPythonReady(): Promise<boolean>
Checks if the Python runtime is ready for scraping.

On Android, returns true once Chaquopy Python has finished initializing. On iOS, returns true once Pyodide WebView has finished loading. On Web, this always returns true (no Python needed).

Returns Promise<boolean>
true if ready, false if still initializing.
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:466

waitForReady

waitForReady(timeoutMs?: number, pollIntervalMs?: number): Promise<boolean>
Waits for Python to be ready for scraping.

Call this during app initialization to ensure Python is loaded before allowing users to access web parsing features.
Parameters
- timeoutMs: number = 30000
  Maximum time to wait (default: 30000ms)
- pollIntervalMs: number = 100
  Time between checks (default: 100ms)
Returns Promise<boolean>
true if ready, false if timeout reached
- Defined in modules/recipe-scraper/src/RecipeScraper.ts:493

Class RecipeScraper

Index

Constructors

Methods

Constructors

constructor

Returns RecipeScraper

Methods

scrapeRecipe

Parameters

Returns Promise<ScraperResult>

Example

scrapeRecipeFromHtml

Parameters

Returns Promise<ScraperResult>

getSupportedHosts

Returns Promise<SupportedHostsResult>

Example

isHostSupported

Parameters

Returns Promise<HostSupportedResult>

scrapeRecipeAuthenticated

Parameters

Returns Promise<ScraperResult>

getSupportedAuthHosts

Returns Promise<SupportedHostsResult>

PrivatedetectAuthRequired

Parameters

Returns null | ScraperErrorResult

PrivateauthErrorResult

Parameters

Returns ScraperErrorResult

PrivateerrorResult

Parameters

Returns ScraperErrorResult

PrivateexceptionError

Parameters

Returns ScraperErrorResult

isPythonReady

Returns Promise<boolean>

waitForReady

Parameters

Returns Promise<boolean>

`Private`detectAuthRequired

`Private`authErrorResult

`Private`errorResult

`Private`exceptionError