summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormatthewsotoudeh <matthewsot@outlook.com>2015-05-10 18:41:15 -0700
committermatthewsotoudeh <matthewsot@outlook.com>2015-05-10 18:41:15 -0700
commit14f554a8e40cfc8e07dcb5d25511e9dfda8e4b45 (patch)
tree650692871c83d0b6a50efd32fc8c326a22d2551e
parent5b04698aebf68c471db2146340b2a03f5b4549a3 (diff)
more in the README
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8506abb..638b8fe 100644
--- a/README.md
+++ b/README.md
@@ -31,4 +31,15 @@ jfn.defineFunction(Math, "root", ["number", "number"], [2], function (base, powe
alert(Math.root(8, 3)); //2 (cubed root of 8)
alert(Math.root(9)); //3 (square root of 9)
-``` \ No newline at end of file
+```
+
+jfn.defineFunction arguments:
+```
+jfn.defineFunction(object, propertyName, argumentTypes, defaults, function);
+```
+
+``object`` is the object you'd like to define the function on
+``propertyName`` is the name of the function that you'd like to define on ``object``
+``argumentTypes`` is an array of argument types to match this function with. Pass "*" to have a catchall function.
+``defaults`` is an array of default values. Note that the last value in ``defaults`` acts as the default value for the last argument specified in ``argumentTypes``
+``function`` is the function to run
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback