feat: add named clsx export alias (#44)

* Provide named export for clsx * update readme * update types * update test file Co-authored-by: Luke Edwards <[email protected]>
lukeed · Jul 2, 2022 · 56ab81f · 56ab81f
1 parent 74cefa6
commit 56ab81f
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 13 deletions.
diff --git a/clsx.d.ts b/clsx.d.ts
@@ -1,11 +1,6 @@
 export type ClassValue = ClassArray | ClassDictionary | string | number | null | boolean | undefined;
+export type ClassDictionary = Record<string, any>;
+export type ClassArray = ClassValue[];
 
-export interface ClassDictionary {
-	[id: string]: any;
-}
-
-export interface ClassArray extends Array<ClassValue> { }
-
-declare const clsx: (...classes: ClassValue[]) => string;
-
+export declare function clsx(...inputs: ClassValue[]): string;
 export default clsx;
diff --git a/readme.md b/readme.md
@@ -20,6 +20,8 @@ $ npm install --save clsx
 
 ```js
 import clsx from 'clsx';
+// or
+import { clsx } from 'clsx';
 
 // Strings (variadic)
 clsx('foo', true && 'bar', 'baz');

diff --git a/src/index.js b/src/index.js
@@ -26,7 +26,7 @@ function toVal(mix) {
 	return str;
 }
 
-export default function () {
+export function clsx() {
 	var i=0, tmp, x, str='';
 	while (i < arguments.length) {
 		if (tmp = arguments[i++]) {
@@ -38,3 +38,5 @@ export default function () {
 	}
 	return str;
 }
+
+export default clsx;
diff --git a/test/index.js b/test/index.js
@@ -1,9 +1,16 @@
 import test from 'tape';
-import fn from '../src';
+import * as mod from '../src';
 
-test('clsx', t => {
-	t.is(typeof fn, 'function', 'exports a function');
-	t.is(typeof fn(), 'string', '~> returns string output');
+const fn = mod.default;
+
+test('exports', t => {
+	t.is(typeof mod.default, 'function', 'exports default function');
+	t.is(typeof mod.clsx, 'function', 'exports named function');
+	t.ok(mod.default === mod.clsx, 'exports are equal');
+
+	t.is(typeof mod.default(), 'string', '~> returns string output');
+	t.is(typeof mod.clsx(), 'string', '~> returns string output');
+
 	t.end();
 });