infra(unicorn): no-useless-switch-case (#2508)

1 files changed, 20 insertions, 0 deletions

diff --git a/docs/guide/upgrading_v9/2508.md b/docs/guide/upgrading_v9/2508.md
new file mode 100644
index 00000000..28e6f8ed
--- /dev/null
+++ b/docs/guide/upgrading_v9/2508.md
@@ -0,0 +1,20 @@
+# Some methods now return undefined in Javascript when unknown enumeration values are passed
+
+Some methods would previously fallback to a default value for an option when an unknown value was passed for a enum parameter.
+Now, these methods will return undefined instead.
+This only affects usage in Javascript, as in Typescript this usage would already throw a compile-time error.
+
+For example:
+
+```ts
+faker.color.rgb({ format: 'unexpectedvalue' });
+// in Faker v8, is [ 110, 82, 190 ] like {format: "decimal"}
+// in Faker v9, is undefined
+```
+
+This affects:
+
+- The `format` property of `faker.color.rgb()` must be one of `'binary' | 'css' | 'decimal' | 'hex'` if provided
+- The `format` property of `faker.color.cmyk()`, `faker.color.hsl()`, `faker.color.hwb()`, `faker.color.lab()`, `faker.color.lch()` must be one of `'binary' | 'css' | 'decimal'` if provided
+- The `variant` property of `faker.location.countryCode()` must be one of `alpha-2`, `alpha-3`, `numeric` if provided
+- The `casing` property of `faker.string.alpha()` and `faker.string.alphanumeric()` must be one of `'upper' | 'lower' | 'mixed'` if provided