Does it support typescript? Write the dts file

[phk422]

I added the types file

[mohamedfrindi]

@phk422

Firstly, thanks for your contribution. I don't know what role this file will serve. I hope for more clarification.

[phk422]

In TypeScript, .d.ts files (declaration files) are used to provide type information for JavaScript libraries. These files serve the purpose of offering type definitions for variables, functions, and objects in JavaScript libraries, as JavaScript itself lacks explicit type information, while TypeScript is a statically-typed language that requires knowledge of types during compilation.

Here are some reasons why separate .d.ts files are needed:

1. Type Definitions: JavaScript libraries typically lack type information, and .d.ts files act as type definition files, providing TypeScript with information about the types of variables, functions, and objects in the library.

2. Compile-Time Type Checking: TypeScript performs type checking during compilation. .d.ts files allow developers to provide type information for pure JavaScript libraries, catching potential type errors during development.

3. Editor Support: TypeScript editors leverage .d.ts files to offer intelligent code completion, error checking, and navigation. This enhances the developer experience when working with JavaScript libraries, making it easier to understand the library's API and reducing potential errors.

4. Declaration of Global Variables: .d.ts files can be used to declare the types of global variables when working with JavaScript libraries that use global scope. This helps TypeScript recognize and infer the types of these variables correctly.

5. Third-Party Library Support: Third-party libraries often lack built-in type definitions, but installing the corresponding @types/ package, such as @types/lodash, provides the necessary type information. These type definition files typically have a .d.ts extension.

For example, if you're using a JavaScript library named lodash, you can obtain type support for this library by installing @types/lodash. These type definition files usually have a .d.ts extension, providing TypeScript with the necessary information to interact with the lodash library safely.

In summary, .d.ts files introduce type support for JavaScript libraries in TypeScript projects, enhancing the safety and maintainability of interactions between TypeScript and JavaScript libraries.

[mohamedfrindi]

@phk422

Thanks for the clarification.

[mohamedfrindi]

@phk422

I hope you can contribute to adding many effects to this library.

[phk422]

@mohamedfrindi

No problem, I will try it after work. I hope you can publish the type definition to the npm repository as soon as possible for use.

[mohamedfrindi]

@phk422
I added the update, thanks for your contribution (v1.7.0)