aboutsummaryrefslogtreecommitdiff
path: root/docs/guide/upgrading.md
diff options
context:
space:
mode:
authorEric Cheng <[email protected]>2022-12-06 18:13:51 -0500
committerGitHub <[email protected]>2022-12-07 00:13:51 +0100
commitc4b7ce8648cbd5ac2b224942908bccf9914e08f9 (patch)
tree82c0d99fe5c45cedb542ac05aaad3f2e8921df83 /docs/guide/upgrading.md
parent6bac476695c146a794b5337785979a7395d7dc89 (diff)
downloadfaker-c4b7ce8648cbd5ac2b224942908bccf9914e08f9.tar.xz
faker-c4b7ce8648cbd5ac2b224942908bccf9914e08f9.zip
refactor(string)!: swap `allowLeadingZeros` default to `true` (#1602)
Diffstat (limited to 'docs/guide/upgrading.md')
-rw-r--r--docs/guide/upgrading.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md
index a5e0dfee..d5833e50 100644
--- a/docs/guide/upgrading.md
+++ b/docs/guide/upgrading.md
@@ -113,3 +113,7 @@ For the old `faker.datatype.number` method you should replace with `faker.number
| `faker.datatype.number` | `faker.number.int` or `faker.number.float` |
| `faker.datatype.float` | `faker.number.float` |
| `faker.datatype.bigInt` | `faker.number.bigInt` |
+
+### `allowLeadingZeros` behavior change in `faker.string.numeric`
+
+The `allowLeadingZeros` boolean parameter in `faker.string.numeric` (in the new `string` module) now defaults to `true`. `faker.string.numeric` will now generate numeric strings that could have leading zeros by default.