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

docs: add taste codes in README

Browse source
This commit is contained in:
LongYinan 2020-04-30 18:57:04 +08:00
parent 4b52a40206
commit ea50a0c130
No known key found for this signature in database
GPG key ID: A3FFE134A3E20881
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -26,6 +26,23 @@ This library depends on N-API and requires Node 8.9 or later. It is still pretty
One nice feature is that this crate allows you to build add-ons purely with the Rust toolchain and without involving `node-gyp`. One nice feature is that this crate allows you to build add-ons purely with the Rust toolchain and without involving `node-gyp`.
## Taste
```rs
#[js_function(1)] // ------> argument length, omit for zero
fn fibonacci<'env>(ctx: CallContext<'env>) -> Result<Value<'env, Number>> {
let n = ctx.get::<Number>(0)?.try_into()?;
ctx.env.create_int64(fibonacci_native(n))
}
#[inline]
fn fibonacci_native(n: i64) -> i64 {
match n {
1 | 2 => 1,
_ => fibonacci_native(n - 1) + fibonacci_native(n - 2),
}
}
```
## Building ## Building
This repository is a Cargo crate. Any napi-based add-on should contain `Cargo.toml` to make it a Cargo crate. This repository is a Cargo crate. Any napi-based add-on should contain `Cargo.toml` to make it a Cargo crate.