Type Alias HydrateStaticState<TControllers, TSearchAction, TControllersProps, TControllersDefinitionsMap, TSolutionType>

Type Parameters

• TControllers extends ControllersMap
• TSearchAction extends UnknownAction
• TControllersProps extends ControllersPropsMap
• TControllersDefinitionsMap extends ControllerDefinitionsMap<Controller>
• TSolutionType extends SolutionType

• HydrateStaticState(
      ...params: OptionsTuple<
          HydrateStaticStateOptions<TSearchAction> & OptionalEngineDefinitionControllersPropsOption<
              TControllersDefinitionsMap,
              TControllersProps,
              TSolutionType,
          > & RequiredEngineDefinitionControllersPropsOption<
              TControllersDefinitionsMap,
              TControllersProps,
              TSolutionType,
          >,
      >,
  ): Promise<HydratedState<CommerceEngine, TControllers>>

  Creates a new engine from the snapshot of the engine created in SSR with fetchStaticState.

  Useful when hydrating a server-side-rendered engine.

  Parameters

  • ...params: OptionsTuple<
        HydrateStaticStateOptions<TSearchAction> & OptionalEngineDefinitionControllersPropsOption<
            TControllersDefinitionsMap,
            TControllersProps,
            TSolutionType,
        > & RequiredEngineDefinitionControllersPropsOption<
            TControllersDefinitionsMap,
            TControllersProps,
            TSolutionType,
        >,
    >

  Returns Promise<HydratedState<CommerceEngine, TControllers>>