struct-fakerator 2.2.3 → 2.3.3

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import * as _faker_js_faker__ from '@faker-js/faker/.';
+
 type ValueConfig<T> = {
     type: "value";
     generateFn: () => T;
@@ -84,4 +86,652 @@ declare const createTupleGenerator: <T extends TupleConfig<unknown, unknown, unk
 declare const createBoundedSeriesGenerator: <T extends BoundedSeriesConfig>(config: T) => (() => Result<T>);
 declare const createGeneratorByType: <T extends AllConfig<unknown>>(config: T, customTypeMatch?: (config: unknown, path: string) => ValueConfig<unknown>) => (() => Result<T>);
 
-export { type ArrayConfig, type BoundedSeriesConfig, type ObjectConfig, type Result, type SelectionConfig, type TupleConfig, type ValueConfig, createArrayConfig, createArrayGenerator, createBoundedSeriesConfig, createBoundedSeriesGenerator, createGeneratorByType, createObjectConfig, createObjectGenerator, createSelectionConfig, createSelectionGenerator, createTupleConfig, createTupleGenerator, createValueConfig, createValueGenerator };
+/** Airline [aircraftType](https://fakerjs.dev/api/airline.html#aircraftType) */
+declare const aircraftType: () => ValueConfig<"narrowbody" | "regional" | "widebody">;
+/** Airline [flightNumber](https://fakerjs.dev/api/airline.html#flightNumber) */
+declare const flightNumber: (options?: {
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    addLeadingZeros?: boolean;
+}) => ValueConfig<string>;
+/** Airline [seat](https://fakerjs.dev/api/airline.html#seat) */
+declare const seat: (options?: {
+    aircraftType?: _faker_js_faker__.AircraftType;
+}) => ValueConfig<string>;
+
+declare const airline_aircraftType: typeof aircraftType;
+declare const airline_flightNumber: typeof flightNumber;
+declare const airline_seat: typeof seat;
+declare namespace airline {
+  export { airline_aircraftType as aircraftType, airline_flightNumber as flightNumber, airline_seat as seat };
+}
+
+/** Animal [bear](https://fakerjs.dev/api/animal.html#bear) */
+declare const bear: () => ValueConfig<string>;
+/** Animal [bird](https://fakerjs.dev/api/animal.html#bird) */
+declare const bird: () => ValueConfig<string>;
+/** Animal [cat](https://fakerjs.dev/api/animal.html#cat) */
+declare const cat: () => ValueConfig<string>;
+/** Animal [cetacean](https://fakerjs.dev/api/animal.html#cetacean) */
+declare const cetacean: () => ValueConfig<string>;
+/** Animal [cow](https://fakerjs.dev/api/animal.html#cow) */
+declare const cow: () => ValueConfig<string>;
+/** Animal [crocodilia](https://fakerjs.dev/api/animal.html#crocodilia) */
+declare const crocodilia: () => ValueConfig<string>;
+/** Animal [dog](https://fakerjs.dev/api/animal.html#dog) */
+declare const dog: () => ValueConfig<string>;
+/** Animal [fish](https://fakerjs.dev/api/animal.html#fish) */
+declare const fish: () => ValueConfig<string>;
+/** Animal [horse](https://fakerjs.dev/api/animal.html#horse) */
+declare const horse: () => ValueConfig<string>;
+/** Animal [insect](https://fakerjs.dev/api/animal.html#insect) */
+declare const insect: () => ValueConfig<string>;
+/** Animal [lion](https://fakerjs.dev/api/animal.html#lion) */
+declare const lion: () => ValueConfig<string>;
+/** Animal [rabbit](https://fakerjs.dev/api/animal.html#rabbit) */
+declare const rabbit: () => ValueConfig<string>;
+/** Animal [rodent](https://fakerjs.dev/api/animal.html#rodent) */
+declare const rodent: () => ValueConfig<string>;
+/** Animal [snake](https://fakerjs.dev/api/animal.html#snake) */
+declare const snake: () => ValueConfig<string>;
+/** Animal [type](https://fakerjs.dev/api/animal.html#type) */
+declare const type$1: () => ValueConfig<string>;
+
+declare const animal_bear: typeof bear;
+declare const animal_bird: typeof bird;
+declare const animal_cat: typeof cat;
+declare const animal_cetacean: typeof cetacean;
+declare const animal_cow: typeof cow;
+declare const animal_crocodilia: typeof crocodilia;
+declare const animal_dog: typeof dog;
+declare const animal_fish: typeof fish;
+declare const animal_horse: typeof horse;
+declare const animal_insect: typeof insect;
+declare const animal_lion: typeof lion;
+declare const animal_rabbit: typeof rabbit;
+declare const animal_rodent: typeof rodent;
+declare const animal_snake: typeof snake;
+declare namespace animal {
+  export { animal_bear as bear, animal_bird as bird, animal_cat as cat, animal_cetacean as cetacean, animal_cow as cow, animal_crocodilia as crocodilia, animal_dog as dog, animal_fish as fish, animal_horse as horse, animal_insect as insect, animal_lion as lion, animal_rabbit as rabbit, animal_rodent as rodent, animal_snake as snake, type$1 as type };
+}
+
+/** Color [cmyk](https://fakerjs.dev/api/color.html#cmyk) */
+declare const cmyk: (options?: {
+    format?: _faker_js_faker__.ColorFormat;
+}) => ValueConfig<string | number[]>;
+/** Color [colorByCSSColorSpace](https://fakerjs.dev/api/color.html#colorByCSSColorSpace) */
+declare const colorByCSSColorSpace: (options?: {
+    format?: _faker_js_faker__.ColorFormat;
+    space?: _faker_js_faker__.CssSpaceType;
+}) => ValueConfig<string | number[]>;
+/** Color [cssSupportedFunction](https://fakerjs.dev/api/color.html#cssSupportedFunction) */
+declare const cssSupportedFunction: () => ValueConfig<"rgb" | "rgba" | "hsl" | "hsla" | "hwb" | "cmyk" | "lab" | "lch" | "color">;
+/** Color [cssSupportedSpace](https://fakerjs.dev/api/color.html#cssSupportedSpace) */
+declare const cssSupportedSpace: () => ValueConfig<"sRGB" | "display-p3" | "rec2020" | "a98-rgb" | "prophoto-rgb">;
+/** Color [hsl](https://fakerjs.dev/api/color.html#hsl) */
+declare const hsl: (options?: {
+    format?: _faker_js_faker__.ColorFormat;
+    includeAlpha?: boolean;
+}) => ValueConfig<string | number[]>;
+/** Color [human](https://fakerjs.dev/api/color.html#human) */
+declare const human: () => ValueConfig<string>;
+/** Color [hwb](https://fakerjs.dev/api/color.html#hwb) */
+declare const hwb: (options?: {
+    format?: _faker_js_faker__.ColorFormat;
+}) => ValueConfig<string | number[]>;
+/** Color [lab](https://fakerjs.dev/api/color.html#lab) */
+declare const lab: (options?: {
+    format?: _faker_js_faker__.ColorFormat;
+}) => ValueConfig<string | number[]>;
+/** Color [lch](https://fakerjs.dev/api/color.html#lch) */
+declare const lch: (options?: {
+    format?: _faker_js_faker__.ColorFormat;
+}) => ValueConfig<string | number[]>;
+/** Color [rgb](https://fakerjs.dev/api/color.html#rgb) */
+declare const rgb: (options?: {
+    prefix?: string;
+    casing?: _faker_js_faker__.Casing;
+    format?: "hex" | _faker_js_faker__.ColorFormat;
+    includeAlpha?: boolean;
+}) => ValueConfig<string | number[]>;
+/** Color [space](https://fakerjs.dev/api/color.html#space) */
+declare const space: () => ValueConfig<string>;
+
+declare const color_cmyk: typeof cmyk;
+declare const color_colorByCSSColorSpace: typeof colorByCSSColorSpace;
+declare const color_cssSupportedFunction: typeof cssSupportedFunction;
+declare const color_cssSupportedSpace: typeof cssSupportedSpace;
+declare const color_hsl: typeof hsl;
+declare const color_human: typeof human;
+declare const color_hwb: typeof hwb;
+declare const color_lab: typeof lab;
+declare const color_lch: typeof lch;
+declare const color_rgb: typeof rgb;
+declare const color_space: typeof space;
+declare namespace color {
+  export { color_cmyk as cmyk, color_colorByCSSColorSpace as colorByCSSColorSpace, color_cssSupportedFunction as cssSupportedFunction, color_cssSupportedSpace as cssSupportedSpace, color_hsl as hsl, color_human as human, color_hwb as hwb, color_lab as lab, color_lch as lch, color_rgb as rgb, color_space as space };
+}
+
+/** Commerce [department](https://fakerjs.dev/api/commerce.html#department) */
+declare const department: () => ValueConfig<string>;
+/** Commerce [isbn](https://fakerjs.dev/api/commerce.html#isbn) */
+declare const isbn: (options?: 10 | 13 | {
+    variant?: 10 | 13;
+    separator?: string;
+}) => ValueConfig<string>;
+/** Commerce [price](https://fakerjs.dev/api/commerce.html#price) */
+declare const price: (options?: {
+    min?: number;
+    max?: number;
+    dec?: number;
+    symbol?: string;
+}) => ValueConfig<string>;
+/** Commerce [product](https://fakerjs.dev/api/commerce.html#product) */
+declare const product: () => ValueConfig<string>;
+/** Commerce [productAdjective](https://fakerjs.dev/api/commerce.html#productAdjective) */
+declare const productAdjective: () => ValueConfig<string>;
+/** Commerce [productDescription](https://fakerjs.dev/api/commerce.html#productDescription) */
+declare const productDescription: () => ValueConfig<string>;
+/** Commerce [productMaterial](https://fakerjs.dev/api/commerce.html#productMaterial) */
+declare const productMaterial: () => ValueConfig<string>;
+/** Commerce [productName](https://fakerjs.dev/api/commerce.html#productName) */
+declare const productName: () => ValueConfig<string>;
+
+declare const commerce_department: typeof department;
+declare const commerce_isbn: typeof isbn;
+declare const commerce_price: typeof price;
+declare const commerce_product: typeof product;
+declare const commerce_productAdjective: typeof productAdjective;
+declare const commerce_productDescription: typeof productDescription;
+declare const commerce_productMaterial: typeof productMaterial;
+declare const commerce_productName: typeof productName;
+declare namespace commerce {
+  export { commerce_department as department, commerce_isbn as isbn, commerce_price as price, commerce_product as product, commerce_productAdjective as productAdjective, commerce_productDescription as productDescription, commerce_productMaterial as productMaterial, commerce_productName as productName };
+}
+
+/** Common constant */
+declare const constant: <T>(value: T) => ValueConfig<T>;
+
+declare const common_constant: typeof constant;
+declare namespace common {
+  export { common_constant as constant };
+}
+
+/** Company [buzzAdjective](https://fakerjs.dev/api/company.html#buzzAdjective) */
+declare const buzzAdjective: () => ValueConfig<string>;
+/** Company [buzzNoun](https://fakerjs.dev/api/company.html#buzzNoun) */
+declare const buzzNoun: () => ValueConfig<string>;
+/** Company [buzzPhrase](https://fakerjs.dev/api/company.html#buzzPhrase) */
+declare const buzzPhrase: () => ValueConfig<string>;
+/** Company [buzzVerb](https://fakerjs.dev/api/company.html#buzzVerb) */
+declare const buzzVerb: () => ValueConfig<string>;
+/** Company [catchPhrase](https://fakerjs.dev/api/company.html#catchPhrase) */
+declare const catchPhrase: () => ValueConfig<string>;
+/** Company [catchPhraseAdjective](https://fakerjs.dev/api/company.html#catchPhraseAdjective) */
+declare const catchPhraseAdjective: () => ValueConfig<string>;
+/** Company [catchPhraseDescriptor](https://fakerjs.dev/api/company.html#catchPhraseDescriptor) */
+declare const catchPhraseDescriptor: () => ValueConfig<string>;
+/** Company [catchPhraseNoun](https://fakerjs.dev/api/company.html#catchPhraseNoun) */
+declare const catchPhraseNoun: () => ValueConfig<string>;
+/** Company [name](https://fakerjs.dev/api/company.html#name) */
+declare const name: () => ValueConfig<string>;
+
+declare const company_buzzAdjective: typeof buzzAdjective;
+declare const company_buzzNoun: typeof buzzNoun;
+declare const company_buzzPhrase: typeof buzzPhrase;
+declare const company_buzzVerb: typeof buzzVerb;
+declare const company_catchPhrase: typeof catchPhrase;
+declare const company_catchPhraseAdjective: typeof catchPhraseAdjective;
+declare const company_catchPhraseDescriptor: typeof catchPhraseDescriptor;
+declare const company_catchPhraseNoun: typeof catchPhraseNoun;
+declare const company_name: typeof name;
+declare namespace company {
+  export { company_buzzAdjective as buzzAdjective, company_buzzNoun as buzzNoun, company_buzzPhrase as buzzPhrase, company_buzzVerb as buzzVerb, company_catchPhrase as catchPhrase, company_catchPhraseAdjective as catchPhraseAdjective, company_catchPhraseDescriptor as catchPhraseDescriptor, company_catchPhraseNoun as catchPhraseNoun, company_name as name };
+}
+
+/** Database [collation](https://fakerjs.dev/api/database.html#collation) */
+declare const collation: () => ValueConfig<string>;
+/** Database [column](https://fakerjs.dev/api/database.html#column) */
+declare const column: () => ValueConfig<string>;
+/** Database [engine](https://fakerjs.dev/api/database.html#engine) */
+declare const engine: () => ValueConfig<string>;
+/** Database [mongodbObjectId](https://fakerjs.dev/api/database.html#mongodbObjectId) */
+declare const mongodbObjectId: () => ValueConfig<string>;
+/** Database [type](https://fakerjs.dev/api/database.html#type) */
+declare const type: () => ValueConfig<string>;
+
+declare const database_collation: typeof collation;
+declare const database_column: typeof column;
+declare const database_engine: typeof engine;
+declare const database_mongodbObjectId: typeof mongodbObjectId;
+declare const database_type: typeof type;
+declare namespace database {
+  export { database_collation as collation, database_column as column, database_engine as engine, database_mongodbObjectId as mongodbObjectId, database_type as type };
+}
+
+/** Datatype [boolean](https://fakerjs.dev/api/datatype.html#boolean) */
+declare const boolean: (options?: number | {
+    probability?: number;
+}) => ValueConfig<boolean>;
+
+declare const datatype_boolean: typeof boolean;
+declare namespace datatype {
+  export { datatype_boolean as boolean };
+}
+
+/** Datetime [anytime](https://fakerjs.dev/api/date.html#anytime) */
+declare const anytime: (options?: {
+    refDate?: string | Date | number;
+}) => ValueConfig<Date>;
+/** Datetime [between](https://fakerjs.dev/api/date.html#between) */
+declare const between: (options: {
+    from: string | Date | number;
+    to: string | Date | number;
+}) => ValueConfig<Date>;
+/** Datetime [betweens](https://fakerjs.dev/api/date.html#betweens) */
+declare const betweens: (options: {
+    from: string | Date | number;
+    to: string | Date | number;
+    count?: number | {
+        min: number;
+        max: number;
+    };
+}) => ValueConfig<Date[]>;
+/** Datetime [birthdate](https://fakerjs.dev/api/date.html#birthdate) */
+declare const birthdate: (options?: {
+    refDate?: string | Date | number;
+} | {
+    mode: "age" | "year";
+    min: number;
+    max: number;
+    refDate?: string | Date | number;
+}) => ValueConfig<Date>;
+/** Datetime [future](https://fakerjs.dev/api/date.html#future) */
+declare const future: (options?: {
+    years?: number;
+    refDate?: string | Date | number;
+}) => ValueConfig<Date>;
+/** Datetime [month](https://fakerjs.dev/api/date.html#month) */
+declare const month: (options?: {
+    abbreviated?: boolean;
+    context?: boolean;
+}) => ValueConfig<string>;
+/** Datetime [past](https://fakerjs.dev/api/date.html#past) */
+declare const past: (options?: {
+    years?: number;
+    refDate?: string | Date | number;
+}) => ValueConfig<Date>;
+/** Datetime [recent](https://fakerjs.dev/api/date.html#recent) */
+declare const recent: (options?: {
+    days?: number;
+    refDate?: string | Date | number;
+}) => ValueConfig<Date>;
+/** Datetime [soon](https://fakerjs.dev/api/date.html#soon) */
+declare const soon: (options?: {
+    days?: number;
+    refDate?: string | Date | number;
+}) => ValueConfig<Date>;
+/** Datetime [timeZone](https://fakerjs.dev/api/date.html#timeZone) */
+declare const timeZone: () => ValueConfig<string>;
+/** Datetime [weekday](https://fakerjs.dev/api/date.html#weekday) */
+declare const weekday: (options?: {
+    abbreviated?: boolean;
+    context?: boolean;
+}) => ValueConfig<string>;
+
+declare const datetime_anytime: typeof anytime;
+declare const datetime_between: typeof between;
+declare const datetime_betweens: typeof betweens;
+declare const datetime_birthdate: typeof birthdate;
+declare const datetime_future: typeof future;
+declare const datetime_month: typeof month;
+declare const datetime_past: typeof past;
+declare const datetime_recent: typeof recent;
+declare const datetime_soon: typeof soon;
+declare const datetime_timeZone: typeof timeZone;
+declare const datetime_weekday: typeof weekday;
+declare namespace datetime {
+  export { datetime_anytime as anytime, datetime_between as between, datetime_betweens as betweens, datetime_birthdate as birthdate, datetime_future as future, datetime_month as month, datetime_past as past, datetime_recent as recent, datetime_soon as soon, datetime_timeZone as timeZone, datetime_weekday as weekday };
+}
+
+/** Finance [accountName](https://fakerjs.dev/api/finance.html#accountName) */
+declare const accountName: () => ValueConfig<string>;
+/** Finance [accountNumber](https://fakerjs.dev/api/finance.html#accountNumber) */
+declare const accountNumber: (optionsOrLength?: number | {
+    length?: number;
+}) => ValueConfig<string>;
+/** Finance [amount](https://fakerjs.dev/api/finance.html#amount) */
+declare const amount: (options?: {
+    min?: number;
+    max?: number;
+    dec?: number;
+    symbol?: string;
+    autoFormat?: boolean;
+}) => ValueConfig<string>;
+/** Finance [bic](https://fakerjs.dev/api/finance.html#bic) */
+declare const bic: (options?: {
+    includeBranchCode?: boolean;
+}) => ValueConfig<string>;
+/** Finance [bitcoinAddress](https://fakerjs.dev/api/finance.html#bitcoinAddress) */
+declare const bitcoinAddress: (options?: {
+    type?: _faker_js_faker__.BitcoinAddressFamilyType;
+    network?: _faker_js_faker__.BitcoinNetworkType;
+}) => ValueConfig<string>;
+/** Finance [creditCardCVV](https://fakerjs.dev/api/finance.html#creditCardCVV) */
+declare const creditCardCVV: () => ValueConfig<string>;
+/** Finance [creditCardIssuer](https://fakerjs.dev/api/finance.html#creditCardIssuer) */
+declare const creditCardIssuer: () => ValueConfig<string>;
+/** Finance [creditCardNumber](https://fakerjs.dev/api/finance.html#creditCardNumber) */
+declare const creditCardNumber: (options?: string | {
+    issuer?: string;
+}) => ValueConfig<string>;
+/** Finance [currency](https://fakerjs.dev/api/finance.html#currency) */
+declare const currency: () => ValueConfig<_faker_js_faker__.Currency>;
+/** Finance [currencyCode](https://fakerjs.dev/api/finance.html#currencyCode) */
+declare const currencyCode: () => ValueConfig<string>;
+/** Finance [currencySymbol](https://fakerjs.dev/api/finance.html#currencySymbol) */
+declare const currencySymbol: () => ValueConfig<string>;
+/** Finance [ethereumAddress](https://fakerjs.dev/api/finance.html#ethereumAddress) */
+declare const ethereumAddress: () => ValueConfig<string>;
+/** Finance [iban](https://fakerjs.dev/api/finance.html#iban) */
+declare const iban: (options?: {
+    formatted?: boolean;
+    countryCode?: string;
+}) => ValueConfig<string>;
+/** Finance [litecoinAddress](https://fakerjs.dev/api/finance.html#litecoinAddress) */
+declare const litecoinAddress: () => ValueConfig<string>;
+/** Finance [maskedNumber](https://fakerjs.dev/api/finance.html#maskedNumber) */
+declare const maskedNumber: (optionsOrLength?: number | {
+    length?: number;
+    parens?: boolean;
+    ellipsis?: boolean;
+}) => ValueConfig<string>;
+/** Finance [pin](https://fakerjs.dev/api/finance.html#pin) */
+declare const pin: (options?: number | {
+    length?: number;
+}) => ValueConfig<string>;
+/** Finance [routingNumber](https://fakerjs.dev/api/finance.html#routingNumber) */
+declare const routingNumber: () => ValueConfig<string>;
+/** Finance [transactionDescription](https://fakerjs.dev/api/finance.html#transactionDescription) */
+declare const transactionDescription: () => ValueConfig<string>;
+/** Finance [transactionType](https://fakerjs.dev/api/finance.html#transactionType) */
+declare const transactionType: () => ValueConfig<string>;
+
+declare const finance_accountName: typeof accountName;
+declare const finance_accountNumber: typeof accountNumber;
+declare const finance_amount: typeof amount;
+declare const finance_bic: typeof bic;
+declare const finance_bitcoinAddress: typeof bitcoinAddress;
+declare const finance_creditCardCVV: typeof creditCardCVV;
+declare const finance_creditCardIssuer: typeof creditCardIssuer;
+declare const finance_creditCardNumber: typeof creditCardNumber;
+declare const finance_currency: typeof currency;
+declare const finance_currencyCode: typeof currencyCode;
+declare const finance_currencySymbol: typeof currencySymbol;
+declare const finance_ethereumAddress: typeof ethereumAddress;
+declare const finance_iban: typeof iban;
+declare const finance_litecoinAddress: typeof litecoinAddress;
+declare const finance_maskedNumber: typeof maskedNumber;
+declare const finance_pin: typeof pin;
+declare const finance_routingNumber: typeof routingNumber;
+declare const finance_transactionDescription: typeof transactionDescription;
+declare const finance_transactionType: typeof transactionType;
+declare namespace finance {
+  export { finance_accountName as accountName, finance_accountNumber as accountNumber, finance_amount as amount, finance_bic as bic, finance_bitcoinAddress as bitcoinAddress, finance_creditCardCVV as creditCardCVV, finance_creditCardIssuer as creditCardIssuer, finance_creditCardNumber as creditCardNumber, finance_currency as currency, finance_currencyCode as currencyCode, finance_currencySymbol as currencySymbol, finance_ethereumAddress as ethereumAddress, finance_iban as iban, finance_litecoinAddress as litecoinAddress, finance_maskedNumber as maskedNumber, finance_pin as pin, finance_routingNumber as routingNumber, finance_transactionDescription as transactionDescription, finance_transactionType as transactionType };
+}
+
+/** Lorem [lines](https://fakerjs.dev/api/lorem.html#lines) */
+declare const lines: (lineCount?: number | {
+    min: number;
+    max: number;
+}) => ValueConfig<string>;
+/** Lorem [paragraph](https://fakerjs.dev/api/lorem.html#paragraph) */
+declare const paragraph: (sentenceCount?: number | {
+    min: number;
+    max: number;
+}) => ValueConfig<string>;
+/** Lorem [paragraphs](https://fakerjs.dev/api/lorem.html#paragraphs) */
+declare const paragraphs: (paragraphCount?: number | {
+    min: number;
+    max: number;
+}, separator?: string) => ValueConfig<string>;
+/** Lorem [sentence](https://fakerjs.dev/api/lorem.html#sentence) */
+declare const sentence: (wordCount?: number | {
+    min: number;
+    max: number;
+}) => ValueConfig<string>;
+/** Lorem [sentences](https://fakerjs.dev/api/lorem.html#sentences) */
+declare const sentences: (sentenceCount?: number | {
+    min: number;
+    max: number;
+}, separator?: string) => ValueConfig<string>;
+/** Lorem [slug](https://fakerjs.dev/api/lorem.html#slug) */
+declare const slug: (wordCount?: number | {
+    min: number;
+    max: number;
+}) => ValueConfig<string>;
+/** Lorem [text](https://fakerjs.dev/api/lorem.html#text) */
+declare const text: () => ValueConfig<string>;
+/** Lorem [word](https://fakerjs.dev/api/lorem.html#word) */
+declare const word: (options?: number | {
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
+}) => ValueConfig<string>;
+/** Lorem [words](https://fakerjs.dev/api/lorem.html#words) */
+declare const words: (wordCount?: number | {
+    min: number;
+    max: number;
+}) => ValueConfig<string>;
+
+declare const lorem_lines: typeof lines;
+declare const lorem_paragraph: typeof paragraph;
+declare const lorem_paragraphs: typeof paragraphs;
+declare const lorem_sentence: typeof sentence;
+declare const lorem_sentences: typeof sentences;
+declare const lorem_slug: typeof slug;
+declare const lorem_text: typeof text;
+declare const lorem_word: typeof word;
+declare const lorem_words: typeof words;
+declare namespace lorem {
+  export { lorem_lines as lines, lorem_paragraph as paragraph, lorem_paragraphs as paragraphs, lorem_sentence as sentence, lorem_sentences as sentences, lorem_slug as slug, lorem_text as text, lorem_word as word, lorem_words as words };
+}
+
+/** Number [bigInt](https://fakerjs.dev/api/number.html#bigInt) */
+declare const bigInt: (options?: string | number | bigint | boolean | {
+    min?: bigint | number | string | boolean;
+    max?: bigint | number | string | boolean;
+}) => ValueConfig<bigint>;
+/** Number [binary](https://fakerjs.dev/api/number.html#binary) */
+declare const binary$1: (options?: number | {
+    min?: number;
+    max?: number;
+}) => ValueConfig<string>;
+/** Number [float](https://fakerjs.dev/api/number.html#float) */
+declare const float: (options?: number | {
+    min?: number;
+    max?: number;
+    fractionDigits?: number;
+    multipleOf?: number;
+}) => ValueConfig<number>;
+/** Number [hex](https://fakerjs.dev/api/number.html#hex) */
+declare const hex: (options?: number | {
+    min?: number;
+    max?: number;
+}) => ValueConfig<string>;
+/** Number [int](https://fakerjs.dev/api/number.html#int) */
+declare const int: (options?: number | {
+    min?: number;
+    max?: number;
+    multipleOf?: number;
+}) => ValueConfig<number>;
+/** Number [octal](https://fakerjs.dev/api/number.html#octal) */
+declare const octal$1: (options?: number | {
+    min?: number;
+    max?: number;
+}) => ValueConfig<string>;
+
+declare const number$1_bigInt: typeof bigInt;
+declare const number$1_float: typeof float;
+declare const number$1_hex: typeof hex;
+declare const number$1_int: typeof int;
+declare namespace number$1 {
+  export { number$1_bigInt as bigInt, binary$1 as binary, number$1_float as float, number$1_hex as hex, number$1_int as int, octal$1 as octal };
+}
+
+/** Person [bio](https://fakerjs.dev/api/person.html#bio) */
+declare const bio: () => ValueConfig<string>;
+/** Person [firstName](https://fakerjs.dev/api/person.html#firstName) */
+declare const firstName: (sex?: "female" | "male") => ValueConfig<string>;
+/** Person [fullName](https://fakerjs.dev/api/person.html#fullName) */
+declare const fullName: (options?: {
+    firstName?: string;
+    lastName?: string;
+    sex?: _faker_js_faker__.SexType;
+}) => ValueConfig<string>;
+/** Person [gender](https://fakerjs.dev/api/person.html#gender) */
+declare const gender: () => ValueConfig<string>;
+/** Person [jobArea](https://fakerjs.dev/api/person.html#jobArea) */
+declare const jobArea: () => ValueConfig<string>;
+/** Person [jobDescriptor](https://fakerjs.dev/api/person.html#jobDescriptor) */
+declare const jobDescriptor: () => ValueConfig<string>;
+/** Person [jobTitle](https://fakerjs.dev/api/person.html#jobTitle) */
+declare const jobTitle: () => ValueConfig<string>;
+/** Person [jobType](https://fakerjs.dev/api/person.html#jobType) */
+declare const jobType: () => ValueConfig<string>;
+/** Person [lastName](https://fakerjs.dev/api/person.html#lastName) */
+declare const lastName: (sex?: "female" | "male") => ValueConfig<string>;
+/** Person [middleName](https://fakerjs.dev/api/person.html#middleName) */
+declare const middleName: (sex?: "female" | "male") => ValueConfig<string>;
+/** Person [prefix](https://fakerjs.dev/api/person.html#prefix) */
+declare const prefix: (sex?: "female" | "male") => ValueConfig<string>;
+/** Person [sex](https://fakerjs.dev/api/person.html#sex) */
+declare const sex: () => ValueConfig<string>;
+/** Person [sexType](https://fakerjs.dev/api/person.html#sexType) */
+declare const sexType: () => ValueConfig<"female" | "male">;
+/** Person [suffix](https://fakerjs.dev/api/person.html#suffix) */
+declare const suffix: () => ValueConfig<string>;
+/** Person [zodiacSign](https://fakerjs.dev/api/person.html#zodiacSign) */
+declare const zodiacSign: () => ValueConfig<string>;
+
+declare const person_bio: typeof bio;
+declare const person_firstName: typeof firstName;
+declare const person_fullName: typeof fullName;
+declare const person_gender: typeof gender;
+declare const person_jobArea: typeof jobArea;
+declare const person_jobDescriptor: typeof jobDescriptor;
+declare const person_jobTitle: typeof jobTitle;
+declare const person_jobType: typeof jobType;
+declare const person_lastName: typeof lastName;
+declare const person_middleName: typeof middleName;
+declare const person_prefix: typeof prefix;
+declare const person_sex: typeof sex;
+declare const person_sexType: typeof sexType;
+declare const person_suffix: typeof suffix;
+declare const person_zodiacSign: typeof zodiacSign;
+declare namespace person {
+  export { person_bio as bio, person_firstName as firstName, person_fullName as fullName, person_gender as gender, person_jobArea as jobArea, person_jobDescriptor as jobDescriptor, person_jobTitle as jobTitle, person_jobType as jobType, person_lastName as lastName, person_middleName as middleName, person_prefix as prefix, person_sex as sex, person_sexType as sexType, person_suffix as suffix, person_zodiacSign as zodiacSign };
+}
+
+/** Phone [imei](https://fakerjs.dev/api/phone.html#imei) */
+declare const imei: () => ValueConfig<string>;
+/** Phone [number](https://fakerjs.dev/api/phone.html#number) */
+declare const number: (options?: {
+    style?: "human" | "national" | "international";
+}) => ValueConfig<string>;
+
+declare const phone_imei: typeof imei;
+declare const phone_number: typeof number;
+declare namespace phone {
+  export { phone_imei as imei, phone_number as number };
+}
+
+/** String [alpha](https://fakerjs.dev/api/string.html#alpha) */
+declare const alpha: (options?: number | {
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    casing?: "lower" | "upper" | "mixed";
+    exclude?: ReadonlyArray<(("a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z") | ("A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z")) | (string & {
+        zz_IGNORE_ME?: never;
+    })> | string;
+}) => ValueConfig<string>;
+/** String [alphanumeric](https://fakerjs.dev/api/string.html#alphanumeric) */
+declare const alphanumeric: (options?: number | {
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    casing?: "lower" | "upper" | "mixed";
+    exclude?: ReadonlyArray<(string & {
+        zz_IGNORE_ME?: never;
+    }) | ((("a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z") | ("A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z")) | ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"))> | string;
+}) => ValueConfig<string>;
+/** String [binary](https://fakerjs.dev/api/string.html#binary) */
+declare const binary: (options?: {
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    prefix?: string;
+}) => ValueConfig<string>;
+/** String [fromCharacters](https://fakerjs.dev/api/string.html#fromCharacters) */
+declare const fromCharacters: (characters: string | readonly string[], length?: number | {
+    min: number;
+    max: number;
+}) => ValueConfig<string>;
+/** String [hexadecimal](https://fakerjs.dev/api/string.html#hexadecimal) */
+declare const hexadecimal: (options?: {
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    casing?: "lower" | "upper" | "mixed";
+    prefix?: string;
+}) => ValueConfig<string>;
+/** String [nanoid](https://fakerjs.dev/api/string.html#nanoid) */
+declare const nanoid: (length?: number | {
+    min: number;
+    max: number;
+}) => ValueConfig<string>;
+/** String [octal](https://fakerjs.dev/api/string.html#octal) */
+declare const octal: (options?: {
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    prefix?: string;
+}) => ValueConfig<string>;
+/** String [sample](https://fakerjs.dev/api/string.html#sample) */
+declare const sample: (length?: number | {
+    min: number;
+    max: number;
+}) => ValueConfig<string>;
+/** String [symbol](https://fakerjs.dev/api/string.html#symbol) */
+declare const symbol: (length?: number | {
+    min: number;
+    max: number;
+}) => ValueConfig<string>;
+/** String [uuid](https://fakerjs.dev/api/string.html#uuid) */
+declare const uuid: () => ValueConfig<string>;
+
+declare const string_alpha: typeof alpha;
+declare const string_alphanumeric: typeof alphanumeric;
+declare const string_binary: typeof binary;
+declare const string_fromCharacters: typeof fromCharacters;
+declare const string_hexadecimal: typeof hexadecimal;
+declare const string_nanoid: typeof nanoid;
+declare const string_octal: typeof octal;
+declare const string_sample: typeof sample;
+declare const string_symbol: typeof symbol;
+declare const string_uuid: typeof uuid;
+declare namespace string {
+  export { string_alpha as alpha, string_alphanumeric as alphanumeric, string_binary as binary, string_fromCharacters as fromCharacters, string_hexadecimal as hexadecimal, string_nanoid as nanoid, string_octal as octal, string_sample as sample, string_symbol as symbol, string_uuid as uuid };
+}
+
+export { airline as Airline, animal as Animal, type ArrayConfig, type BoundedSeriesConfig, color as Color, commerce as Commerce, common as Common, company as Company, database as Database, datatype as Datatype, datetime as DateTime, finance as Finance, lorem as Lorem, number$1 as Number, type ObjectConfig, person as Person, phone as Phone, type Result, type SelectionConfig, string as String, type TupleConfig, type ValueConfig, createArrayConfig, createArrayGenerator, createBoundedSeriesConfig, createBoundedSeriesGenerator, createGeneratorByType, createObjectConfig, createObjectGenerator, createSelectionConfig, createSelectionGenerator, createTupleConfig, createTupleGenerator, createValueConfig, createValueGenerator };