Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added type declarations for ESM support #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

staplespeter
Copy link

Type declaration generation process:

  1. Install TypeScript
    >npm i typescript --save-dev

  2. Create tsconfig.json

{
  "include": ["index.js", "lib/*.js"],
  "compilerOptions": {
    "allowJs": true,
    "declaration": true,
    "emitDeclarationOnly": true,
    "declarationMap": true
  }
}
  1. Produce type files
    >tsc --build

  2. Edit index.d.ts, adding the following as the last export
    export * from "./lib/character-sets";

Tested by using in a project, building and running on NodeJS

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant