fix(core): return type alias instead of string from css and cx (#835

)
callstack · Sep 12, 2021 · 7eb9d94 · 7eb9d94
1 parent ca5232a
commit 7eb9d94
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/packages/core/src/css.ts b/packages/core/src/css.ts
@@ -1,10 +1,12 @@
 import type { CSSProperties } from './CSSProperties';
 import type { StyledMeta } from './StyledMeta';
 
+export type LinariaClassName = string & { __linariaClassName: true };
+
 type CSS = (
   strings: TemplateStringsArray,
   ...exprs: Array<string | number | CSSProperties | StyledMeta>
-) => string;
+) => LinariaClassName;
 
 const css: CSS = () => {
   throw new Error(

diff --git a/packages/core/src/cx.ts b/packages/core/src/cx.ts
@@ -1,9 +1,18 @@
-export type ClassName = string | false | void | null | 0;
+import { LinariaClassName } from './css';
 
-type CX = (...classNames: ClassName[]) => string;
+export type ClassName<T = string> = T | false | void | null | 0 | '';
 
-const cx: CX = function cx() {
-  return Array.prototype.slice.call(arguments).filter(Boolean).join(' ');
+interface ICX {
+  (...classNames: ClassName<LinariaClassName>[]): LinariaClassName;
+  (...classNames: ClassName[]): string;
+}
+
+const cx: ICX = function cx() {
+  const result = Array.prototype.slice
+    .call(arguments)
+    .filter(Boolean)
+    .join(' ');
+  return result as LinariaClassName;
 };
 
 export default cx;
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -2,3 +2,4 @@ export { default as css } from './css';
 export { default as cx } from './cx';
 export type { CSSProperties } from './CSSProperties';
 export type { StyledMeta } from './StyledMeta';
+export type { LinariaClassName } from './css';