SearchAPI - Dexcalibur code documentation

SearchAPI

new SearchAPI(data)

Source:

Finder.js, line 975

The SearchAPI. Allow the user to perform search into the object database.

Parameters:

Name	Type	Description
`data`	Object	The database of objects

Methods

beginPrepare()

Source:

Finder.js, line 1181

Set the flag "preparing" which means the research should not be executed. Create a new PreparedRequest instance.

endPrepare()

Source:

Finder.js, line 1191

exec(preparedRequest)

Source:

Finder.js, line 1201

To execute a prepared request. Almost time it is when an inspector is running.

Parameters:

Name	Type	Description
`preparedRequest`	*

getter(pattern)

Source:

Finder.js, line 1109

Parameters:

Name	Type	Description
`pattern`	String	Field signature

gettersOf(pattern)

Source:

Finder.js, line 1130

Parameters:

Name	Type	Description
`pattern`	String	Field signature

invoke(pattern)

Source:

Finder.js, line 1062

To seach only method call

Parameters:

Name	Type	Description
`pattern`	*

nocase()

Source:

Finder.js, line 1006

Switch case sensitive On/Off of following search

setter(pattern)

Source:

Finder.js, line 1081

Parameters:

Name	Type	Description
`pattern`	String	Search pattern

settersOf(pattern)

Source:

Finder.js, line 1102

Parameters:

Name	Type	Description
`pattern`	String	Field signature