Timo/utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fix jsdoc

Browse Source
This commit is contained in:
Timo Hocker 2020-07-03 14:42:37 +02:00
parent 0dab4976ae
commit 1f63b6ccb6
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
index.js
View File

@ -120,17 +120,28 @@ function check_filters (filters, e, carried_data, or = false) {
* @property {RegExp} filter - filter * @property {RegExp} filter - filter
*/ */
/**
* @typedef FilterFunction
* @type {object}
* @property {function} function - function to test element for match
*/
/** /**
* @typedef FilterOrGroup * @typedef FilterOrGroup
* @type {object} * @type {object}
* @property {(Filter|FilterOrGroup)[]} or - create an OR group of filters * @property {FilterType[]} or - create an OR group of filters
*/
/**
* @typedef FilterType
* @type {Filter|FilterFunction|FilterOrGroup}
*/ */
/** /**
* filter nested objects * filter nested objects
* *
* @param {Array<object>} input object to filter * @param {Array<object>} input object to filter
* @param {(Filter|FilterOrGroup)[]} filters filters * @param {FilterType[]} filters filters
* @param {string[]} carry carry data to children to match * @param {string[]} carry carry data to children to match
* @param {object} carried_data internal: carried data * @param {object} carried_data internal: carried data
* @returns {Array<object>} filtered data * @returns {Array<object>} filtered data