Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document IPC XHR API #87

Closed
trevnorris opened this issue Jan 5, 2023 · 2 comments
Closed

Document IPC XHR API #87

trevnorris opened this issue Jan 5, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@trevnorris
Copy link
Contributor

trevnorris commented Jan 5, 2023

The ipc:// API needs to be fully documented. Especially since Windows requires using http:// instead of ipc://.

The socket-api repo does exist, but it serves as a complete porcelain API. Not just simple examples of how to use the plumbing IPC commands.

Note: After discussion, it was decided that the IPC XHR API would be kept private for the time being. Making it an officially supported API this early would bring a lot of pain in the future. This should still be documented, but the priority has dropped because of this.

@trevnorris trevnorris added the documentation Improvements or additions to documentation label Jan 5, 2023
@jwerle
Copy link
Member

jwerle commented Jan 5, 2023

We have it somewhat documented inline in bridge.cc

something official would be great

@trevnorris trevnorris changed the title Document IPC API Document IPC XHR API Jan 17, 2023
@trevnorris
Copy link
Contributor Author

Now that socket-api has been merged into socket, we will consider the IPC XHR API as internal. Hence no need for public documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants