joshwcomeau / use-sound

A React Hook for playing sound effects

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Types] Add Howler types as optional peer dependency

jdeblasse opened this issue · comments

Consider changing your package.json file to have @types/howler as a peer dependency that's optional. Optional is important because not everyone uses Typescript.

You package.json would then look something like this (depends on your deps conventions for SEMVER et al):

  "peerDependencies": {
    "react": ">=16.8",
    "@types/howler": "^2.1.0",
  },
  "peerDependenciesMeta": {
    "@types/howler": {
      "optional": true
    }
  }

This will let users know that it's a recommended peer dependency when adding to their projects. This will resolve some of the repetitive open issues with regards to missing type definitions.