Class HelloFreshProvider

HelloFresh recipe provider implementation

Extends BaseRecipeProvider with HelloFresh-specific URL patterns, category discovery, and ingredient filtering for French/English recipes.

Hierarchy (View Summary)

BaseRecipeProvider
- HelloFreshProvider

Index

Constructors

constructor

new HelloFreshProvider(): HelloFreshProvider
Returns HelloFreshProvider
Inherited from BaseRecipeProvider.constructor

Properties

`Readonly`id

id: "hellofresh" = 'hellofresh'

Unique provider identifier

`Readonly`name

name: "HelloFresh" = 'HelloFresh'

Display name for the provider

`Readonly`logoUrl

logoUrl: "https://media.hellofresh.com/w_256,q_100,f_auto,c_limit,fl_lossy/hellofresh_website/logo/Hello_Fresh_Lockup.png" = HELLOFRESH_LOGO_URL

URL to the HelloFresh logo

`Private`currentBaseUrl

currentBaseUrl: null | string = null

Current base URL for the active discovery session

Methods

discoverRecipeUrls

discoverRecipeUrls(
options?: DiscoveryOptions,
): AsyncGenerator<DiscoveryProgress>
Discovers recipe URLs from the provider with streaming progress

Scans category pages in batches and yields progress updates as recipes are found. Automatically retries pages that appear rate-limited.
Parameters
- options: DiscoveryOptions = {}
  Discovery options including abort signal and max recipes
Returns AsyncGenerator<DiscoveryProgress>
Yields
Progress updates with discovered recipes
Inherited from BaseRecipeProvider.discoverRecipeUrls
- Defined in src/providers/BaseRecipeProvider.ts:154

parseSelectedRecipes

parseSelectedRecipes(
selectedRecipes: DiscoveredRecipe[],
options?: DiscoveryOptions,
): AsyncGenerator<ParsingProgress>
Parses selected recipes to extract full recipe data

Fetches and parses each selected recipe, downloading images to cache and converting to the app's internal format. Yields progress updates for UI feedback during the parsing process.
Parameters
- selectedRecipes: DiscoveredRecipe[]
  Recipes selected by the user for import
- options: DiscoveryOptions = {}
  Parsing options including abort signal and default persons
Returns AsyncGenerator<ParsingProgress>
Yields
Progress updates with parsed and failed recipes
Inherited from BaseRecipeProvider.parseSelectedRecipes
- Defined in src/providers/BaseRecipeProvider.ts:192

fetchRecipe

fetchRecipe(
    url: string,
    defaultPersons: number,
    ignoredPatterns: IgnoredIngredientPatterns,
    signal?: AbortSignal,
): Promise<FetchedRecipe>
Fetches and parses a single recipe from its URL
Parameters
- url: string
  URL of the recipe page to fetch
- defaultPersons: number
  Default serving size if not specified in recipe
- ignoredPatterns: IgnoredIngredientPatterns
  Patterns for ingredients to skip during parsing
- Optionalsignal: AbortSignal
  Optional abort signal for cancellation
Returns Promise<FetchedRecipe>
Promise resolving to the fetched and converted recipe

Throws
Error if recipe cannot be parsed
Inherited from BaseRecipeProvider.fetchRecipe
- Defined in src/providers/BaseRecipeProvider.ts:340

getPlaceholderImageUrl

getPlaceholderImageUrl(): null | string
Returns the URL of the known placeholder image for this provider, if any

Used by ImageRepair to detect recipes stored with placeholder content by comparing MD5 hashes of local files against the placeholder.

Returns null | string
The placeholder image URL, or null if this provider has no known placeholder
Inherited from BaseRecipeProvider.getPlaceholderImageUrl
- Defined in src/providers/BaseRecipeProvider.ts:393

fetchImageUrlForRecipe

fetchImageUrlForRecipe(url: string, signal: AbortSignal): Promise<null | string>
Fetches just the image URL for a recipe page on-demand

Used for visibility-based lazy loading of images. Fetches the recipe page HTML and extracts the image URL from JSON-LD schema data.
Parameters
- url: string
  Recipe page URL to fetch image for
- signal: AbortSignal
  Abort signal for cancellation
Returns Promise<null | string>
Promise resolving to image URL or null if not found/failed
Inherited from BaseRecipeProvider.fetchImageUrlForRecipe
- Defined in src/providers/BaseRecipeProvider.ts:420

`Protected`fetchHtml

fetchHtml(url: string, signal?: AbortSignal): Promise<string>
Fetches HTML content from a URL with timeout handling
Parameters
- url: string
  URL to fetch
- Optionalsignal: AbortSignal
  Optional abort signal for cancellation
Returns Promise<string>
Promise resolving to the HTML content

Throws
Error if request fails or times out
Inherited from BaseRecipeProvider.fetchHtml
- Defined in src/providers/BaseRecipeProvider.ts:438

`Protected`extractPreviewMetadata

extractPreviewMetadata(
html: string,
url: string,
): Promise<RecipePreviewMetadata>
Extracts preview metadata from HTML for display before full parsing
Parameters
- html: string
  Raw HTML content
- url: string
  Recipe page URL for host detection
Returns Promise<RecipePreviewMetadata>
Promise resolving to preview metadata with title and image URL
Inherited from BaseRecipeProvider.extractPreviewMetadata
- Defined in src/providers/BaseRecipeProvider.ts:474

`Protected`delay

delay(ms: number): Promise<void>
Delays execution for rate limiting
Parameters
- ms: number
  Milliseconds to delay
Returns Promise<void>
Promise that resolves after the delay
Inherited from BaseRecipeProvider.delay
- Defined in src/providers/BaseRecipeProvider.ts:494

canHandleUrl

canHandleUrl(url: string): boolean
Returns true if this provider can handle the given URL
Parameters
- url: string
  Recipe source URL to test
Returns boolean
true if the URL starts with the HelloFresh base URL (any region)
Overrides BaseRecipeProvider.canHandleUrl
- Defined in src/providers/HelloFreshProvider.ts:70

getBaseUrl

getBaseUrl(): Promise<string>
Gets the base URL for the user's regional HelloFresh site

Always fetches the current language setting to ensure the correct regional site is used even if the user changed language settings.

Returns Promise<string>
Promise resolving to the regional HelloFresh URL

Throws
Error if the user's language is not supported by HelloFresh
Overrides BaseRecipeProvider.getBaseUrl
- Defined in src/providers/HelloFreshProvider.ts:83

discoverCategoryUrls

discoverCategoryUrls(baseUrl: string, signal?: AbortSignal): Promise<string[]>
Discovers recipe category URLs from the HelloFresh recipes page

Fetches the main recipes page and extracts all category links, filtering out individual recipe pages.
Parameters
- baseUrl: string
  The regional HelloFresh base URL
- Optionalsignal: AbortSignal
  Optional abort signal for cancellation
Returns Promise<string[]>
Promise resolving to array of category page URLs
Overrides BaseRecipeProvider.discoverCategoryUrls
- Defined in src/providers/HelloFreshProvider.ts:111

extractRecipeLinksFromHtml

extractRecipeLinksFromHtml(
html: string,
): { url: string; title?: string; imageUrl?: string }[]
Extracts recipe links from HTML content

Parses HTML to find recipe URLs matching the HelloFresh pattern (URLs ending with 24-character hex IDs). Extracts titles from URL slugs for immediate display.
Parameters
- html: string
  Raw HTML content to parse
Returns { url: string; title?: string; imageUrl?: string }[]
Array of recipe links with URLs and extracted titles
Overrides BaseRecipeProvider.extractRecipeLinksFromHtml
- Defined in src/providers/HelloFreshProvider.ts:144

`Private`extractCategoryLinksFromHtml

extractCategoryLinksFromHtml(html: string, baseUrl: string): string[]
Extracts category links from HTML content

Parses HTML to find category URLs matching the HelloFresh pattern, filtering out individual recipe pages (those ending with hex IDs).
Parameters
- html: string
  Raw HTML content to parse
- baseUrl: string
  Base URL for resolving relative links
Returns string[]
Array of unique category URLs
- Defined in src/providers/HelloFreshProvider.ts:179

`Private`extractTitleFromSlug

extractTitleFromSlug(url: string): string
Extracts a human-readable title from a recipe URL slug

Converts URL slugs like "chicken-tikka-masala-abc123" to readable titles like "Chicken tikka masala".
Parameters
- url: string
  Full recipe URL
Returns string
Formatted title with first letter capitalized
- Defined in src/providers/HelloFreshProvider.ts:210

Class HelloFreshProvider

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns HelloFreshProvider

Properties

Readonlyid

Readonlyname

ReadonlylogoUrl

PrivatecurrentBaseUrl

Methods

discoverRecipeUrls

Parameters

Returns AsyncGenerator<DiscoveryProgress>

Yields

parseSelectedRecipes

Parameters

Returns AsyncGenerator<ParsingProgress>

Yields

fetchRecipe

Parameters

Returns Promise<FetchedRecipe>

Throws

getPlaceholderImageUrl

Returns null | string

fetchImageUrlForRecipe

Parameters

Returns Promise<null | string>

ProtectedfetchHtml

Parameters

Returns Promise<string>

Throws

ProtectedextractPreviewMetadata

Parameters

Returns Promise<RecipePreviewMetadata>

Protecteddelay

Parameters

Returns Promise<void>

canHandleUrl

Parameters

Returns boolean

getBaseUrl

Returns Promise<string>

Throws

discoverCategoryUrls

Parameters

Returns Promise<string[]>

extractRecipeLinksFromHtml

Parameters

Returns { url: string; title?: string; imageUrl?: string }[]

PrivateextractCategoryLinksFromHtml

Parameters

Returns string[]

PrivateextractTitleFromSlug

Parameters

Returns string

`Readonly`id

`Readonly`name

`Readonly`logoUrl

`Private`currentBaseUrl

`Protected`fetchHtml

`Protected`extractPreviewMetadata

`Protected`delay

`Private`extractCategoryLinksFromHtml

`Private`extractTitleFromSlug