electron
/
addon-tools-el
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

📝 Update doc

This commit is contained in:
raub 2018-05-14 11:36:47 +03:00
parent 4b642f6a2d
commit abcf86a3ba
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -699,13 +699,13 @@ EventEmitter behavior and is exported to JS.
For the C++ side `EventEmitter` has following public methods: For the C++ side `EventEmitter` has following public methods:
* `void emit(const std::string &name, int argc = 0, v8::Local<v8::Value> *argv = NULL)` * `void emit(const std::string &name, int argc = 0, v8::Local<v8::Value> *argv = NULL)` -
emits an event with the given `name` and, optionally, some additional arguments where emits an event with the given `name` and, optionally, some additional arguments where
`argc` is the number of arguments and `argv` is a pointer to the arguments array. `argc` is the number of arguments and `argv` is a pointer to the arguments array.
* `void on(const std::string &name, v8::Local<v8::Value> that, const std::string &method)` * `void on(const std::string &name, V8_VAR_FUNC cb)` -
subscribes `that[method]` to receive `name` events from this emitter, basically subscribes `cb` to receive `name` events from this emitter, basically
`emitter.on(name, that[method])`. `emitter.on(name, cb)`.
* `virtual void _destroy()` - destroys the object, i.e. deactivates it and frees * `virtual void _destroy()` - destroys the object, i.e. deactivates it and frees
resources. This is what also called inside resources. This is what also called inside
@ -784,3 +784,5 @@ receives any set of arguments.
* `inline void consoleLog(const std::string &message)` - an alias to log a single * `inline void consoleLog(const std::string &message)` - an alias to log a single
string. string.
> Note: Don't do it in GC-accessible code: sometimes it works, sometimes it crashes.