drizzle-seed 0.1.2 → 0.1.3-e14a5a2

package/services/GeneratorsWrappers.d.ts

@@ -8,8 +8,10 @@ export declare abstract class AbstractGenerator<T = {}> {
     uniqueVersionOfGen?: new (params: T) => AbstractGenerator<T>;
     dataType?: string;
     timeSpent?: number;
+    arraySize?: number;
+    baseColumnDataType?: string;
     constructor(params: T);
-    abstract init(params: {
+    init(params: {
         count: number | {
             weight: number;
             count: number | number[];
@@ -19,6 +21,27 @@ export declare abstract class AbstractGenerator<T = {}> {
     abstract generate(params: {
         i: number;
     }): number | string | boolean | unknown | undefined | void;
+    getEntityKind(): string;
+    replaceIfUnique({ count, seed }: {
+        count: number;
+        seed: number;
+    }): AbstractGenerator<T> | undefined;
+    replaceIfArray({ count, seed }: {
+        count: number;
+        seed: number;
+    }): GenerateArray | undefined;
+}
+export declare class GenerateArray extends AbstractGenerator<{
+    baseColumnGen: AbstractGenerator<any>;
+    size?: number;
+}> {
+    static readonly [entityKind]: string;
+    arraySize: number;
+    init({ count, seed }: {
+        count: number;
+        seed: number;
+    }): void;
+    generate(): unknown[];
 }
 export declare class GenerateWeightedCount extends AbstractGenerator<{}> {
     static readonly [entityKind]: string;
@@ -39,9 +62,9 @@ export declare class HollowGenerator extends AbstractGenerator<{}> {
 }
 export declare class GenerateDefault extends AbstractGenerator<{
     defaultValue: unknown;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
-    init(): void;
     generate(): unknown;
 }
 export declare class GenerateValuesFromArray extends AbstractGenerator<{
@@ -50,6 +73,7 @@ export declare class GenerateValuesFromArray extends AbstractGenerator<{
         values: (number | string | boolean | undefined)[];
     }[];
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     weightedCountSeed: number | undefined;
@@ -97,12 +121,14 @@ export declare class GenerateNumber extends AbstractGenerator<{
     maxValue?: number;
     precision?: number;
     isUnique?: boolean;
-} | undefined> {
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueNumber;
-    init({ seed }: {
+    init({ count, seed }: {
         seed: number;
+        count: number;
     }): void;
     generate(): number;
 }
@@ -111,7 +137,7 @@ export declare class GenerateUniqueNumber extends AbstractGenerator<{
     maxValue?: number;
     precision?: number;
     isUnique?: boolean;
-} | undefined> {
+}> {
     static readonly [entityKind]: string;
     private state;
     isUnique: boolean;
@@ -125,11 +151,12 @@ export declare class GenerateInt extends AbstractGenerator<{
     minValue?: number | bigint;
     maxValue?: number | bigint;
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueInt;
-    init({ seed }: {
+    init({ count, seed }: {
         count: number;
         seed: number;
     }): void;
@@ -160,10 +187,13 @@ export declare class GenerateUniqueInt extends AbstractGenerator<{
     generateNumber(currMinNumb: number, currMaxNumb: number, intervalsToAdd: number[][], intervalIdx: number): number;
     generateBigint(currMinNumb: bigint, currMaxNumb: bigint, intervalsToAdd: bigint[][], intervalIdx: number): bigint;
 }
-export declare class GenerateBoolean extends AbstractGenerator<{}> {
+export declare class GenerateBoolean extends AbstractGenerator<{
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): boolean;
@@ -171,18 +201,23 @@ export declare class GenerateBoolean extends AbstractGenerator<{}> {
 export declare class GenerateDate extends AbstractGenerator<{
     minDate?: string | Date;
     maxDate?: string | Date;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string | Date;
 }
-export declare class GenerateTime extends AbstractGenerator<{}> {
+export declare class GenerateTime extends AbstractGenerator<{
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string;
@@ -192,36 +227,48 @@ export declare class GenerateTimestampInt extends AbstractGenerator<{
 }> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): number;
 }
-export declare class GenerateTimestamp extends AbstractGenerator<{}> {
+export declare class GenerateTimestamp extends AbstractGenerator<{
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string | Date;
 }
-export declare class GenerateDatetime extends AbstractGenerator<{}> {
+export declare class GenerateDatetime extends AbstractGenerator<{
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string | Date;
 }
-export declare class GenerateYear extends AbstractGenerator<{}> {
+export declare class GenerateYear extends AbstractGenerator<{
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string;
 }
-export declare class GenerateJson extends AbstractGenerator<{}> {
+export declare class GenerateJson extends AbstractGenerator<{
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
     init({ count, seed }: {
@@ -261,11 +308,12 @@ export declare class GenerateEnum extends AbstractGenerator<{
 }
 export declare class GenerateInterval extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueInterval;
-    init({ seed }: {
+    init({ count, seed }: {
         count: number;
         seed: number;
     }): void;
@@ -276,6 +324,7 @@ export declare class GenerateUniqueInterval extends AbstractGenerator<{
 }> {
     static readonly [entityKind]: string;
     private state;
+    isUnique: boolean;
     init({ count, seed }: {
         count: number;
         seed: number;
@@ -284,11 +333,13 @@ export declare class GenerateUniqueInterval extends AbstractGenerator<{
 }
 export declare class GenerateString extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueString;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string;
@@ -306,14 +357,28 @@ export declare class GenerateUniqueString extends AbstractGenerator<{
         i: number;
     }): string;
 }
+export declare class GenerateUUID extends AbstractGenerator<{
+    arraySize?: number;
+}> {
+    static readonly [entityKind]: string;
+    isUnique: boolean;
+    private state;
+    init({ count, seed }: {
+        count: number;
+        seed: number;
+    }): void;
+    generate(): string;
+}
 export declare class GenerateFirstName extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     timeSpent: number;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueFirstName;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string;
@@ -332,11 +397,13 @@ export declare class GenerateUniqueFirstName extends AbstractGenerator<{
 }
 export declare class GenerateLastName extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueLastName;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string | undefined;
@@ -355,11 +422,13 @@ export declare class GenerateUniqueLastName extends AbstractGenerator<{
 }
 export declare class GenerateFullName extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueFullName;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string;
@@ -377,7 +446,9 @@ export declare class GenerateUniqueFullName extends AbstractGenerator<{
     }): void;
     generate(): string;
 }
-export declare class GenerateEmail extends AbstractGenerator<{}> {
+export declare class GenerateEmail extends AbstractGenerator<{
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
     timeSpent: number;
@@ -392,6 +463,7 @@ export declare class GeneratePhoneNumber extends AbstractGenerator<{
     template?: string;
     prefixes?: string[];
     generatedDigitsNumbers?: number | number[];
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
@@ -404,11 +476,12 @@ export declare class GeneratePhoneNumber extends AbstractGenerator<{
 }
 export declare class GenerateCountry extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueCountry;
-    init({ seed }: {
+    init({ count, seed }: {
         count: number;
         seed: number;
     }): void;
@@ -426,21 +499,25 @@ export declare class GenerateUniqueCountry extends AbstractGenerator<{
     }): void;
     generate(): string;
 }
-export declare class GenerateJobTitle extends AbstractGenerator<{}> {
+export declare class GenerateJobTitle extends AbstractGenerator<{
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string | undefined;
 }
 export declare class GenerateStreetAdddress extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueStreetAdddress;
-    init({ seed }: {
+    init({ count, seed }: {
         count: number;
         seed: number;
     }): void;
@@ -451,6 +528,7 @@ export declare class GenerateUniqueStreetAdddress extends AbstractGenerator<{
 }> {
     static readonly [entityKind]: string;
     private state;
+    isUnique: boolean;
     init({ count, seed }: {
         count: number;
         seed: number;
@@ -459,11 +537,13 @@ export declare class GenerateUniqueStreetAdddress extends AbstractGenerator<{
 }
 export declare class GenerateCity extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueCity;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string | undefined;
@@ -482,11 +562,13 @@ export declare class GenerateUniqueCity extends AbstractGenerator<{
 }
 export declare class GeneratePostcode extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniquePostcode;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string;
@@ -496,27 +578,33 @@ export declare class GenerateUniquePostcode extends AbstractGenerator<{
 }> {
     static readonly [entityKind]: string;
     private state;
+    isUnique: boolean;
     init({ count, seed }: {
         count: number;
         seed: number;
     }): void;
     generate(): string;
 }
-export declare class GenerateState extends AbstractGenerator<{}> {
+export declare class GenerateState extends AbstractGenerator<{
+    arraySize?: number;
+}> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string | undefined;
 }
 export declare class GenerateCompanyName extends AbstractGenerator<{
     isUnique?: boolean;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueCompanyName;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string;
@@ -526,6 +614,7 @@ export declare class GenerateUniqueCompanyName extends AbstractGenerator<{
 }> {
     static readonly [entityKind]: string;
     private state;
+    isUnique: boolean;
     init({ count, seed }: {
         count: number;
         seed: number;
@@ -534,10 +623,12 @@ export declare class GenerateUniqueCompanyName extends AbstractGenerator<{
 }
 export declare class GenerateLoremIpsum extends AbstractGenerator<{
     sentencesCount?: number;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
-    init({ seed }: {
+    init({ count, seed }: {
+        count: number;
         seed: number;
     }): void;
     generate(): string;
@@ -562,11 +653,12 @@ export declare class GeneratePoint extends AbstractGenerator<{
     maxXValue?: number;
     minYValue?: number;
     maxYValue?: number;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniquePoint;
-    init({ seed }: {
+    init({ count, seed }: {
         count: number;
         seed: number;
     }): void;
@@ -584,6 +676,7 @@ export declare class GenerateUniquePoint extends AbstractGenerator<{
 }> {
     static readonly [entityKind]: string;
     private state;
+    isUnique: boolean;
     init({ count, seed }: {
         count: number;
         seed: number;
@@ -601,11 +694,12 @@ export declare class GenerateLine extends AbstractGenerator<{
     maxBValue?: number;
     minCValue?: number;
     maxCValue?: number;
+    arraySize?: number;
 }> {
     static readonly [entityKind]: string;
     private state;
     uniqueVersionOfGen: typeof GenerateUniqueLine;
-    init({ seed }: {
+    init({ count, seed }: {
         count: number;
         seed: number;
     }): void;
@@ -626,6 +720,7 @@ export declare class GenerateUniqueLine extends AbstractGenerator<{
 }> {
     static readonly [entityKind]: string;
     private state;
+    isUnique: boolean;
     init({ count, seed }: {
         count: number;
         seed: number;
@@ -640,6 +735,7 @@ export declare const generatorsFuncs: {
     /**
      * generates same given value each time the generator is called.
      * @param defaultValue - value you want to generate
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -654,11 +750,13 @@ export declare const generatorsFuncs: {
      */
     default: (args_0: {
         defaultValue: unknown;
+        arraySize?: number;
     }) => GenerateDefault;
     /**
      * generates values from given array
      * @param values - array of values you want to generate. can be array of weighted values.
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -700,6 +798,7 @@ export declare const generatorsFuncs: {
             values: (number | string | boolean | undefined)[];
         }[];
         isUnique?: boolean;
+        arraySize?: number;
     }) => GenerateValuesFromArray;
     /**
      * generates sequential integers starting with 1.
@@ -724,6 +823,7 @@ export declare const generatorsFuncs: {
      * precision equals 10 means that values will be accurate to one tenth (1.2, 34.6);
      * precision equals 100 means that values will be accurate to one hundredth (1.23, 34.67).
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -742,12 +842,14 @@ export declare const generatorsFuncs: {
         maxValue?: number;
         precision?: number;
         isUnique?: boolean;
-    } | undefined]) => GenerateNumber;
+        arraySize?: number;
+    }]) => GenerateNumber;
     /**
      * generates integers within given range.
      * @param minValue - lower border of range.
      * @param maxValue - upper border of range.
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -765,9 +867,11 @@ export declare const generatorsFuncs: {
         minValue?: number | bigint;
         maxValue?: number | bigint;
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateInt;
     /**
      * generates boolean values(true or false)
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -781,11 +885,14 @@ export declare const generatorsFuncs: {
      *
      * ```
      */
-    boolean: (...args: [] | [{}]) => GenerateBoolean;
+    boolean: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateBoolean;
     /**
      * generates date within given range.
      * @param minDate - lower border of range.
      * @param maxDate - upper border of range.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -802,9 +909,12 @@ export declare const generatorsFuncs: {
     date: (...args: [] | [{
         minDate?: string | Date;
         maxDate?: string | Date;
+        arraySize?: number;
     }]) => GenerateDate;
     /**
      * generates time in 24 hours style.
+     * @param arraySize - number of elements in each one-dimensional array.
+     *
      * @example
      * ```ts
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
@@ -817,9 +927,13 @@ export declare const generatorsFuncs: {
      *
      * ```
      */
-    time: (...args: [] | [{}]) => GenerateTime;
+    time: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateTime;
     /**
      * generates timestamps.
+     * @param arraySize - number of elements in each one-dimensional array.
+     *
      * @example
      * ```ts
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
@@ -832,9 +946,13 @@ export declare const generatorsFuncs: {
      *
      * ```
      */
-    timestamp: (...args: [] | [{}]) => GenerateTimestamp;
+    timestamp: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateTimestamp;
     /**
      * generates datetime objects.
+     * @param arraySize - number of elements in each one-dimensional array.
+     *
      * @example
      * ```ts
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
@@ -847,9 +965,13 @@ export declare const generatorsFuncs: {
      *
      * ```
      */
-    datetime: (...args: [] | [{}]) => GenerateDatetime;
+    datetime: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateDatetime;
     /**
      * generates years.
+     * @param arraySize - number of elements in each one-dimensional array.
+     *
      * @example
      * ```ts
      *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
@@ -862,9 +984,12 @@ export declare const generatorsFuncs: {
      *
      * ```
      */
-    year: (...args: [] | [{}]) => GenerateYear;
+    year: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateYear;
     /**
      * generates json objects with fixed structure.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * json structure can equal this:
      * ```
@@ -900,13 +1025,16 @@ export declare const generatorsFuncs: {
      *  }));
      * ```
      */
-    json: (...args: [] | [{}]) => GenerateJson;
+    json: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateJson;
     /**
      * generates time intervals.
      *
      * interval example: "1 years 12 days 5 minutes"
      *
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      * @example
      * ```ts
      * await seed(db, schema, { count: 1000 }).refine((funcs) => ({
@@ -920,10 +1048,12 @@ export declare const generatorsFuncs: {
      */
     interval: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateInterval;
     /**
      * generates random strings.
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -938,10 +1068,33 @@ export declare const generatorsFuncs: {
      */
     string: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateString;
+    /**
+     * generates v4 UUID strings if arraySize is not specified, or v4 UUID 1D arrays if it is.
+     *
+     * @param arraySize - number of elements in each one-dimensional array.
+     *
+     * @example
+     * ```ts
+     *  await seed(db, schema, { count: 1000 }).refine((funcs) => ({
+     *    users: {
+     *      columns: {
+     *        uuid: funcs.uuid({
+     *          arraySize: 4
+     *        })
+     *      },
+     *    },
+     *  }));
+     * ```
+     */
+    uuid: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateUUID;
     /**
      * generates person's first names.
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -956,10 +1109,12 @@ export declare const generatorsFuncs: {
      */
     firstName: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateFirstName;
     /**
      * generates person's last names.
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -974,10 +1129,12 @@ export declare const generatorsFuncs: {
      */
     lastName: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateLastName;
     /**
      * generates person's full names.
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -992,9 +1149,11 @@ export declare const generatorsFuncs: {
      */
     fullName: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateFullName;
     /**
      * generates unique emails.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1007,9 +1166,12 @@ export declare const generatorsFuncs: {
      *  }));
      * ```
      */
-    email: (...args: [] | [{}]) => GenerateEmail;
+    email: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateEmail;
     /**
      * generates unique phone numbers.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @param template - phone number template, where all '#' symbols will be substituted with generated digits.
      * @param prefixes - array of any string you want to be your phone number prefixes.(not compatible with template property)
@@ -1049,10 +1211,12 @@ export declare const generatorsFuncs: {
         template?: string;
         prefixes?: string[];
         generatedDigitsNumbers?: number | number[];
+        arraySize?: number;
     }]) => GeneratePhoneNumber;
     /**
      * generates country's names.
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1067,10 +1231,12 @@ export declare const generatorsFuncs: {
      */
     country: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateCountry;
     /**
      * generates city's names.
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1085,10 +1251,12 @@ export declare const generatorsFuncs: {
      */
     city: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateCity;
     /**
      * generates street address.
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1103,9 +1271,11 @@ export declare const generatorsFuncs: {
      */
     streetAddress: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateStreetAdddress;
     /**
      * generates job titles.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1118,11 +1288,14 @@ export declare const generatorsFuncs: {
      *  }));
      * ```
      */
-    jobTitle: (...args: [] | [{}]) => GenerateJobTitle;
+    jobTitle: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateJobTitle;
     /**
      * generates postal codes.
      *
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1137,9 +1310,11 @@ export declare const generatorsFuncs: {
      */
     postcode: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GeneratePostcode;
     /**
      * generates states of America.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1152,11 +1327,14 @@ export declare const generatorsFuncs: {
      *  }));
      * ```
      */
-    state: (...args: [] | [{}]) => GenerateState;
+    state: (...args: [] | [{
+        arraySize?: number;
+    }]) => GenerateState;
     /**
      * generates company's names.
      *
      * @param isUnique - property that controls if generated values gonna be unique or not.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1171,11 +1349,13 @@ export declare const generatorsFuncs: {
      */
     companyName: (...args: [] | [{
         isUnique?: boolean;
+        arraySize?: number;
     }]) => GenerateCompanyName;
     /**
      * generates 'lorem ipsum' text sentences.
      *
      * @param sentencesCount - number of sentences you want to generate as one generated value(string).
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1190,6 +1370,7 @@ export declare const generatorsFuncs: {
      */
     loremIpsum: (...args: [] | [{
         sentencesCount?: number;
+        arraySize?: number;
     }]) => GenerateLoremIpsum;
     /**
      * generates 2D points within specified ranges for x and y coordinates.
@@ -1199,6 +1380,7 @@ export declare const generatorsFuncs: {
      * @param maxXValue - upper bound of range for x coordinate.
      * @param minYValue - lower bound of range for y coordinate.
      * @param maxYValue - upper bound of range for y coordinate.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1221,6 +1403,7 @@ export declare const generatorsFuncs: {
         maxXValue?: number;
         minYValue?: number;
         maxYValue?: number;
+        arraySize?: number;
     }]) => GeneratePoint;
     /**
      * generates 2D lines within specified ranges for a, b and c parameters of line.
@@ -1236,6 +1419,7 @@ export declare const generatorsFuncs: {
      * @param maxBValue - upper bound of range for y parameter.
      * @param minCValue - lower bound of range for y parameter.
      * @param maxCValue - upper bound of range for y parameter.
+     * @param arraySize - number of elements in each one-dimensional array.
      *
      * @example
      * ```ts
@@ -1261,6 +1445,7 @@ export declare const generatorsFuncs: {
         maxBValue?: number;
         minCValue?: number;
         maxCValue?: number;
+        arraySize?: number;
     }]) => GenerateLine;
     /**
      * gives you the opportunity to call different generators with different probabilities to generate values for one column.