naskya/napi-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated threadsafe documentation to mention the first argument error convention

Browse source
This commit is contained in:
Michael Orenstein 2020-07-26 18:26:42 +09:30
parent 74cd9c49c2
commit 6b8bd01bcc
No known key found for this signature in database
GPG key ID: C452206F766B1FAD
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
napi/src/threadsafe_function.rs
View file

@ -48,6 +48,10 @@ pub trait ToJs: Copy + Clone {
/// ///
/// fn resolve(&self, env: &mut Env, output: Self::Output) -> Result<Vec<JsUnknown>> { /// fn resolve(&self, env: &mut Env, output: Self::Output) -> Result<Vec<JsUnknown>> {
/// let value = env.create_uint32(output as u32)?.into_unknown()?; /// let value = env.create_uint32(output as u32)?.into_unknown()?;
/// // The first argument in the NodeJS callback will be either a null or an error
/// // depending on the result returned by this function.
/// // If this Result is Ok, the first argument will be null.
/// // If this Result is Err, the first argument will be the error.
/// Ok(vec![value]) /// Ok(vec![value])
/// } /// }
/// } /// }
@ -200,7 +204,9 @@ unsafe extern "C" fn call_js_cb<T: ToJs>(
let status; let status;
// Follow the convention of Node.js async callback. // Follow async callback conventions: https://nodejs.org/en/knowledge/errors/what-are-the-error-conventions/
// Check if the Result is okay, if so, pass a null as the first (error) argument automatically.
// If the Result is an error, pass that as the first argument.
if ret.is_ok() { if ret.is_ok() {
let values = ret.unwrap(); let values = ret.unwrap();
let js_null = env.get_null().unwrap(); let js_null = env.get_null().unwrap();