Added a typescript defs file

[maraisr]

Not sure we need all the fancy things from that @types/classnames repo - but here is something nice and tight.

If you're not too keen; happy to amend this with a simple copy-paste from their one, and rename somethings.

resolves #3

[lukeed]

@kentcdodds looks good to me, how about to you?

[kentcdodds]

Once we fix the exports this'll be ready.

Thanks for considering including this @lukeed!

We'll also need to add index.d.ts to the package.json files property.

[lukeed]

Aye, I'll take care of properly distributing the types to npm – that's about all I can contribute here.

As per Twitter thread, I can't really weigh in on the right/wrong/better ways for typings, so once you all come to an agreement I'll merge.

---

I will say that multiple of my repos have been PR'd with export = lib. @marvinhagemeister shared this link with me about it.

[kentcdodds]

I'm pretty new to TS, but from what I understand export = is an old way to do things that pre-dates the ESModules specification. In my own version of these definitions, I'm using export default and that's working well 👍 (plus export {ClassArray, ClassDictionary, ClassValue})

[lukeed]

Ah, then I suppose the above was specific to kleur since it's Node/CommonJS only & can be required as default or partially.

[lukeed]

Is this final form?

export type ClassValue = ClassArray | ClassDictionary | string | number | null | boolean;

export interface ClassDictionary {
	[id: string]: any;
}

export interface ClassArray extends Array<ClassValue> { }

declare const clsx: (...classes: ClassValue[]) => string;

export default clsx;

[kentcdodds]

Yep, I think that'll do it!

[marvinhagemeister]

yup, the export = foo way is only needed when the library doesn't use proper exports and uses plain CommonJS style exports (module.exports = foo) instead. The only exception is when the special __esModule property is defined on exports:

// Note: exports === module.exports 
Object.defineProperty(exports, "__esModule", { value: true });

In the case for clsx the proper way to do it is via a export default expression as already suggested 👍

[kentcdodds]

Thanks for the help @marvinhagemeister!

[lukeed]

Thank you @marvinhagemeister, makes sense~!

And thank you all, especially @maraisr, for the types. Since they are so simple & small, I'll just add them here after all. Patch incoming~

[kentcdodds]

👏

[lukeed]

Released in 1.0.1 🙌