summaryrefslogtreecommitdiff
path: root/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md
diff options
context:
space:
mode:
Diffstat (limited to 'data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md')
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md
new file mode 100644
index 0000000..1bc8d4e
--- /dev/null
+++ b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/pathfinder/docs/userscript.md
@@ -0,0 +1,44 @@
+<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
+
+The `userscript` module allows modules to create user scripts which automatically
+start running on windows opened after the user script is created.
+
+
+## Example ##
+ var scripts = ["test.user.js"];
+ var self = require("self");
+ var {UserScript} = require("userscript");
+ exports.main = function() {
+ scripts.forEach(function(scriptName, index) {
+ UserScript(self.data.url(scriptName));
+ });
+ };
+
+
+<api name="UserScript">
+@class
+
+The module exports a `UserScript` constructor which allowing one to create a
+user script.
+
+<api name="UserScript">
+@constructor
+Creates a user script.
+
+@param aURL {String}
+ The url of a user script on the local file system, so this url can be a
+ `resource:`, `file:`, or `chrome:` for example.
+</api>
+
+<api name="enabled">
+@property {Boolean}
+Allows one to get and change the status of the a user script. A disabled user
+script will not be injected in to newly opened windows.
+</api>
+
+<api name="destroy">
+@method
+The user script will no longer be injected into new windows, you will have to
+create a new user script in order to run the script again.
+</api>
+</api>