neon-bindings / website Goto Github PK

https://github.com/nodejs/node-addon-examples

Ideally, we could have a neon example for each example

Some good examples would be:

• fibonacci fn in and then show neon version

• Performance comparisons between native module and node module

• https://github.com/BuckleScript/bucklescript.github.io/blob/source/crowdin.yaml
• https://github.com/BuckleScript/bucklescript.github.io
• https://docusaurus.io/docs/en/translation

• USB Bindings
• SQLite Library
• Crypto Library

// --snip--
method poll(mut cx) {
  let cb = cx.argument::<JsFunction>(0)?;
  let this = cx.this();
  let events = cx.borrow(&this, |emitter| Arc::clone(&emitter.events));
  let emitter = EventEmitterTask(events);

  emitter.schedule(cb);

  Ok(JsUndefined::new().upcast())
}
// --snip--

Taken from neon-bindings/neon#386

https://amilajack.github.io/neon-docs/docs/en/word-counting-guide

References vm::lock, which was removed from the API

It expired a while ago. A new one should be made

• Modules
  • Exporting values, objects, functions, and classes
• Errors
  • Throwing TypeErrors, RangeErrors, and Errors
  • Catching Errors
• Classes
  • Creating subclasses
• Global Object
  • Accessing the global object
• Advanced
  • cx.borrorw_mut cx.exceute_scoped

• cx.borrow(this, |contents| { ... })
• let body = cx.borrow(&body, |contents| contents.as_slice());

See https://rust-bindings.slack.com/archives/C0H978T55/p1532463490000347

The project homepage says "this recording has been archived" at the bottom for the asciinema thing.

Document configs for the following files

• .gitignore: should ignore target
• .editorconfig: 4 spaces for toml and rs extensions
• .travis.yml
• appveyor.yml

When looking on the main site, the link to the demo shows this:

And when clicking the link, it shows a page that reads "All unclaimed recordings (the ones not linked to any user account) are automatically archived 7 days after upload."

The documentation at https://neon-bindings.com/docs/json has "JSON" as its title, but the contents of the page don't actually have anything to do with JSON (which is a separate language from JS entirely); rather, they're about serializing/deserializing JS data structures.

I'd suggest that "Data structures" is probably a better title for this page.

I'd create a PR, but unfortunately it seems that simply renaming json.md and its metadata will result in the original https://neon-bindings.com/docs/json URL breaking, and I'm not sure how redirects are handled in this setup.

These kinds of examples will make it easier for JS programmers to see JS concepts map to Rust and Neon concepts

// JS
function foo() {
  let t = true;
  this.modified = t
  return undefined
}

// neon equivalent
pub fn require_object_this(mut cx: FunctionContext) -> JsResult<JsUndefined> {
    let this = cx.this();
    // Downcast `this` so .set can be called on it
    let this = this.downcast::<JsObject>().or_throw(&mut cx)?;
    let t = cx.boolean(true);
    // Equivalent to  `this.modified = true` in JS
    this.set(&mut cx, "modified", t)?;
    Ok(cx.undefined())
}

https://github.com/ballwood/snips-nlu-js/blob/master/native/src/lib.rs

• Discuss internals of neon
• Explain handles

• use to_vec

• Why Neon
  • rust infra simplicity vs c/c++ complexity
• Basics
  • Primitives
  • Array
  • Object
  • Classes
  • Functions
  • Arguments
  • JSON
  • Async
  • Parallelism
  • Macros
• Types
  • Upcasting
  • Downcasting
  • Type Checking with .is_a()
• Guides
  • Word Counting
  • SDL2 Bindings
• Context
  • FunctionContext
  • MethodContext
• vm::*
• Advanced
• Misc
  • Example Projects
  • Community Content

On this page, there's a link to a supposed "Handles and Memory guide" at https://neon-bindings.com/handles-and-memory/, but that link doesn't work.

I've not read the documentation exhaustively yet, but at a glance I couldn't identify any existing pages that include this topic. Was this guide removed, or did it simply never exist? It seems like a pretty crucial topic to me :)

https://www.nearform.com/blog/the-future-of-native-modules-in-node-js/

• When to use Neon over WASM

Use Volta repo as example

https://github.com/neon-bindings/neon/pull/333/files

See electron-react-boilerplate/docs#31

In the Hello World guide, the link to the Electron app guide (3rd paragraph, last sentence), points to this broken link. I think it's supposed to point here.

The docs are not detailed enough and are very 'example-based'. The need to discuss the details of Neon more. They should be modeled after Rust's docs

I'm a bit confused by the example that lets you call a JS function within Rust. Having a heck of a time comprehending the Calling JS functions section located at https://neon-bindings.com/docs/functions. Keep in mind I'm early in my Rust learnings (so bear with me).

See neon-bindings/neon#382 (comment)

Using eslint-config-bliss and eslint-config-airbnb