feat(types): add RcpApi, SocketApi, and PluginGraph types - #144
Open
rwendell wants to merge 1 commit into
Open
Conversation
Replace `any` on PluginInitContext.rcp and PluginInitContext.socket with proper interfaces: RcpApi (preInit, postInit, whenReady, get, graph, dependencies, dependents, names), SocketApi (observe, disconnect), SocketEventData, and PluginGraph. Also add rcp to the Window global type, and promote the new types through the internal preload re-exports.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
anyonPluginInitContext.rcpandPluginInitContext.socketwith proper interfaces derived from the actual source implementations inpackages/preload/src/preload/rcp/.RcpApi(preInit, postInit, whenReady, get, graph, dependencies, dependents, names),SocketApi(observe, disconnect),SocketEventData, andPluginGraphtopackages/types/index.d.ts.rcp: RcpApito theWindowglobal type (it is exposed as a frozen property onwindow).packages/preload/src/types.d.tsre-exports.Context
The
PluginInitContextinterface hadrcp: anyandsocket: any, which gave plugin authors no autocomplete or type safety for two of the most important APIs. These types are now derived directly from the runtime implementations, including the newgraph/dependencies/dependents/namesmethods added on thefeat/app-hubbranch.