@vendure/core
Version:
A modern, headless ecommerce framework
29 lines (28 loc) • 785 B
TypeScript
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 `entityOptions` property
* of {@link VendureConfig}.
*
* @example
* ```ts
* import { UuidIdStrategy, VendureConfig } from '\@vendure/core';
*
* export const config: VendureConfig = {
* entityOptions: {
* entityIdStrategy: new UuidIdStrategy(),
* // ...
* }
* }
* ```
*
* @docsCategory configuration
* @docsPage EntityIdStrategy
*/
export declare class UuidIdStrategy implements EntityIdStrategy<'uuid'> {
readonly primaryKeyType = "uuid";
decodeId(id: string): string;
encodeId(primaryKey: string): string;
}