-
Notifications
You must be signed in to change notification settings - Fork 6
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
Create documentation and strong types, similar to signify-browser-extension #10
Comments
One additional thing that would be good to include is the error handling. How does the content script indicate to polaris-web that a particular request has failed? |
@HunnySajid per @lenkan question can you respond here and let us know if this can be closed? |
Regarding the error handling. There is now a mechanism for that, see for example this test here: polaris-web/src/client.test.ts Lines 145 to 158 in bcb5283
polaris-web/src/client.test.ts Lines 21 to 27 in bcb5283
In other words, if you add a "error" property to the response message, it will be treated as an error. |
Also, the example app provides sufficient standalone documentation in my opinion. |
@lenkan and others will use polaris-web without knowledge of the signify-browser-extension and currently that's where the interface and methods are documented.
Improve this repo to 'stand-alone' with documentation that guides and extension implementor to be to quickly understand the inputs/outputs.
Also consider a future issue to address versioning as we move forward (potentially create additional issues).
The text was updated successfully, but these errors were encountered: