@entity-factory/core
Version:
Create entities on the fly for mocking and testing
32 lines (31 loc) • 1.96 kB
TypeScript
import { DeepEntityPartial } from '..';
import { Adapter } from '../adapters/Adapter';
import { AdapterBlueprintOptions } from '../adapters/AdapterBlueprintOptions';
import { EntityObjectType } from '../common/EntityObjectType';
import { BlueprintDefinitionAfterMethod } from './BlueprintDefinitionAfterMethod';
import { BlueprintDefinitionMethod } from './BlueprintDefinitionMethod';
import { BlueprintOptions } from './BlueprintOptions';
export declare class Blueprint<Entity = Record<string, any>, AdapterType extends Adapter = Adapter, Options extends AdapterBlueprintOptions = {}> {
private DEFAULT_KEY;
private entityType;
private blueprintOptions;
private readonly factoryMethods;
private readonly callbackMethods;
type(type: string | EntityObjectType<Entity>): void;
getType(): string | EntityObjectType<Entity>;
options(context: Options): void;
getOptions(): BlueprintOptions<Options>;
define(factory: BlueprintDefinitionMethod<Entity>): void;
state(state: string, factory: BlueprintDefinitionMethod<Entity> | DeepEntityPartial<Entity>): void;
afterMaking(callback: BlueprintDefinitionAfterMethod<Entity, AdapterType>): void;
afterMakingState(state: string, callback: BlueprintDefinitionAfterMethod<Entity, AdapterType>): void;
afterCreating(callback: BlueprintDefinitionAfterMethod<Entity, AdapterType>): void;
afterCreatingState(state: string, callback: BlueprintDefinitionAfterMethod<Entity, AdapterType>): void;
hasFactoryMethod(state?: string): boolean;
getFactoryMethod(state?: string): BlueprintDefinitionMethod<Entity>;
hasMakingCallbackMethod(state?: string): boolean;
getMakingCallbackMethod(state?: string): BlueprintDefinitionAfterMethod<Entity, AdapterType> | undefined;
hasCreatingCallbackMethod(state?: string): boolean;
getCreatingCallbackMethod(state?: string): BlueprintDefinitionAfterMethod<Entity, AdapterType> | undefined;
private getKey;
}