Changelog
napi

napi

napi@2.10.1

11/12/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.10.0...napi@2.10.1

napi@2.10.0

10/4/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.9.1...napi@2.10.0

napi@2.9.1

9/8/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.9.0...napi@2.9.1

napi-derive@2.9.1

9/8/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.9.0...napi-derive@2.9.1

napi@2.9.0

8/23/2022

Core changes

as_object for ClassInstance

You can use the ClassInstance as Object on the Rust side and manipulate it.

#[napi]
impl CanvasElement {
  #[napi(constructor)]
  pub fn new(mut env: Env, mut this: This, width: u32, height: u32) -> Result<Self> {
    let ctx = CanvasRenderingContext2D::into_instance(
      CanvasRenderingContext2D {
        context: Context::new(width, height, ColorSpace::default())?,
      },
      env,
    )?;
    ctx.as_object(env).define_properties(&[
      Property::new(FILL_STYLE_HIDDEN_NAME)?
        .with_value(&env.create_string("#000")?)
        .with_property_attributes(PropertyAttributes::Writable | PropertyAttributes::Configurable),
      Property::new(STROKE_STYLE_HIDDEN_NAME)?
        .with_value(&env.create_string("#000")?)
        .with_property_attributes(PropertyAttributes::Writable | PropertyAttributes::Configurable),
    ])?;
    env.adjust_external_memory((width * height * 4) as i64)?;
    this.define_properties(&[Property::new("ctx")?
      .with_value(&ctx)
      .with_property_attributes(PropertyAttributes::Default)])?;
    Ok(Self { width, height, ctx })
  }
}

as_unknown for Either types

For the scenario that preserves original JavaScript values in Either types and sets them into object property, and retrieves it back in the other place.

  #[napi(getter)]
  pub fn get_fill_style(&self, this: This) -> Result<Unknown> {
    this.get_named_property_unchecked(FILL_STYLE_HIDDEN_NAME)
  }

  #[napi(setter, return_if_invalid)]
  pub fn set_fill_style(
    &mut self,
    env: Env,
    mut this: This,
    fill_style: Either3<JsString, ClassInstance<CanvasGradient>, ClassInstance<CanvasPattern>>,
  ) -> Result<()> {
    // ... some logic
    let raw_fill_style = fill_style.as_unknown(env);  
    this.set(FILL_STYLE_HIDDEN_NAME, &raw_fill_style)?;
    Ok(())
  }

ToNapiValue for f32

You can use f32 as the return type:

#[napi]
pub fn return_f32() -> f32 {
  3.14
}

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.8.0...napi@2.9.0

napi-derive@2.9.0

8/23/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.8.0...napi-derive@2.9.0

napi@2.8.0

8/17/2022

Core changes

Custom finalize trait

https://napi.rs/docs/concepts/class#custom-finalize-logic

use napi::bindgen_prelude::*;
use napi_derive::napi;
 
#[napi(custom_finalize)]
pub struct CustomFinalize {
  width: u32,
  height: u32,
  inner: Vec<u8>,
}
 
#[napi]
impl CustomFinalize {
  #[napi(constructor)]
  pub fn new(mut env: Env, width: u32, height: u32) -> Result<Self> {
    let inner = vec![0; (width * height * 4) as usize];
    let inner_size = inner.len();
    env.adjust_external_memory(inner_size as i64)?;
    Ok(Self {
      width,
      height,
      inner,
    })
  }
}
 
impl ObjectFinalize for CustomFinalize {
  fn finalize(self, mut env: Env) -> Result<()> {
    env.adjust_external_memory(-(self.inner.len() as i64))?;
    Ok(())
  }
}

Inject This in functions

https://napi.rs/docs/concepts/inject-this

use napi::bindgen_prelude::*;
use napi_derive::napi;
 
#[napi(constructor)]
pub struct Width {
  pub value: i32,
}
 
#[napi]
pub fn plus_one(this: This<&Width>) -> i32 {
  this.value + 1
}

instance of

https://napi.rs/docs/concepts/class#instance-of

use napi::bindgen_prelude::*;
use napi_derive::napi;

#[napi]
pub struct NativeClass {}

#[napi]
pub fn is_native_class_instance(env: Env, value: Unknown) -> Result<bool> {
  NativeClass::instance_of(env, value)
}
import { NativeClass, isNativeClassInstance } from './index.js'

const nc = new NativeClass()
console.log(isNativeClassInstance(nc)) // true
console.log(isNativeClassInstance(1)) // false

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.7.0...napi@2.8.0

napi-derive@2.8.0

8/17/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.7.0...napi-derive@2.8.0

napi@2.7.0

8/7/2022

Core features

Set property attribute in napi macro

The Object property attribute in objects and Class created by NAPI-RS is Writable & Configurable & Enumerable by default now.

For NativeClass:

#[napi]
pub struct NativeClass  {}

#[napi]
impl NativeClass {
  #[napi]
  pub fn hello(&self) {
    println!("hello");
  }
}

Before:

const instance = new NativeClass()
instance.hello = function() {} // Cannot assign to read only property \'hello\' of object \'#<NativeClass>\'

After:

const instance = new NativeClass()
instance.hello = function() {} // Just fine

You can also configure the Property attribute via #[napi]:

#[napi]
pub struct NativeClass  {}

#[napi]
impl NativeClass {
  #[napi(configurable = false, writable = false, enumerable = false)]
  pub fn hello(&self) {
    println!("hello");
  }
}

What's Changed

New Contributors

napi-derive@2.7.0

8/7/2022

What's Changed

napi@2.6.3

7/11/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.6.2...napi@2.6.3

napi@2.6.2

7/8/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.6.1...napi@2.6.2

napi@2.6.1

7/6/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.6.0...napi@2.6.1

napi@2.6.0

7/6/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/@napi-rs/cli@2.10.0...@napi-rs/cli@2.10.1

napi-derive@2.6.0

7/6/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.5.0...napi-derive@2.6.0

napi@2.5.0

6/10/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.4.3...napi@2.5.0

napi-derive@2.5.0

6/10/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.4.1...napi-derive@2.5.0

napi-build@2.0.1

6/10/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-build@2.0.0...napi-build@2.0.1

napi@2.4.3

5/12/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.4.2...napi@2.4.3

napi@2.4.2

5/10/2022

What's Changed

Experimental

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.4.1...napi@2.4.2

napi-sys@2.2.2

5/10/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-sys@2.2.1...napi-sys@2.2.2

napi@2.4.1

5/7/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-sys@2.2.0...napi@2.4.1

napi@2.4.0

5/7/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.3.3...napi@2.4.0

napi-sys@2.2.1

5/7/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-sys@2.2.0...napi-sys@2.2.1

napi-sys@2.2.0

5/7/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.3.3...napi-sys@2.2.0

napi-build@2.0.0

5/7/2022

What's Changed

BREAKING

You must use napi 2.4+ with the napi-build@2

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.3.3...napi-build@2.0.0

napi@2.3.3

4/27/2022

What's Changed

Experimental

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.3.2...napi@2.3.3

napi-derive@2.3.3

4/27/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.3.2...napi-derive@2.3.3

napi-derive@2.3.2

4/27/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.3.1...napi-derive@2.3.2

napi@2.3.2

4/25/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.3.1...napi@2.3.2

napi-derive@2.3.1

4/25/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.3.1...napi-derive@2.3.1

napi@2.3.1

4/15/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.3.0...napi@2.3.1

napi@2.3.0

4/15/2022

What's Changed

  • docs: add return Promise callback function @Brooooooklyn
  • feat(napi): relax the value type on ThreadSafeFunction @Brooooooklyn
  • feat(napi-derive): support generic types on fn @Brooooooklyn
  • fix(napi-derive): JsUnknown should be unknown type @Brooooooklyn
  • feat(napi): add from_unknown method on FromNapiValue @Brooooooklyn
  • fix(napi): typo unrwap -> unwrap @waltonseymour
  • chore(napi): show tips if create different buffers with same data @Brooooooklyn
  • test(napi): add memory tests for Reference@Brooooooklyn
  • fix(napi): make buffer Send & Sync safe @Brooooooklyn
  • feat(napi): redesign the Reference API (#1118) @Brooooooklyn
  • Revert "chore: unset CARGO_BUILD_TARGET in debian.Dockerfile" @Brooooooklyn
  • chore: unset CARGO_BUILD_TARGET in debian.Dockerfile @Brooooooklyn
  • build: migrate debian image to messense/manylinux2014-cross @Brooooooklyn
  • feat(napi): experimental class reference API @Brooooooklyn
  • fix(napi): remove CString::from_vec_with_nul_unchecked @Brooooooklyn
  • feat(napi): allow empty enums @antoniomuso
  • ci: add binary build check @messense
  • fix(napi): double allocation in create_buffer @Brooooooklyn

Reference API

use napi::bindgen_prelude::*;

pub struct Repository {
  dir: String,
}

impl Repository {
  fn remote(&self) -> Remote {
    Remote { inner: self }
  }
}

pub struct Remote<'repo> {
  inner: &'repo Repository,
}

impl<'repo> Remote<'repo> {
  fn name(&self) -> String {
    "origin".to_owned()
  }
}

#[napi]
pub struct JsRepo {
  inner: Repository,
}

#[napi]
impl JsRepo {
  #[napi(constructor)]
  pub fn new(dir: String) -> Self {
    JsRepo {
      inner: Repository { dir },
    }
  }

  #[napi]
  pub fn remote(&self, reference: Reference<JsRepo>, env: Env) -> Result<JsRemote> {
    Ok(JsRemote {
      inner: reference.share_with(env, |repo| Ok(repo.inner.remote()))?,
    })
  }
}

#[napi]
pub struct JsRemote {
  inner: SharedReference<JsRepo, Remote<'static>>,
}

#[napi]
impl JsRemote {
  #[napi]
  pub fn name(&self) -> String {
    self.inner.name()
  }
}
const repo = new JsRepo('.')
t.is(repo.remote().name(), 'origin')

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/@napi-rs/cli@2.2.0...napi@2.3.0

napi@2.3.0-alpha.1

4/7/2022

Features

  • Provide Reference API to keep class reference alive with JavaScript instance.
  • Allow injecting Reference into parameters like Env.
  • Add tests to ensure no memory leak happened in the new Reference API.
  • Buffer now can be used in struct which is implemented Task trait.
use napi::bindgen_prelude::*;

pub struct Repository {
  dir: String,
}

impl Repository {
  fn remote(&self) -> Remote {
    Remote { inner: self }
  }
}

pub struct Remote<'repo> {
  inner: &'repo Repository,
}

impl<'repo> Remote<'repo> {
  fn name(&self) -> String {
    "origin".to_owned()
  }
}

#[napi]
pub struct JsRepo {
  inner: Repository,
}

#[napi]
impl JsRepo {
  #[napi(constructor)]
  pub fn new(dir: String) -> Self {
    JsRepo {
      inner: Repository { dir },
    }
  }

  #[napi]
  pub fn remote(&self, reference: Reference<JsRepo>, env: Env) -> Result<JsRemote> {
    Ok(JsRemote {
      inner: reference.share_with(env, |repo| Ok(repo.inner.remote()))?,
    })
  }
}

#[napi]
pub struct JsRemote {
  inner: SharedReference<JsRepo, Remote<'static>>,
}

#[napi]
impl JsRemote {
  #[napi]
  pub fn name(&self) -> String {
    self.inner.name()
  }
}
const repo = new JsRepo('.')
t.is(repo.remote().name(), 'origin')

napi@2.2.0

3/6/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.1.0...napi@2.2.0

napi@2.1.0

2/9/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.0.4...napi@2.1.0

napi-derive@2.1.0

2/9/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.8...napi-derive@2.1.0

napi@2.0.4

1/18/2022

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.0.3...napi@2.0.4

napi-derive@2.0.8

1/18/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.7...napi-derive@2.0.8

napi@2.0.3

1/13/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.7...napi@2.0.3

napi-derive@2.0.7

1/7/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.6...napi-derive@2.0.7

napi-derive@2.0.6

1/6/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.5...napi-derive@2.0.6

napi-derive@2.0.5

1/4/2022

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.4...napi-derive@2.0.5

napi-derive@2.0.4

12/24/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.3...napi-derive@2.0.4

napi-derive@2.0.3

12/24/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.2...napi-derive@2.0.3

napi-derive@2.0.2

12/23/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.1...napi-derive@2.0.2

napi@2.0.2

12/22/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.0.1...napi@2.0.2

napi@2.0.1

12/21/2021

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.0.0...napi@2.0.1

napi-derive@2.0.1

12/21/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.0...napi-derive@2.0.1

napi-build@1.2.1

12/21/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.0.0...napi-build@1.2.1

napi@2.0.0

12/17/2021 https://napi.rs/blog/announce-v2@Brooooooklyn

Special thanks to @forehalo for the initial version of NAPI-RS v2

And @timfish@h-a-n-a@joaomoreno@yisibl@idan-at@sam3d for contributing.

napi@2.0.0-beta.7

12/14/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.0.0-beta.6...napi@2.0.0-beta.7

napi@2.0.0-beta.6

12/13/2021

What's Changed

New Contributors

Full Changelog: https://github.com/napi-rs/napi-rs/compare/@napi-rs/cli@2.0.0-beta.5...napi@2.0.0-beta.6

napi@2.0.0-beta.5

12/8/2021

Feature

napi-derive@2.0.0-beta.5

12/8/2021

Bugfix

napi-derive@2.0.0-beta.4

12/8/2021

Feature

This feature is useful for sharing code between Node.js native addon and wasm

napi@2.0.0-beta.4

12/7/2021

Feature

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.0.0-beta.3...napi@2.0.0-beta.4

napi@2.0.0-beta.3

12/7/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.0-beta.2...napi@2.0.0-beta.3

napi-derive@2.0.0-beta.3

12/7/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.0.0-beta.3...napi-derive@2.0.0-beta.3

napi-derive@2.0.0-beta.2

12/6/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.0-beta.1...napi-derive@2.0.0-beta.2

napi@2.0.0-beta.2

12/3/2021

What's Changed

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi@2.0.0-beta.1...napi@2.0.0-beta.2

napi-sys@2.1.0

12/2/2021

Features

  • Enable node_api syntax error experimental functions #897 @idan-at
Last updated on April 15, 2022