GedcomX FS JS Class: SearchInfo

new SearchInfo( [json])

Information about a search.

Parameters:

Name	Type	Argument	Description
`json`	Object	<optional>

Extends

Base

Methods

getCloseHits()

Get the closeHits

Returns:

closeHits

Type: Integer

getTotalHits()

Get the totalHits

Returns:

totalHits

Type: Integer

init(json)

Initialize from JSON

Parameters:

Name	Type	Description
`json`	Object

Overrides:

Base#init

Returns:

SearchInfo this

<static> isInstance(obj)

Check whether the given object is an instance of this class.

Parameters:

Name	Type	Description
`obj`	Object

Returns:

Type: Boolean

setCloseHits(closeHits)

Set the closeHits

Parameters:

Name	Type	Description
`closeHits`	Integer

Returns:

this

Type: SearchInfo

setTotalHits(totalHits)

Set the totalHits

Parameters:

Name	Type	Description
`totalHits`	Integer

Returns:

this

Type: SearchInfo

toJSON()

Export the object as JSON

Overrides:

Base#toJSON

Returns:

JSON object

Type: Object