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.

Sign up for GitHub

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

Add usage example for JsPromise wrapper #2804

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add usage example for JsPromise wrapper #2804

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1dc7414
added jspromise example
lvllvl Apr 11, 2023
bd61b6b
updated jspromise example with comments
lvllvl Apr 12, 2023
4153843
adding comments to code
lvllvl Apr 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions boa_examples/src/bin/jspromise.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
use std::error::Error;
use boa_engine::{
job::SimpleJobQueue,
object::builtins::JsPromise,
builtins::promise::PromiseState,
Context, JsValue, js_string};

fn main() -> Result<(), Box<dyn Error>> {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example looks good, but looking at other examples, we should be adding more comments through the code, explaining what each step does.

Also, is there any other API usage we can show?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added comments to the code.

Do you mean that this example should use more of the api or that there should be another jspromise example in addition to this one?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably that the example should use more methods of JsPromise.


let queue = &SimpleJobQueue::new();
let context = &mut Context::builder().job_queue(queue).build()?;

let promise = JsPromise::new(|resolvers, context| {
let result = js_string!("hello world").into();
resolvers.resolve.call(&JsValue::undefined(), &[result], context)?;
Ok(JsValue::undefined())
}, context)?;

context.run_jobs();

assert_eq!(promise.state()?, PromiseState::Fulfilled(js_string!("hello world").into()));
Ok(())
}
jedel1043 marked this conversation as resolved.
Show resolved Hide resolved