faker-api/lib/src/transformers/list-transformer.d.ts

A fully customizible rest api faking package that allows you to mock , clone and fake Rest API with fake yet realistic data

import { Request } from "express";
import { Transformer } from ".";
import { AbstractModel } from "../";
import { ParamsType } from "../core/";
/**
 * A Transformer that can generate a list of a given model or another transformer
 */
declare class ListTransformer extends Transformer {
    /** The Model or Transformer the transformer will generate */
    protected model: AbstractModel | Transformer;
    /** The number of items the transformer should generate */
    protected count: number;
    /**
     * The constructor of ListTransformer
     * @param image The Model or transformer to apply the listTransformer
     * @param count The number of `image` item to generate in the array
     */
    constructor(model: AbstractModel | Transformer, count?: number);
    /**
     * Generates the data of the transform
     * @param request - An Express Request object of the current request
     * @param params - An Express response object for the current request
     * @returns - Returns an array of the `image`  with the length == the `count` property
     */
    transform(request?: Request, params?: ParamsType): any[];
}
export default ListTransformer;
//# sourceMappingURL=list-transformer.d.ts.map