Skip to content

Added type declarations for ESM support#25

Open
staplespeter wants to merge 1 commit intomkropat:mainfrom
staplespeter:type-declarations
Open

Added type declarations for ESM support#25
staplespeter wants to merge 1 commit intomkropat:mainfrom
staplespeter:type-declarations

Conversation

@staplespeter
Copy link
Copy Markdown

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