Permalink
Browse files

Document silent function in README. #7

  • Loading branch information...
1 parent 063d744 commit 3aec2003045ac3e25cef4ab52ec08a53c1cff553 @xavi- committed Feb 24, 2014
Showing with 2 additions and 1 deletion.
  1. +2 −1 README.md
View
@@ -11,7 +11,8 @@ When `require("copy-paste")` is executed, two global functions are added:
**Note**: The synchronous version of `paste` is not always availabled. Unfortunately, I'm having a hard time finding a synchronous version of `child_process.exec` that consistently works on all platforms, especially windows. An error message is shown if the synchronous version of `paste` is used on an unsupported platform. That said, the asyncchronous version of `paste` is always available.
-If you do not want to pollute the global namespaced call `require("copy-paste").noConflict()`. It'll remove the `copy` and `paste` global functions as well as return an object that has `copy` and `paste` properties.
+- `require("copy-paste").noConflict()`: removes `copy` and `paste` from the global namespace. Returns an object with `copy` and `paste` as properties. Can be chained with `silent`.
+- `require("copy-paste").silent()`: suppresses all print statements produced by this module, including ones that report errors. Returns an object with `copy` and `paste` as properties. Can be chained with `noConflict`.
## Getting node-copy-paste

0 comments on commit 3aec200

Please sign in to comment.