napi-rs

2.14.8 (2023-02-16)

Bug Fixes

• cli: always generate typedef file even native code never changes (#1489) (7281f53)

Error::new API enhancement

Error::new now support passing status: AsRef<str> and message: ToString

pub enum CustomError {
  NapiError(Error<Status>),
  Panic,
}

impl AsRef<str> for CustomError {
  fn as_ref(&self) -> &str {
    match self {
      CustomError::Panic => "Panic",
      CustomError::NapiError(e) => e.status.as_ref(),
    }
  }
}

#[napi]
pub fn custom_status_code() -> Result<(), CustomError> {
  Err(Error::new(CustomError::Panic, "don't panic"))
}

test('custom status code in Error', (t) => {
  t.throws(() => customStatusCode(), {
    code: 'Panic',
  })
})

What's Changed

• fix(napi): support custom status in Error by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1486

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.11.1

Spread tuple arguments in ThreadsafeFunction

#[napi]
pub fn accept_threadsafe_function_tuple_args(func: ThreadsafeFunction<(u32, bool, String)>) {
  thread::spawn(move || {
    func.call(
      Ok((1, false, "NAPI-RS".into())),
      ThreadsafeFunctionCallMode::NonBlocking,
    );
  });
}

⬇️⬇️⬇️⬇️⬇️⬇️⬇️

export function acceptThreadsafeFunctionTupleArgs(func: (err: Error | null, arg0: number, arg1: boolean, arg2: string) => any): void

What's Changed

• feat(napi): convert ToNapiValue tuple to variadic tsfn by @h-a-n-a #1475
• fix(napi): convert u64 to u32 in serialization by @m1212e in https://github.com/napi-rs/napi-rs/pull/1478

New Contributors

• @m1212e made their first contribution in https://github.com/napi-rs/napi-rs/pull/1478

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.11.0

What's Changed

• fix(napi): impl Send Sync to External by @Brooooooklyn

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.10.17

2.14.7 (2023-02-08)

Bug Fixes

• cli: JS bindgen file now respects destDir (#1481) (cb529d2)

What's Changed

• fix(napi): dropping Error should not call sys if feature is set to noop by @h-a-n-a in https://github.com/napi-rs/napi-rs/pull/1477

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.10.16

What's Changed

• build(deps): bump http-cache-semantics from 4.1.0 to 4.1.1 by @dependabot in https://github.com/napi-rs/napi-rs/pull/1472
• chore(napi): enhance the error messages while converting types failed by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1473

Full Changelog: https://github.com/napi-rs/napi-rs/compare/@napi-rs/[email protected]@2.10.15

2.14.6 (2023-02-02)

Note: Version bump only for package @napi-rs/cli

What's Changed

• fix(napi-derive): incorrect Task output type in some cases by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1466

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.10.1

What's Changed

• fix(napi): run_script return type by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1467

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.10.14

2.14.5 (2023-01-29)

Bug Fixes

• cli: upload GitHub assets issue (a302c9c)

What's Changed

• fix(napi): also apply electron external data fallback to lowlevel APIs by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1458

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.10.13

What's Changed

• fix(napi): add missing NoExternalBuffersAllowed by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1457

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.10.12

What's Changed

• fix(napi): fallback to copy arraybuffer if zero copy is not allowed by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1455

Background

Electron disallowed the create_external_xxx API since electron@21: https://www.electronjs.org/blog/v8-memory-cage
NAPI-RS will fallback to use create_buffer_copy if napi_create_external_buffer return the napi_no_external_buffers_allowed status.

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.10.11

Highlights

ThreadsafeFunction as params and object fields

#[napi]
pub fn accept_callback(callback: ThreadsafeFunction<u32>) {
  std::thread::spawn(move || {
    callback.call(200);
  });
}

⬇️⬇️⬇️⬇️⬇️

export function acceptCallback(callback: (err: Error | null, value: number) -> any)

Disable ToNapiValue for Object

With the object_to_js = false filed, the ThreadsafeFunction could be set as an Object field.

#[napi(object, object_to_js = false)]
pub struct Options {
  pub enable_jsx: bool,
  pub on_data: ThreadsafeFunction<Vec<u8>>,
}

What's Changed

• feat(napi-derive): generate ThreadsafeFunction types by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1449
• feat(napi-derive): allow partial implement From/To Napivalue for Object by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1448
• chore(napi-derive): allow unsafe async &mut self by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1453

Full Changelog: https://github.com/napi-rs/napi-rs/compare/@napi-rs/[email protected]@2.10.0

What's Changed

• chore(napi): implement FromNapiValue for ThreadsafeFunction by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1447
• fix(napi): throw fatal error if cast return value failed by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1450
• fix(napi): add UnknownReturnValue to use in call_async scenario by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1451
• fix(napi): unhandled promise rejection while using EitherN<Promise<..>> by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1452

Full Changelog: https://github.com/napi-rs/napi-rs/compare/@napi-rs/[email protected]@2.10.10

2.14.4 (2023-01-20)

Bug Fixes

• napi: build error with [email protected] (2f52793)

What's Changed

• fix(napi): fallback to copy buffer if zero-copy is not allowed by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1445

Background

Electron disallowed the create_external_xxx API since electron@21: https://www.electronjs.org/blog/v8-memory-cage
NAPI-RS will fallback to use create_buffer_copy if napi_create_external_buffer return the napi_no_external_buffers_allowed status.

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.10.9

What's Changed

• chore(sys): add napi_no_external_buffers_allowed to Status by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1445

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.2.3

What's Changed

• fix(napi): remove useless aquire while creating ThreadsafeFunction by @Brooooooklyn in https://github.com/napi-rs/napi-rs/pull/1442

Full Changelog: https://github.com/napi-rs/napi-rs/compare/[email protected]@2.10.8