1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc refactor: addons

Browse Source
This commit is contained in:
isaacs 2012-02-27 11:06:31 -08:00
parent 11d27367cd
commit 24a2706a3b
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/api/addons.markdown
View File

@ -1,4 +1,4 @@
## Addons # Addons
Addons are dynamically linked shared objects. They can provide glue to C and Addons are dynamically linked shared objects. They can provide glue to C and
C++ libraries. The API (at the moment) is rather complex, involving C++ libraries. The API (at the moment) is rather complex, involving
@ -24,7 +24,7 @@ compiling your module, you don't need to worry about linking to any of these
libraries. libraries.
### Hello world ## Hello world
To get started let's make a small Addon which is the C++ equivalent of To get started let's make a small Addon which is the C++ equivalent of
the following Javascript code: the following Javascript code:
@ -129,7 +129,7 @@ In cases where there is more than one `.cc` file, simply add the file name to th
obj.source = ['addon.cc', 'myexample.cc'] obj.source = ['addon.cc', 'myexample.cc']
#### Function arguments ### Function arguments
The following pattern illustrates how to read arguments from JavaScript The following pattern illustrates how to read arguments from JavaScript
function calls and return a result. This is the main and only needed source function calls and return a result. This is the main and only needed source
@ -172,7 +172,7 @@ You can test it with the following JavaScript snippet:
console.log( 'This should be eight:', addon.add(3,5) ); console.log( 'This should be eight:', addon.add(3,5) );
#### Callbacks ### Callbacks
You can pass JavaScript functions to a C++ function and execute them from You can pass JavaScript functions to a C++ function and execute them from
there. Here's `addon.cc`: there. Here's `addon.cc`:
@ -209,7 +209,7 @@ To test it run the following JavaScript snippet:
}); });
#### Object factory ### Object factory
You can create and return new objects from within a C++ function with this You can create and return new objects from within a C++ function with this
`addon.cc` pattern, which returns an object with property `msg` that echoes `addon.cc` pattern, which returns an object with property `msg` that echoes
@ -245,7 +245,7 @@ To test it in JavaScript:
console.log(obj1.msg+' '+obj2.msg); // 'hello world' console.log(obj1.msg+' '+obj2.msg); // 'hello world'
#### Function factory ### Function factory
This pattern illustrates how to create and return a JavaScript function that This pattern illustrates how to create and return a JavaScript function that
wraps a C++ function: wraps a C++ function:
@ -286,7 +286,7 @@ To test:
console.log(fn()); // 'hello world' console.log(fn()); // 'hello world'
#### Wrapping C++ objects ### Wrapping C++ objects
Here we will create a wrapper for a C++ object/class `MyObject` that can be Here we will create a wrapper for a C++ object/class `MyObject` that can be
instantiated in JavaScript through the `new` operator. First prepare the main instantiated in JavaScript through the `new` operator. First prepare the main
@ -381,7 +381,7 @@ Test it with:
console.log( obj.plusOne() ); // 13 console.log( obj.plusOne() ); // 13
#### Factory of wrapped objects ### Factory of wrapped objects
This is useful when you want to be able to create native objects without This is useful when you want to be able to create native objects without
explicitly instantiating them with the `new` operator in JavaScript, e.g. explicitly instantiating them with the `new` operator in JavaScript, e.g.
@ -507,7 +507,7 @@ Test it with:
console.log( obj2.plusOne() ); // 23 console.log( obj2.plusOne() ); // 23
#### Passing wrapped objects around ### Passing wrapped objects around
In addition to wrapping and returning C++ objects, you can pass them around In addition to wrapping and returning C++ objects, you can pass them around
by unwrapping them with Node's `node::ObjectWrap::Unwrap` helper function. by unwrapping them with Node's `node::ObjectWrap::Unwrap` helper function.