(Typescript) Allow ReadonlyArrays as valid classNames parameters (#307

) * Add `ReadonlyArray<Argument>` to `Argument` * Add test * Move to seperate interface for <TS3.7 support
JedWatson · Apr 27, 2023 · 0251060 · 0251060
1 parent d52250f
commit 0251060
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -12,7 +12,8 @@ declare namespace classNames {
   type Value = string | number | boolean | undefined | null;
   type Mapping = Record<string, unknown>;
   interface ArgumentArray extends Array<Argument> {}
-  type Argument = Value | Mapping | ArgumentArray;
+  interface ReadonlyArgumentArray extends ReadonlyArray<Argument> {}
+  type Argument = Value | Mapping | ArgumentArray | ReadonlyArgumentArray;
 }
 
 interface ClassNames {

diff --git a/tests/types.ts b/tests/types.ts
@@ -20,6 +20,7 @@ classNames('bar', null, undefined, true, false, 1234);
 classNames('bar', ['abc', { foo: true }]);
 classNames('bar', ['abc', { foo: true }], { def: false, ijk: 1234 });
 classNames('abc', 1234, true, false, undefined, null, { foo: true }, ['abc', 1234, true, false, undefined, null, { foo: true }]);
+classNames('abc', 1234, true, false, undefined, null, { foo: true }, ['abc', 1234, true, false, undefined, null, { foo: true }], ['abc', 1234, true, false, undefined, null, { foo: true }] as const);
 // $ExpectError
 classNames(Symbol());
 // $ExpectError