import {SearchResult} from '~/models/Search.js'

public class | source

SearchResult

Represents a given search result as native object

Constructor Summary

Public Constructor
public	constructor(category: SearchCategory, object: Object, result: Object) Represents search result

Public Members
public	category: *
public	id: string Unique foreign id for object
public get	value: Object Returns underlying value or object backing this result.

Public Methods
public	highlightForKey(key: string): string Obtains the full highlight
public	highlightSnippetForKey(key: string, predicate: Function, type: string): DocumentFragment Obtains highlight snippet for key

Represents search result

Name	Type	Attribute	Description
category	SearchCategory		A search category
object	Object		Formatted object
result	Object		the result object from algolia

Unique foreign id for object

Returns underlying value or object backing this result. This is the formatted local model.

Obtains the full highlight

Name	Type	Attribute	Description
key	string		Key of item eg `author.name`

string of the value.

If key not found

Obtains highlight snippet for key

Name	Type	Attribute	Description
key	string		Key of item eg `author.name`
predicate	Function	nullable: true	If key exists call the predicate and return the results, else fragment.
type	string	optional default: span	Node type to wrap in

DocumentFragment

HTML node with <em> for highlights

If key not found