feat!: remove inspect symbol from public interface #247
Conversation
The inspect symbol being part of the public interfaces causes type incompatibilities between otherwise compatible versions of this library. Typescript treats the symbol as unique, even though the same symbol will be used across versions. Eg: Library A uses @multiformats/[email protected] Library B uses A and @multiformats/[email protected] The types will not match and there will be a type error: ``` error TS2741: Property '[inspect]' is missing in type 'import("/path/to/B/node_modules/@multiformats/multiaddr/dist/src/index").Multiaddr' but required in type 'import("/path/to/B/node_modules/A/node_modules/@multiformats/multiaddr/dist/src/index").Multiaddr'. ```
|
cc @achingbrain |
|
How have you ended up with multiple semver-compatible versions of Are your deps shrinkwrapped? |
|
We're using yarn. I guess it doesn't dedupe and hoist |
|
I think you have to run it as a separate command. That file says:
What happens if you delete all of your project lockfiles and reinstall - do you still get duplicate |
|
Sure enough... I don't get duplicate Still think this is a good PR. (or i guess alternatively, we should create a |
|
related to #202 |
|
Superseded by #274 |
The inspect symbol being part of the public interfaces causes type incompatibilities between otherwise compatible versions of this library.
Typescript treats the symbol as unique, even though the same symbol will be used across versions.
Eg:
Library A uses @multiformats/[email protected]
Library B uses A and @multiformats/[email protected]
The types will not match and there will be a type error: