ecosia / vue-safe-html

A Vue directive which renders sanitised HTML dynamically
Other
26 stars 4 forks source link

The package isn't "TypeScript-ready" as stated in the docs #90

Open lukaszarpak opened 1 year ago

lukaszarpak commented 1 year ago

Describe the bug There aren't any declaration files inside node_modules for this package therefore it doesn't work with Typescript.

To Reproduce Install the package as described in the docs and try to compile the project with strict flag from TS.

Expected behavior index.d.ts file should be present inside node_modules/vue-safe-html

Temporary workaround Add index.d.ts to your vue.js project with following content:

declare module "vue-safe-html" {
  import { Plugin } from "vue";

  declare const plugin: Plugin;
  export default plugin;

  export const allowedTags: string[];
}
LostCrew commented 10 months ago

Thank you @lukaszarpak for the suggestion. I will add the defs and push a new minor version soon