graycoreio/daffodil

View on GitHub
libs/external-router/driver/testing/src/config.ts

Summary

Maintainability
A
0 mins
Test Coverage
import { createConfigInjectionToken } from '@daffodil/core';
import { DaffExternalRouteType } from '@daffodil/external-router';

/**
 * The configuration for the testing driver. It is a dictionary of "url": "type",
 * pairs, where the URL is a URL-safe routeable path, e.g. "sweatshirts" or "t-shirts"
 * and the type is a known type to your application, e.g. "CATEGORY".
 */
export interface DaffExternalRouterDriverTestingConfig {
  [url: string]: DaffExternalRouteType;
}

export const {
  /**
   * The token used by Daffodil to hold the driver's configuration.
   *
   * @docs-private
   */
  token: DAFF_EXTERNAL_ROUTER_DRIVER_TESTING_CONFIG,
  /**
   * Provider function for {@link DAFF_EXTERNAL_ROUTER_DRIVER_TESTING_CONFIG}.
   */
  provider: provideDaffExternalRouterDriverTestingConfig,
} = createConfigInjectionToken<DaffExternalRouterDriverTestingConfig>(({}), 'DAFF_EXTERNAL_ROUTER_DRIVER_TESTING_CONFIG');