hyperlight-dev / hyperlight-dev/hyperlight-js
Review handling of consumed sandboxes in the JS API
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13
- Forks
- 5
- Avg merge
- 8d 10h
- Merged PRs (30d)
- 13
Description
I am not a big fan of getters throwing errors, as that's an unexpected behaviour for a getter.
At the same time, I am not sure what would be the correct result to return form a consumed sandbox, maybe false? maybe null? but I guess returning null is not too different from throwing.
I propose we leave it as it is right now, and we get someone with more JS API design experience to take a look into it. I'll open an issue so that we don't forget about it.
Originally posted by @jprendes in https://github.com/hyperlight-dev/hyperlight-js/pull/69#discussion_r3073438031
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the JavaScript API's sandbox getters and the discussion linked from pull request #69. Determine the expected behavior when a sandbox has been consumed, then document the chosen API behavior and add or update the relevant tests if the project identifies them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100