Przeglądaj źródła

docs(core): Update jsdoc to address vendure-config/entityIdStrategy deprecation (#1348)

Josh McCulloch 4 lat temu
rodzic
commit
eb86dfd390

+ 6 - 3
packages/core/src/config/entity-id-strategy/uuid-id-strategy.ts

@@ -4,15 +4,18 @@ import { EntityIdStrategy } from './entity-id-strategy';
  * @description
  * An id strategy which uses string uuids as primary keys
  * for all entities. This strategy can be configured with the
- * `entityIdStrategy` property of the {@link VendureConfig}.
+ * `entityIdStrategy` property of the `entityOptions` property
+ * of {@link VendureConfig}.
  *
  * @example
  * ```TypeScript
  * import { UuidIdStrategy, VendureConfig } from '\@vendure/core';
  *
  * export const config: VendureConfig = {
- *   entityIdStrategy: new UuidIdStrategy(),
- *   // ...
+ *   entityOptions: {
+ *     entityIdStrategy: new UuidIdStrategy(),
+ *     // ...
+ *   }
  * }
  * ```
  *