CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

8.0.0-beta.0 (2023-04-29)

⚠ BREAKING CHANGES

• location: rename definition city to city_pattern (#2094)
• location: rename definition street to street_pattern (#2051)
• helpers: remove default value from arrayElement (#2045)
• location: zip code state (#1874)
• finance: simplify account implementation (#1992)
• locale: move title to metadata (#1978)

Features

• add base locale (#1748) (f890d62)
• date: introduce anytime (#2096) (3fc7bf1)
• helpers: add fromRegExp method (#1569) (8516bfb)
• introduce locale proxy (#2004) (8a0bbf5)

Bug Fixes

• add support for equals on locale proxies (#2092) (4d0458c)
• export AircraftType correctly as type (#2077) (16d611f)
• image: use seeded picsum (#1968) (b5bfca4)
• locale: es cities should be in city_name not city_prefix, remove extraneous city_suffix (#2109) (789c8a2)
• locale: fix broken street address reference in fr_CH (#2007) (cbbc076)
• locale: fix en_HK city_pattern (#2105) (75e4892)
• locales: remove wrong phone number in Portugal (#2029) (89c4cf3)
• script error (#2085) (4ca3b75)
• types: locale proxy (#2099) (971f363)
• typo in Faker jsdocs (#2008) (9d904a3)

Changed Locales

• locale: move title to metadata (#1978) (c5eb72c)
• locale: rename cz to cs_CZ (#2013) (a95fc51)
• locale: rename ge to ka_GE (#2010) (1f763f8)
• locale: use null as not applicable (#2078) (acb9cf5)

New Locales

• locale: add additional metadata properties (#2025) (a49aa0d)

• locale: add af_ZA and zu_ZA states (#1983) (6ba5093)

• locale: add city names for th (#2075) (ed19bef)

• locale: add en_HK locale (#2083) (698fd7d)

• locale: add en_US location.county data (#1996) (34b743a)

• locale: add fi states (#1986) (88e561a)

• locale: add hu states (#1990) (3ae3691)

• locale: add hyphenated names to English locales (#1872) (17f0488)

• locale: add locale TH (#1922) (3c176b2)

• locale: de color human (#1997) (2675ec2)

• locale: extend Hebrew locale data (#1721) (54c2cf8)

• finance: simplify account implementation (#1992) (de078de)

• helpers: remove default value from arrayElement (#2045) (0564446)

• location: rename definition city to city_pattern (#2094) (8cd1965)

• location: rename definition street to street_pattern (#2051) (3529ef7)

• location: zip code state (#1874) (8574125)

8.0.0-alpha.2 (2023-03-24)

Bug Fixes

• locale: split zh_TW first_names by gender (#1941) (4e97200)
• revert types field (#1966) (9dcf83f)

New Locales

• locale: add Serbian (Latin) language (#1801) (d2046e8)

8.0.0-alpha.1 (2023-03-20)

⚠ BREAKING CHANGES

• remove dynamic locale switching support (#1735)
• company: rename bs to buzz (#1860)
• location: countryCode use ISO-3166-1 (#1720)
• number: default to high precision float (#1675)
• locale: remove unused separator entry (#1731)

Features

• airline: add airline module (#1699) (579c9ad)
• company: add realistic Hungarian company names (#1758) (2e6b136)
• date: introduce faker.defaultRefDate and setDefaultRefDate (#1757) (3a44d5f)
• finance: currency object (#1809) (59157a4)
• helpers: add length range support in arrayElements (#1772) (b86638d)
• helpers: add new faker.helpers.weightedArrayElement (#1654) (59824e6)
• helpers: allow empty string in fake (#1679) (f0d2ffb)
• helpers: new method enumValue (#1920) (f2abf8b)
• locales: add mergeLocales utility (#1707) (788fce0)
• number: add binary and octal random number generation (#1708) (d3229fc)
• number: default to high precision float (#1675) (1ebbead)
• person: add Portuguese BR Language to western zodiac sign (#1814) (fd96094)
• person: add short bio (#1696) (2a2e054)
• person: split prefix into gendered versions (#1665) (27dff93)
• provide enums for color values (#1910) (a001090)
• string: add binary and octal random string generation (#1710) (80e0a96)
• string: generate string from characters (#1717) (47b2cfc)
• string: nanoid (#1716) (099e76c)

Bug Fixes

• consistent locale names (#1884) (cf2ce68)
• correct types field (#1878) (956a15f)
• currency: modernise currency list for 2023 (#1880) (e6f949b)
• discord link (#1891) (8a97cac)
• git: commitEntry normalize user (#1813) (667599d)
• helpers: uniform distribution in helpers.arrayElements (#1770) (2b84b33)
• internet: filter banned dots from email addresses (#1883) (f8926c7)
• internet: fix invalid emails in some locales (#1746) (1e4e869)
• locale: az company name_patterns return undefined in name (#1914) (bb72a66)
• locale: correct capitalization of last_name in en_AU (#1912) (4f14533)
• locale: filter inappropriate words in the en locale (#1745) (dfa647d)
• locale: fix pt_PT street addresses (#1911) (8f0abd3)
• locale: remove invalid city patterns from pt_BR (#1913) (7ae5cdb)
• locale: replace Ð with Đ in hr and vi (#1810) (ff53587)
• more discord links (#1893) (f948e2e)
• person: avoid repeated last name via new last_name_patterns (#1819) (0f98518)
• person: change fullName to use name patterns (#1637) (1ae2f6f)
• person: improve to Dutch name generation (#1778) (fbd0db5)
• random: prevent infinite do-while (#1938) (256631d)
• random: remove deprecated method usage (#1865) (25bd847)

Changed Locales

• locale: remove unused separator entry (#1731) (0bc6c2f)

• company: rename bs to buzz (#1860) (5f95aca)

• location: countryCode use ISO-3166-1 (#1720) (a05c3e5)

• remove dynamic locale switching support (#1735) (9a35dc9)

New Locales

• locale: add state and state_abbr to cz (#1847) (f6c8ca3)
• locale: add Luxembourg (French) locale (#1693) (c66f7bd)
• locale: extend english company (#1701) (f0e859b)

8.0.0-alpha.0 (2022-12-24)

⚠ BREAKING CHANGES

• company: remove hardcoded name fallback pattern (#1451)
• date: unify signatures (#1534)
• helpers: rewrite shuffle (#1521)
• image: remove lorempixel (#1641)
• image: rewrite module (#1477)
• internet: ip now returns ipv4 and ipv6 (#1059)
• locale: change en_IND to en_IN (#1448)
• location: latitude/longitude returns number (#1064)
• location: nearbyGPSCoordinate returns number tuple (#1061)
• location: rename address module (#1469)
• number: change float default params (#1642)
• number: change int default params (#1643)
• person: rename name module (#1445)
• string: swap allowLeadingZeros default to true (#1602)
• cleanup deprecations (#1440)
• make mersenne internal (#1444)
• upgrade node minimum target (#1494)

Features

• datatype: introduce probability option to boolean (#1476) (838f836)
• git: add options.refDate to commitEntry (#1512) (7c661c6)
• helpers: add rangeToNumber method and add range parameters (#1486) (9cd716e)
• helpers: fake from array (#1453) (75a31f6)
• helpers: introduce multiple method (#1545) (f06126a)
• internet: add options to url() (#1480) (09e8356)
• internet: ip now returns ipv4 and ipv6 (#1059) (a90f2fe)
• locale: add dv locale (#1506) (0b9989f)
• locale: add free email domains for zh_CN (#1555) (f241928)
• locale: update Korean color, date, location, word, company (#1492) (2ce8056)
• locale: update location/country list (#1676) (ce1fa2f)
• locate: add japanese company (#1573) (6e1009a)
• location: latitude/longitude returns number (#1064) (dac6be3)
• location: nearbyGPSCoordinate returns number tuple (#1061) (4765336)
• number: adjust hex default (#1649) (7b50c2f)
• number: change float default params (#1642) (671631b)
• number: change int default params (#1643) (0b2fa1a)
• number: move methods to new module (#1122) (7d4d99f)
• person: add zodiacSign() (#182) (7e00d17)
• string: add special() method (#1634) (50fb72c)
• string: move methods to new module (#1155) (79858fe)
• word: add sample method (#714) (3777c44)
• fake with multiple parameters (#1459) (2eb2537)

Bug Fixes

• company: remove hardcoded name fallback pattern (#1451) (b99ff71)
• date: don't allow parameters <= 0 (#1536) (dd58148)
• date: unify signatures (#1534) (0cec571)
• git: adjust commitEntry to match git log output (#1539) (99b6fb2)
• helpers: rewrite shuffle (#1521) (a5de229)
• image: remove lorempixel (#1641) (ab9fa1f)
• image: rewrite module (#1477) (616b34d)
• internet: userName, email and slugify return only ascii (#1554) (4ed45fa)
• locale: change country name from Holanda to official name (#1669) (4ce378c)
• locale: change en_IND to en_IN (#1448) (a7cd422)
• locale: filter inappropriate words in the en locale (#1633) (df881bd)
• locale: improve en_GB location addresses (#1620) (27d41ee)
• locale: mk (Macedonian) names should use cyrillic а (#1557) (1796559)
• location: rename address module (#1469) (b983ca1)
• location: use IANA standard for timezone (#1678) (dd81fe1)
• number: values out of bounds (#1648) (e4839a9)
• person: Incorrect behavior of name.firstName() function (#1610) (4ce8e98)
• person: rename name module (#1445) (20f2236)
• string: swap allowLeadingZeros default to true (#1602) (c4b7ce8)
• ASCII-fy domainWord() (#1520) (cf764b9)
• broken allowLeadingZeros tests (#1638) (97dbfa1)
• cleanup deprecations (#1440) (9c1437d)
• first_name file in en_GH locale (#1566) (dfd74f2)
• make mersenne internal (#1444) (5aa747f)
• upgrade node minimum target (#1494) (226d421)

7.6.0 (2022-10-12)

Features

• finance: branch code option in bic() (#1378) (fe97c29)
• locale: add first name for zh_CN (#1376) (1d8ea82)
• locale: add male first names starting with Z to id_ID (#1424) (f921c14)
• locale: add months, days and few other minor strings to es (#1320) (ebb4e2c)
• locale: add new Indonesia state (#1400) (be87581)
• locale: extends id_ID company prefix (#1399) (f410564)
• lorem null response fix (#1407) (a6ce717)
• modules: export module interfaces (#932) (b9884d0)
• science: add more units in en locale (#1386) (8dcb584)

Bug Fixes

• finance: adjust min length of generated bitcoin address (#1384) (10aded2)
• finance: fix typo in Belarusian Ruble's name (#1395) (fe214c3)
• finance: Update Belarusian Ruble to new version (#1392) (526906f)
• finance: update Venezuelan bolívar name and code (#1394) (0e65143)
• finance: update Zambian Kwacha to new version (#1393) (115e859)
• image: properly lock loremflickr.com images (#1396) (2539e6a)
• improve default seed initialization (#1334) (925db3a)
• locale: change id_ID name to Indonesian (#1401) (ec0181e)

7.5.0 (2022-08-29)

Features

• company: move name formats to locales (#1293) (e1f26a6)
• datatype: change hexadecimal signature (#1238) (8cb6027)
• locale: add city names (de) (#1283) (cc8b2b2)
• locale: add directions and directions abbr to pl (#1225) (7a718b9)
• locale: add horses to pl (#1227) (ca7cb41)
• locale: extend Hebrew (he) (#1257) (f8c9f60)
• name: add sexType method (#1289) (f684a14)
• name: extract sex generator from gender to sex (#1168) (ad3c9bf)
• system: add cron (#897) (8fecd58)

Bug Fixes

• internal: fix typo in deprecation message (#1316) (7b18404)
• locale: remove SUS names (#1303) (f78843e)
• random: retry on invalid word generation (#1307) (c2108fa)

7.4.0 (2022-08-08)

Features

• add rodent breed on animal 'en' locale (#1136) (a65f1a2)
• dev: add male_first_name,female_first_name, jp locale (#1217) (ad885ea)
• image: add image via.placeholder provider (#1186) (00d4741)
• locales.en: extend vehicle (#1102) (07a970f)
• locales.pl: add pl translation for gender and binary gender (#1162) (22a050e)
• system.fileName: file extension count (#1101) (968134c)
• system.networkInterface: add networkInterface faker (#1133) (5979f82)

Bug Fixes

• finance.bic: remove hardcoded elements and simplify function (#1171) (5a397e0)

7.3.0 (2022-06-20)

New & Noteworthy

• Webpack v4 should now be supported 🚀

Features

• add abbreviations to hacker.abbreviation() in the en locale (#1086) (c5d8934)
• improve norwegian translations (#1042) (e071c78)
• throw error on unknown locale (#1071) (5ea8252)

Bug Fixes

• lower target to support Webpack 4 (#1085) (080e51d)

7.2.0 (2022-06-06)

⚠ SOFT BREAKING CHANGES

• always use https for loremflickr (#1034)
  • we removed the last parameter for image.imageUrl and always generate https urls

Features

• add en_CA city_name (close #983) (#992) (dc5c720)
• add german adjectives (#1023) (1b9a920)
• always use https for loremflickr (#1034) (a235dca)
• science module (#1014) (d75d079)

Bug Fixes

• 🇫🇷 fr and 🇨🇭 fr_CH 🎨 colors (#1007) (d96457e)

7.1.0 (2022-05-25)

Features

• add en_CA city_name (close #983) (#992) (dc5c720)
• add music.songName (#996) (ccd2959)

Bug Fixes

• Luhn generation algorithms and tests (#980) (c95826f)
• typescript: support module Node16/NodeNext (#1005) (8736c2a)

7.0.1 (2022-05-23)

Bug Fixes

• revert type exports for module NodeNext, Node16 (#979) (#989) (c704e36)

7.0.0 (2022-05-23)

⚠ BREAKING CHANGES

• remove faker default export (#799)
• target es2020 (#848)
• remove deprecations (#916)
• get rid of export = (#849)
• remove node v12 support (#850)
• reorganize src folder (#909)

Features

• add casing option (#955) (4c0e418)
• add date.birthdate (#962) (5e66d96)
• added sponsor and community members to the readme (#986) (2a6003f)
• address: use localized fake pattern in city (#948) (7373a22)
• allow banned as string (#819) (a0d25bb)
• color module (#801) (bee6054)
• improve and extend 🇫🇷 fr and 🇨🇭fr_CH locales (#973) (6f39b7c)
• internet: HTTP random status code (#945) (05f555b)
• reimplement datatype.bigInt (#791) (1793385)
• support locale definitions directly from faker.fake (#884) (a60d5e3)
• use localized fake pattern in street (#966) (5af79f4)

Bug Fixes

• empty array passed into helpers.arrayElements (#921) (100a1ea)
• generate:locale: make the definition types extendible (#915) (984fbb4)
• type exports for module NodeNext, Node16 (#979) (73db3a7)
• typo in error message (#925) (3ea64ce)

build

• remove node v12 support (#850) (cc9aec7)
• get rid of export = (#849) (20fbeaf)
• remove deprecations (#916) (683ee34)
• remove faker default export (#799) (39b74c0)
• reorganize src folder (#909) (a2da7c4)
• target es2020 (#848) (63f6361)

6.3.1 (2022-05-02)

Bug Fixes

• replace deprecated arrayElement calls (#903) (42d6795)

6.3.0 (2022-05-02)

Features

• add creditCardIssuer (#888) (58b4f10)
• add Hungarian locale (#53) (9b0d100)
• configure eol character for git.commitEntry (#681) (f797b63)
• faker.helpers.maybe (#874) (a64cbde)
• random numeric (#797) (712b1de)
• resettable unique store (#800) (29bba7b)
• return seed value from seed() (#853) (1851eca)
• separate methods for object key value (#503) (36cd461)

Bug Fixes

• address.nearbyGPSCoordinate (#876) (3e23fc4)
• dont log deprecations on startup (#857) (a28b5de)

6.2.0 (2022-04-21)

Features

• add chinese hyphenated name (#277) (40c9d5a)
• add internet.emoji (#504) (cb746cb)
• add Lastname - Bhadresha, Jangid, Suthar (#243) (6214425)
• Add MongoDB ObjectId generation (#616) (a5b3888)
• add more arabic names dataset (#655) (b3a9abc)
• add more arabic names datasets (#368) (f824f9d)
• add os. as street prefix for pl (#640) (c6d0cc7)
• add some en locale city prefixes and suffixes (#685) (955ea43)
• add some en locale product names (#686) (f22b93a)
• append more korean dataset and delete wrong dataset (#573) (acaedb3)
• dynamic definitions tree (#822) (069f4d1)
• extend list of domain suffix for PL locale (#266) (5beac4b)
• extend list of street prefixes for pl locale (#844) (425accd)
• faker.finance.pin() (#695) (20f33e6)
• immutable options in random.alpha methods (#790) (dd11846)
• phone IMEI (#829) (c25ecd0)
• special characters in emails (#792) (3b5a21f)
• updated mime-db to 1.52.0 (#808) (78a30fb)
• use street address templates from locales (#754) (b04dc91)

Bug Fixes

• Maryland (MD) wrong postal code (#804) (4ac2a04)
• use \n as default separator for lorem.paragraphs() (#783) (6a2d8fc)

6.1.2 (2022-04-04)

Features

• FakerError (#718) (c3be3b1)

Bug Fixes

• datatype.number when min = max + precision, throw when max > min (#664) (0304120)
• deterministic results for address.nearbyGPSCoordinate (#737) (bc7bd57)
• random word fails on undefined (#771) (fb1b87e)
• remove doubled extension in system.filePath (#300) (2532eb9)

6.1.1 (2022-03-28)

Bug Fixes

• forgot to run pnpm run build

6.1.0 (2022-03-28)

⚠WARNING: This build is broken due to missing build files. Please don't use this version!

Features

• types: generate all locales index files with non-any types (#494) (b611ca1)
• types: provide strong typing for locales 2 (#398) (419e9e2)

Bug Fixes

• accept dates as params for Date methods (#200) (91a1aab)
• alphaNumeric all chars banned (#550) (c51fb15)
• corrected the Costa Rican IBAN format (#646) (3f3de78)
• correcting the readme file (#529) (6c9dcdd)
• datatype.datetime should use static boundaries (#343) (7141cd7)
• enable algolia search (#641) (a759c87)
• fake behavior with special replacement patterns (#688) (8d1aefb)
• fake is unable to return empty strings (#347) (301a6d2)
• finance: update iso-3166-1 country codes for IBAN/BIC (#168) (6050d7a)
• fix bicycle_types files being named incorrectly (#477) (7a2a522)
• fix time.recent method signature (#586) (60d3cc5)
• fix unique method types (#457) (14df7d3)
• force passed locales into faker constructor (#580) (5ed963f)
• handle missing or broken locales main index files (#478) (ff97431)
• mersenne rand invalid input argument (#577) (486c76e)
• move el credit card information to the expected location (#484) (dcbd18e)
• name module gender (#644) (7675abe)
• normalize provider in finance.creditCardNumber (#662) (9ce1551)
• only return word with desirable alpha characters (#654) (b7b2e4f)
• remove invalid aliases (#488) (58fbfe3)
• remove unreachable code finance (#508) (1bc622a)
• replaced placeimg.com on loremflickr.com (#692) (2a49e82)
• solve various todos (#649) (d0a473f)
• test random.alphaNumeric (#517) (41ec6f0)
• use require/import export map in package.json (#697) (0f74908)
• Vehicle vin is always 17 characters long (#320) (d2fc1e6)

6.0.0 (2022-03-15)

Bug Fixes

• fix some lint warnings (#613) (5cb74b1b)
• docs: add image_providers jsdocs (#612) (09487b6b)
• docs: improve visualization for complex types (#608) (f038937c)
• configure eqeqeq lint rule (#595) (5cd3daef)
• fix eslint error (#597) (4f7447c3)
• docs: comment out algolia until search is available (#599) (bcc97d69)
• docs: add test for api docs generation (#574) (c99160f0)
• docs: display correct signature (#596) (c115056e)
• docs: show union options parameters (#602) (5595b9fc)

6.0.0-beta.0 (2022-03-07)

Features

• types: generate all locales index files with non-any types (#494) (b611ca1)
• types: provide strong typing for locales 2 (#398) (419e9e2)

Bug Fixes

• correcting the readme file (#529) (6c9dcdd)
• fix bicycle_types files being named incorrectly (#477) (7a2a522)
• fix time.recent method signature (#586) (60d3cc5)
• fix unique method types (#457) (14df7d3)
• handle missing or broken locales main index files (#478) (ff97431)
• move el credit card information to the expected location (#484) (dcbd18e)
• remove invalid aliases (#488) (58fbfe3)
• test random.alphaNumeric (#517) (41ec6f0)

6.0.0-alpha.7 (2022-02-20)

Features

• types: generate all locales index files with non-any types (#494) (b611ca1)
• types: provide strong typing for locales 2 (#398) (419e9e2)

Bug Fixes

• fix bicycle_types files being named incorrectly (#477) (7a2a522)
• fix unique method types (#457) (14df7d3)
• handle missing or broken locales main index files (#478) (ff97431)
• move el credit card information to the expected location (#484) (dcbd18e)
• remove invalid aliases (#488) (58fbfe3)
• test random.alphaNumeric (#517) (41ec6f0)
• build: add redirect aliases for cjs (#520) (7d806d9)
• docs: various fixes (#523) (b22cf3b)

6.0.0-alpha.6 (2022-02-10)

Features

• add chat.fakerjs.dev subdomain redirection to discord (#306) (32b4839)
• auto generate/update locale files (#252) (df48704)
• types: provide strong typing for locales (#363) (5e6754d)

Bug Fixes

• improve internet tests and fix bug in domain name generation (#258) (c6f7aa9)
• optional args on faker.finance.iban() (#431) (c71469c)
• param can be optional (#381) (f8a95a1)
• remove redundant precision from datatype.datetime options (#335) (9d5a7a2)
• removed dead code and adjusted fileExt (#304) (471bc1d)
• removed node v12 from the pipe (#309) (537f56e)
• some return types (#307) (4ca61ca)

6.0.0-alpha.5 (2022-01-25)

Bug Fixes

• revert pnpm only-allow (#291) (132e8c3)

6.0.0-alpha.4 (2022-01-24)

⚠ BREAKING CHANGES

• support tree-shaking (#152)

Features

• add autocomplete support for locales (#248) (c1f2b09)
• migrate locales to typescript (#238) (d4cfa3c)
• support tree-shaking (#152) (ccf119d)
• use export default for locales (#249) (93e8e53)

Bug Fixes

• add missing fakers for existing locales (#263) (7177d37)
• jalapeño typo (#259) (74204a0)
• ts support for locales (#169) (61d0296)
• types: fixed datetime types for optional argument (#192) (60b71fd)
• types: fixed exampleEmail arguments types (#241) (66aa374)
• typo in update.md (#180) (4a69d6d)

6.0.0-alpha.3 (2022-01-15)

Features

• add definitions (#84) (cfdfad5)
• domain_suffix: add the id, ponpes.id and net.id domains for id_ID (#137) (ce4d48e)
• migrate address (#133) (88afa60)
• migrate animal (#105) (0abec83)
• migrate commerce (#106) (82ab145)
• migrate company (#132) (0205183)
• migrate database (#89) (4d4653e)
• migrate date (#83) (0fe6f2b)
• migrate fake (#79) (8fa14c6)
• migrate finance (#131) (a1208ca)
• migrate git (#78) (6122d3c)
• migrate hacker (#81) (e0005ad)
• migrate helpers (#85) (07f8b44)
• migrate image (#92) (3c3e567)
• migrate internet (#94) (8fcfcc6)
• migrate lorem (#86) (7e6273b)
• migrate music (#107) (46d51ba)
• migrate name (#103) (de9f9d6)
• migrate phone (#127) (77f4e63)
• migrate random (#91) (efc11f1)
• migrate system (#90) (c0a6277)
• migrate time (#74) (168a211)
• migrate unique (#128) (86580d8)
• migrate vehicle (#130) (661f3b4)
• migrate word (#102) (1b10032)
• rewrite datatype to ts (e0d0b5c)

Bug Fixes

• added missing keys into package.json (#148) (b20f80b)

6.0.0-alpha.2 (2022-01-14)

6.0.0-alpha.1 (2022-01-14)

6.0.0-alpha.0 (2022-01-07)

For changes prior to version v6.0.0-alpha.1, see the old changelog.