Preparing search index...

modules/recipe-scraper/src/types
ScraperSuccessResult

Interface ScraperSuccessResult<T>

Successful scrape result containing recipe data.

interface ScraperSuccessResult<T = ScrapedRecipe> {
success: true;
data: T;
}

Type Parameters

T = ScrapedRecipe

Defined in modules/recipe-scraper/src/types.ts:161

Index

Properties

success data

Properties

success

success: true

Defined in modules/recipe-scraper/src/types.ts:162

data

data: T

Defined in modules/recipe-scraper/src/types.ts:163

Settings

Member Visibility

ProtectedPrivateInheritedExternal

Theme

On This Page

Properties

success data

GitHub

modules/recipe-scraper/src

RecipeScraper

ScrapeOptions RecipeScraper recipeScraper usePythonReady

RecipeScraperModule

default

enhancements

EnhancementContext applyEnhancements extractKeywordsFromNextData findTagsInDict isUserFacingTag cleanTitle cleanDescription cleanKeywords extractStructuredIngredients parseKitchenItem splitQuantityUnit cleanIngredientName extractStructuredInstructions inferServingSizeFromHtml findAllKcalInHtml findPer100gCalories extractKcalFromSection extractNumericValue extractImageFromJsonLd

ios

AuthBridge

AuthWebView.ios

AuthWebView

PyodideBridge

PyodideMessageHandler PyodideBridge

PyodideWebView.ios

PyodideWebView

scraperCode

SCRAPER_PYTHON_CODE

ios

types

ScrapedNutrients IngredientGroup ParsedIngredient RecipeLink ParsedInstruction ScrapedRecipe ScraperError ScraperErrorTypes ScraperErrorType AuthenticationRequiredError SiteCredentials ScraperSuccessResult ScraperErrorResult ScraperResult SupportedHostsResult HostSupportedResult

urlUtils

extractHost

web/SchemaRecipeParser

SchemaRecipeParser

src

assets

Icons

dictionaryIcons iconsSize Icons IconName

datasets

ingredients

englishIngredients

recipes

englishRecipes

tags

performanceTags

components

atomic

BottomActionButton

BottomActionButtonProps BottomActionButton

CustomImage

CustomImageProps CustomImage

CustomTextInput

CustomTextInputProps CustomTextInput

NumericTextInput

NumericTextInputProps NumericTextInput

RoundButton

RoundButtonProps RoundButton

SquareButton

propIsRecipe propIsImg SquareButtonProps SquareButton

TagButton

TagButtonProps TagButton

WrappableButton

WrappableButtonProps WrappableButton

dialogs

Alert

AlertProps Alert

AuthenticationDialog

AuthenticationDialogProps AuthenticationDialog

ConfirmationDialog

ConfirmationDialogProps ConfirmationDialog

DatabasePickerDialog

DatabasePickerDialogProps DatabasePickerDialog

ItemDialog

DialogMode ItemIngredientType ItemTagType ItemDialogProps ItemDialog

LoadingOverlay

LoadingOverlayProps LoadingOverlay

NoteEditDialog

NoteEditDialogProps NoteEditDialog

SimilarityDialog

UrlInputDialog

UrlInputDialogProps UrlInputDialog

molecules

Carousel

CarouselItemProps Carousel

DiscoveryFooter

DiscoveryFooterProps DiscoveryFooter

DiscoveryHeader

DiscoveryHeaderProps DiscoveryHeader

HorizontalList

TagProp ImageProp HorizontalListProps HorizontalList

ImageThumbnail

ImageThumbnailProps ImageThumbnail

ImportErrorMessage

ImportErrorMessageProps ImportErrorMessage

ImportSuccessMessage

ImportSuccessMessageProps ImportSuccessMessage

MenuRecipeCard

MenuRecipeCardProps MenuRecipeCard

NutritionEditForm

NutritionEditFormProps NutritionEditForm

NutritionEmptyState

NutritionEmptyStateProps NutritionEmptyState

NutritionRow

NutritionRowProps NutritionRow

NutritionTable

NutritionTableProps NutritionTable

ProviderListItem

ProviderListItemProps ProviderListItem

ProviderLogo

ProviderLogoProps ProviderLogo

RecipeCard

RecipeCardProps RecipeCard

RecipeSelectionCard

RecipeSelectionCardProps RecipeSelectionCard

RecipeSourceUrl

RecipeSourceUrlProps RecipeSourceUrl

SeasonalityCalendar

SeasonalityCalendarProps SeasonalityCalendar

SelectAllRow

SelectAllRowProps SelectAllRow

SelectableAccordion

SelectableItem SelectableAccordionProps SelectableAccordion

SettingsItemCard

SettingsItem SettingsItemCardProps SettingsItemCard

TextInputWithDropDown

TextInputWithDropDownType TextInputWithDropDown

TutorialStepNumber

TutorialTooltip

organisms

AppBar

AppBarProps AppBar

AppWrapper

default

FilterAccordion

FilterAccordionProps FilterAccordion

FiltersSelection

FiltersSelectionProps FiltersSelection

RecipeImage

RecipeImageProps RecipeImage

RecipeIngredients

BaseProps ReadOnlyProps EditableBaseProps EditableProps AddProps RecipeIngredientsProps RecipeIngredients

RecipeNumber

RecipeNumberAddProps RecipeNumberEditProps RecipeNumberAddOrEditProps RecipeNumberReadOnlyProps RecipeNumberReadAddOrEditProps RecipeNumberProps RecipeNumber

RecipeNutrition

RecipeNutritionProps RecipeNutrition

RecipePreparation

BaseProps ReadOnlyProps EditableBaseProps EditableProps AddProps RecipePreparationProps RecipePreparation

RecipeRecommendation

RecipeRecommendationProps RecipeRecommendation

RecipeTags

RecipeTagsEditProps RecipeTagsAddProps RecipeTagsAddOrEditProps RecipeTagsReadOnlyProps RecipeTagProps RecipeTags

RecipeText

TextProp RecipeTextAddProps RecipeTextEditProps RecipeTextAddOrEditProps RecipeTextProps RecipeText

SearchBar

SearchBarHandle SearchBarProps SearchBar

SearchBarResults

SearchBarResultsProps SearchBarResults

SettingsItemList

SettingsItemListProps SettingsItemList

TutorialController

TutorialProviderProps TutorialProvider

VerticalBottomButtons

default

context

DarkModeContext

ParametersContextType DarkModeContext

DefaultPersonsContext

DefaultPersonsContextType useDefaultPersons DefaultPersonsProvider

RecipeDatabaseContext

RecipeDatabaseContextType RecipeDatabaseProvider useRecipeDatabase

SeasonFilterContext

SeasonFilterContextType useSeasonFilter SeasonFilterProvider

customTypes

BulkImportTypes

RecipeProvider DiscoveryOptions DiscoveryProgress ParsingProgress ImportMemoryStatus DiscoveredRecipe FullyDiscoveredRecipe FailedDiscoveryRecipe FetchedRecipe ConvertedImportRecipe IngredientMapping TagMapping BatchValidationState ImportProgress ValidatedRecipe DiscoveryListHeaderItem DiscoveryListRecipeItem DiscoveryListItem

DatabaseElementTypes

recipeDatabaseName recipeTableName ingredientsTableName tagTableName encodedType databaseColumnType recipeColumnsNames recipeTableElement encodedRecipeElement recipeColumnsEncoding ingredientTableElement FormIngredientElement coreIngredientElement encodedIngredientElement ingredientsColumnsNames ingredientColumnsEncoding nutritionTableElement preparationStepElement tagTableElement tagsColumnsNames tagColumnsEncoding encodedTagElement importHistoryTableName importHistoryTableElement encodedImportHistoryElement importHistoryColumnsNames importHistoryColumnsEncoding menuTableName menuTableElement encodedMenuElement menuColumnsNames menuColumnsEncoding purchasedIngredientsTableName purchasedIngredientElement encodedPurchasedIngredientElement purchasedIngredientsColumnsNames purchasedIngredientsColumnsEncoding ComputedShoppingItem arrayOfType extractIngredientsNameWithQuantity extractTagsName isRecipePartiallyEqual isRecipeEqual isIngredientEqual isTagEqual assertIngredientType ingredientType

OCRTypes

nutritionObject ocrTranslations OcrKeys NutritionTerms per100gKey perPortionKey FUSE_THRESHOLD

RecipeFiltersTypes

currentMonth filtersAccessAndModifiers nonIngredientFilters listFilter TListFilter ShoppingAppliedToDatabase FiltersAppliedToDatabase propsForShopping TIngredientCategories prepTimeValues RecommendationType

ScreenTypes

recipeStateType StackScreenParamList TabScreenParamList Stack Tab StackScreenNavigation TabScreenNavigation HomeScreenProp SearchScreenProp MenuScreenProp ShoppingScreenProp ParametersScreenProp RecipeScreenProp LanguageSettingsProp DefaultPersonsSettingsProp IngredientsSettingProp TagsSettingsProp BugReportScreenProp

TutorialTypes

CopilotStepData

hooks

useCategories

useShoppingCategories useFiltersCategories

useRecipePreparation

UseRecipePreparationReturn useRecipePreparation

useRecipeScraper

ScrapeResult AuthRequirement UseRecipeScraperReturn useRecipeScraper

useSafeCopilot

navigation

BottomTabs

RootNavigator

screens

BugReport

BulkImportDiscovery

BulkImportSettings

BulkImportValidation

DefaultPersonsSettings

Home

howManyItemInCarousel Home

IngredientsSettings

LanguageSettings

ModalImageSelect

ModalImageSelectProps ModalImageSelect

Parameters

Shopping

TagsSettings

WelcomeScreen

WelcomeScreenProps WelcomeScreen

styles

buttons

smallCardWidth squareButtonStyles viewButtonStyles pressButtonStyle wrappingButtonWithPressed viewInsideButtonCentered

colors

colors palette cameraPalette

images

imageStyle

spacing

screenWidth screenHeight remValue padding cardSizes progressBarHeight dialogMaxHeight screenViews scrollView viewsSplitScreen

theme

lightTheme darkTheme

typography

textSeparator unitySeparator EncodingSeparator noteSeparator ALL_MONTHS ALL_MONTHS_ENCODED replaceAllBackToLine findAllNumbers allNonDigitCharacter numberAtFirstIndex containNumbers separateNumbersFromStr letterRegExp exceptLettersRegExp exceptLettersAndSpacesRegExp extractBetweenParenthesis startsWithLetter hasLettersInMiddle endsWithLetters onlyDigitsDotsSpaces useFetchFonts BottomScreenTitle typoSize typoRender bulletListDataType editableText typoStyles carouselStyle searchBarStyle rowTextStyle

translations

alerts

bugReport

bulkImport

common

filters

ingredientTypes

months

navigation

onboarding

parameters

recipe

seasons

shopping

alerts

bugReport

bulkImport

common

filters

ingredientTypes

months

navigation

onboarding

parameters

recipe

seasons

shopping

utils

BugReport

LOG_FILE buildEmailSubject buildEmailBody sendBugReport isMailAvailable pickScreenshots

Constants

defaultValueNumber TUTORIAL_DEMO_INTERVAL TUTORIAL_STEPS TUTORIAL_VERTICAL_OFFSET testRecipesImages productionRecipesImages

DatasetLoader

DatasetCollection DatasetType getDatasetType getDataset

FileGestion

extractFilenameFromUri constructImageUri clearCache deleteFile isTemporaryImageUri cleanupOrphanedImages downloadImageToCache saveRecipeImage init copyDatasetImages transformDatasetRecipeImages

FilterFunctions

selectFilterCategoriesValuesToDisplay extractFilteredRecipeDatas filterFromRecipe addValueToMultimap removeValueToMultimap editTitleInMultimap removeTitleInMultimap retrieveAllFilters isTheElementContainsTheFilter filterRecipesByCurrentSeason isRecipeInCurrentSeason fisherYatesShuffle getRandomRecipes generateHomeRecommendations

FuzzySearch

FuzzyMatchLevel cleanIngredientName FuzzySearchResult fuzzySearch

ImagePicker

pickImage cropImage takePhoto

OCR

personAndTimeObject keysPersonsAndTimeObject tagObject keysTagObject ingredientQuantityPerPersons ingredientObject keysIngredientObject WarningHandler recognizeText extractFieldFromImage parseIngredientsNoHeader

RecipeDatabase

RecipeScraper

isScraperSuccess SCRAPER_ERROR_I18N_KEYS DEFAULT_SCRAPER_ERROR_I18N_KEY

RecipeScraperConverter

getIgnoredPatterns ParsedIngredient ConvertedIngredients ScrapedRecipeResult IgnoredIngredientPatterns isUnparseableIngredient parseIngredientString convertIngredients parseServings convertTags removeNumberedPrefix convertPreparation convertNutrition cleanImageUrl convertScrapedRecipe

RecipeValidationHelpers

IngredientState TagWithSimilarity IngredientWithSimilarity mergeIngredient filterOutExistingTags removeIngredientByName removeTagByName replaceMatchingIngredients addOrMergeIngredientMatches replaceMatchingTags addNonDuplicateTags processTagsForValidation processIngredientsForValidation deduplicateIngredientsByName validateAndQueueTags validateAndQueueIngredients

TableManipulation

TypeCheckingFunctions

isString isNumber isArrayOfNumber isArrayOfString isArrayOfType isOfType hasAtLeastKeys hasSameKeysAs sumNumberInString subtractNumberInString

firstLaunch

isFirstLaunch markAsLaunched

i18n

SUPPORTED_LANGUAGES SupportedLanguage DEFAULT_LANGUAGE default useI18n

logger

databaseLogger fileSystemLogger ocrLogger scraperLogger scrapedRecipeLogger uiLogger homeLogger recipeLogger searchLogger shoppingLogger parametersLogger ingredientsSettingsLogger tagsSettingsLogger languageSettingsLogger defaultPersonsSettingsLogger settingsLogger validationLogger navigationLogger appLogger tutorialLogger bulkImportLogger bugReportLogger default

settings

SETTINGS_KEYS DEFAULT_SETTINGS getDarkMode setDarkMode getDefaultPersons setDefaultPersons getSeasonFilter setSeasonFilter toggleSeasonFilter getLanguage setLanguage initSettings

components

dialogs/ValidationQueue

ValidationQueuePropsBase TagValidationProps IngredientValidationProps ValidationQueueProps ValidationQueue

molecules

RecipeCardSkeleton

RecipeCardSkeletonProps RecipeCardSkeleton

RecipeParsingProgress

RecipeParsingProgressProps RecipeParsingProgress

ValidationProgress

TagValidationProgressProps IngredientValidationProgressProps ValidationProgressProps ValidationProgress

context

RecipeDialogsContext

ValidationDialogProps SimilarityDialogState RecipeDialogsContextType RecipeDialogsProvider useRecipeDialogs

RecipeFormContext

RecipeFormState RecipeFormSetters RecipeFormActions RecipeFormContextType RecipeFormProviderProps RecipeFormProvider useRecipeForm

customTypes/RecipeNavigationTypes

RecipeMode BaseRecipeProp ReadRecipeProp EditRecipeProp AddManuallyProp AddFromPicProp ScrapedRecipeData AddFromScrapeProp RecipePropType

hooks

useDiscoveryWorkflow

DiscoveryPhase UseDiscoveryWorkflowReturn useDiscoveryWorkflow

useImportMemory

UseImportMemoryReturn useImportMemory

useRecipeIngredients

parseIngredientString formatIngredientString UseRecipeIngredientsReturn useRecipeIngredients

useRecipeTags

UseRecipeTagsReturn useRecipeTags

useValidationWorkflow

ValidationPhase InitializationStage ValidationHandlers ValidationProgress UseValidationWorkflowReturn useValidationWorkflow

useVisibleImageLoader

UseVisibleImageLoaderOptions UseVisibleImageLoaderReturn useVisibleImageLoader

useRecipeOCR

UseRecipeOCRReturn useRecipeOCR

useRecipeScraperValidation

providers

BaseRecipeProvider

DiscoveryState CategoryResult RecipePreviewMetadata BaseRecipeProvider

HelloFreshProvider

HelloFreshProvider helloFreshProvider

ProviderRegistry

getProvider getAvailableProviders hasProvider findProviderForUrl findProviderById

QuitoqueProvider

QuitoqueProvider quitoqueProvider

screens/Recipe

Recipe

utils

BatchValidation

collectUniqueItems initializeBatchValidation addIngredientMapping addTagMapping applyMappingsToRecipes getValidationProgress

BulkImportUtils

VisibleBounds BufferBounds computeVisibleBounds computeBufferBounds getBufferRecipesNeedingFetch buildFetchQueue cancelOutOfBoundsFetches buildDiscoveryListData

ImageRepair

repairMissingRecipeImages

UrlHelpers

isPlaceholderImageUrl isValidUrl normalizeUrl fetchHtml extractImageFromJsonLd

NutritionUtils

normalizeKey kcalToKj extractNumericValue extractFirstInteger isAllDigits namesMatch

Quantity

scaleQuantityForPersons formatQuantityForDisplay calculateNutritionPerPortion parseIngredientQuantity formatIngredientForCallback

RecipeFormHelpers

ModeConfig IMAGE_BUTTON_CONFIG TITLE_STYLE_CONFIG INGREDIENT_MODE_CONFIG PREPARATION_MODE_CONFIG convertModeFromProps hasRecipeFromProps hasScrapedDataFromProps RecipeValidationData validateRecipeData scaleRecipeForSave buildRecipeImageProps buildRecipeTitleProps buildRecipeDescriptionProps buildRecipeTagsProps buildRecipePersonsProps buildRecipeTimeProps buildRecipeIngredientsProps buildRecipePreparationProps buildRecipeNutritionProps getValidationButtonConfig getMissingFieldsErrorContent buildRecipeSourceUrlProps