IgnoreNoise Property

Whether or not to ignore noise words in the search.

Syntax

 spsearch.getIgnoreNoise([callback])
 spsearch.setIgnoreNoise( ignoreNoise, [callback])

Default Value

TRUE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getIgnoreNoise([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setIgnoreNoise([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

By default, noise words such as the and if are ignored during searches to save time in the search. Set this to false to include noise words in the search.

Data Type

Boolean