Export TS types in a separate entry point via 'mediasoup-client/types' #308
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Details
The idea is that, instead of exporting types like this:
```ts
import { types as mediasoupClientTypes } from 'mediasoup-client';
```
We import them this way:
```ts
import types as mediasoupClientTypes from 'mediasoup-client/types';
```
## TODO 1
I've briefly tested this and it looks like for this to work, the parent application must have in its `tsconfig.json`:
```
"module": "nodenext",
"moduleResolution": "nodenext",
```
Is this ok? Any other implications?
## TODO 2
Should we stop exporting `types` from 'mediasoup-client' and instead force applications to import them from 'mediasoup-client/types'?
## TODO 3
We should export `HandlerInterface` type so applications do not need to do this ugly thing:
```ts
import { HandlerFactory as MediasoupClientHandlerFactory } from 'mediasoup-client/lib/handlers/HandlerInterface';
```
…ced by the new "exports"
If the application does not set such values (for any reason they may have), can it still use the old way of importing the types? |
|
I am not sure. I've tried to test using mediasoup-demo client app but it's SUPER OLD and doesn't even use TypeScript so we are lost here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
The idea is that, instead of exporting types like this:
We import them this way:
I've also removed "main" and "types" fields in
package.jsonsince they are replaced by the new "exports" field.Related documentation
TODO 1
I've briefly tested this and it looks like for this to work, the parent application must have in its
tsconfig.json:Is this ok? Any other implications?
TODO 2
Should we stop exporting
typesfrom 'mediasoup-client' and instead force applications to import them from 'mediasoup-client/types'?TODO 3
We should export
HandlerInterfacetype so applications do not need to do this ugly thing: