@mixtape/core/lib/builder.d.ts

Supercharged fixture library for organizing and generating test data

import { FixtureContext } from './fixture';
/**
 * Interface for a type builder
 * @interface
 */
export interface TypeBuilder<T> {
    type: string;
    aliases?: string[];
    build(context: FixtureContext): T;
}
/**
 * Abstract class implementing the `TypeBuilder` interface.
 * This implementation gives easy access to adding type aliases.
 * @abstract
 */
export declare abstract class Builder<T> implements TypeBuilder<T> {
    type: string;
    /**
     * All aliases for type
     */
    readonly aliases: string[];
    /**
     * Create a new `Builder`
     * @param type - name of the type that the builder can create
     */
    constructor(type: string);
    /**
     * Build new type
     * @abstract
     * @param context - context to use for generating data
     * @returns new type
     */
    abstract build(context: FixtureContext): T;
    /**
     * Register new alias for type, e.g. 'surname' and 'lastName'
     * @protected
     * @param alias - alias for type
     */
    protected createAlias(alias: string): void;
}