Skip to content

Commit b72492b

Browse files
committed
Add documentation
1 parent dae2c2f commit b72492b

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

lib/woql.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,13 +310,17 @@ WOQL.equals = function (varName, varValue) {
310310
};
311311

312312
/**
313-
* Substring
313+
* Substring of string
314314
* @param {string|Var} string - String or variable
315315
* @param {number|Var} before - integer or variable (characters from start to begin)
316316
* @param {number|Var} [length] - integer or variable (length of substring)
317317
* @param {number|Var} [after] - integer or variable (number of characters after substring)
318318
* @param {string|Var} [substring] - String or variable
319319
* @returns {WOQLQuery}
320+
* @example
321+
* let [after, result] = vars("after", "result")
322+
* substr("joe", 1, 2, after, result)
323+
* //result is "oe", after is 2
320324
*/
321325

322326
WOQL.substr = function (string, before, length, after, substring) {

0 commit comments

Comments
 (0)