napi-derive

/// `constructor` option for `struct` requires all fields to be public,
/// otherwise tag impl fn as constructor
/// #[napi(constructor)]
#[napi]
pub struct Animal {
  #[napi(readonly)]
  /// Kind of animal
  pub kind: Kind,

  name: String,
}

#[napi]
impl Animal {
  /// This is the constructor
  #[napi(constructor)]
  pub fn new(kind: Kind, name: String) -> Self {
    Animal { kind, name }
  }

  /// This is a factory method
  #[napi(factory)]
  pub fn with_kind(kind: Kind) -> Self {
    Animal {
      kind,
      name: "Default".to_owned(),
    }
  }

  #[napi(getter)]
  pub fn get_name(&self) -> &str {
    self.name.as_str()
  }

  #[napi(setter)]
  pub fn set_name(&mut self, name: String) {
    self.name = name;
  }

  /// This is a
  /// multi-line comment
  /// with an emoji 🚀
  #[napi]
  pub fn whoami(&self) -> String {
    match self.kind {
      Kind::Dog => {
        format!("Dog: {}", self.name)
      }
      Kind::Cat => format!("Cat: {}", self.name),
      Kind::Duck => format!("Duck: {}", self.name),
    }
  }

  #[napi]
  /// This is static...
  pub fn get_dog_kind() -> Kind {
    Kind::Dog
  }
}

⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️ ```ts /

constructor option for struct requires all fields to be public,
otherwise tag impl fn as constructor
#[napi(constructor)] */ export class Animal { / Kind of animal */ readonly kind: Kind / This is the constructor */ constructor(kind: Kind, name: string) / This is a factory method */ static withKind(kind: Kind): Animal get name(): string set name(name: string) /
- This is a
- multi-line comment
- with an emoji 🚀 */ whoami(): string / This is static... */ static getDogKind(): Kind } ```

napi-derive@2.0.0-alpha.9

11/26/2021

Features

Support rename function args and return type #884 @Brooooooklyn

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

#[napi(ts_args_type = "a: { foo: number }", ts_return_type = "string[]")]
fn ts_rename(a: Object) -> Result<Object> {
  a.get_property_names()
}

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

export function tsRename(a: { foo: number }): string[]

napi-derive@2.0.0-alpha.6

11/16/2021

What's Changed

Generate TypeScript optional types from Rust Option

#[napi]
fn map_option(val: Option<u32>) -> Option<u32> {
  val.map(|v| v + 1)
}

export function mapOption(val?: number | undefined | null): number | undefined | null

#[napi]
pub struct Context {
  data: String,
  pub maybe_need: Option<bool>,
}

export class Context {
  maybeNeed?: boolean | undefined | null
}

#[napi]
fn read_file<T: Fn(Result<()>, Option<String>) -> Result<()>>(callback: T) {
  match read_file_content() {
    Ok(s) => callback(Ok(()), Some(s)),
    Err(e) => callback(Err(e), None),
  }
  .unwrap();
}

export function readFile(callback: (arg0: Error | undefined, arg1?: string | undefined | null) => void): void

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

napi-derive@2.0.0-alpha.5

11/16/2021

What's Changed

fix(napi-derive-backend): JsBuffer should map to Buffer type https://github.com/napi-rs/napi-rs/commit/b8bcdd9c0459cbaf255387da2c2373216dc8cd87 @Brooooooklyn

Full Changelog: https://github.com/napi-rs/napi-rs/compare/napi-derive@2.0.0-alpha.4...napi-derive@2.0.0-alpha.5