Skip to content

v0.6.0

Compare
Choose a tag to compare
@jacob-alford jacob-alford released this 21 Aug 18:20
· 36 commits to main since this release

What's Changed

Breaking Changes

  • feat(dts): strip internal by default, add dts compiler overrides option by @jacob-alford in #11

Summary

  • Now TypeScript will strip anything marked with the @internal jsdoc tag. See the relevant documentation.
  • There is now an available config option to override compiler options. Do not use this option unless you know what you are doing.

Note to library authors

If you use the @internal JSDoc tag, this will likely result in a breaking change for your library as those types will no longer be included in the final output.

If you wish to continue including those internal types as to avoid a breaking change, pass the following to the configuration which will override the new default option.

{
  dtsCompilerOverrides: {
    stripInternal: false
  }
}

A word of caution

If one of your exports depends on something that is marked with an @internal tag, this will result in an error during type compilation. This should be caught during lib-check, so do not disable that option.

Full Changelog: v0.5.0...v0.6.0