graycoreio/daffodil

View on GitHub
libs/navigation/driver/magento/src/config/interface.ts

Summary

Maintainability
A
0 mins
Test Coverage

/**
 * An interface for providing @daffodil/search/state with necessary config values.
 */
export interface MagentoNavigationDriverConfig {
  /**
   * The maximum depth of category children that the navigation driver will query.
   * Defaults to 3.
   */
  navigationTreeQueryDepth: number;

  /**
   * The UID of the root category.
   * While this is optional, setting it will prevent an extra driver call during `getTree`.
   */
  rootCategoryId?: string;
}