index.d.ts

declare namespace jaymock {
    interface Template {
        [key: string]: string | number | Template;
    }
    interface Populated {
        [key: string]: unknown | Array<Populated> | Populated;
    }
}

declare function jaymock(): {
    /**
    Populates the template object with fake data.
    @param template - A [`template`](https://github.com/Meeshkan/jaymock#template) object to populate.
    @returns An `object` populated with fake data.
    */
    populate(template: jaymock.Template | object): jaymock.Populated;

    /**
    Adds a custom data generation function that can be called in the `populate` `template` object using the value of its `name`.
    @param name - A `string` used to refer to the `body` function.
    @param body - A `function` that can be referred to in the `template` object.
    */
    extend(name: string | {[key: string]: Function}, body?: Function): void;

    /**
    Sets `Faker.js`'s language locale.
    @param locale - `Faker.js` locale.
    */
    setFakerLocale(locale: string): void;

    /**
    Sets `Faker.js`'s randomness seed.
    @param seed - `Faker.js` randomness seed.
    */
    setFakerSeed(seed: number): void;
};

export = jaymock;