import Search from '~/models/Search.js'

public class | source

Search

Static Method Summary

Static Public Methods
public static	createClient(): Search Creates a standard instance

Constructor Summary

Public Constructor
public	constructor(appId: string, searchToken: string, prefix: string, categories: SearchCategory[]) Creates site search instance

Member Summary

Public Members
public	allCategories: SearchCategory[]
public	client: algoliasearch.Client
public	indexMap: Map
public	indices: algoliasearch.Index[]
public	prefix: string

Method Summary

Public Methods
public	formatResult(result: Object) Formats a result
public	getCategoryFromFullName() Obtains search category with name
public	getIndex(string: name): algoliasearch.Index Obtains an index
public	getIndexFromCategory(varname: Category) Obtains index from category
public	getIndexName(name: string): string Obtains an index name
public	globalSearch(query: string, opts: Object): MultiIndexSearch Performs a search across indexes.

Static Public Methods

public static createClient(): Search source

Creates a standard instance

Return:

Public Constructors

public constructor(appId: string, searchToken: string, prefix: string, categories: SearchCategory[]) source

Creates site search instance

Params:

Name	Type	Attribute	Description
appId	string		generally from the data ids
searchToken	string		generally from the data ids
prefix	string		generally from the data ids
categories	SearchCategory[]	optional default: []	Additional search categories

Public Members

public allCategories: SearchCategory[] source

public client: algoliasearch.Client source

public indexMap: Map source

public indices: algoliasearch.Index[] source

public prefix: string source

Public Methods

public formatResult(result: Object) source

Formats a result

Params:

Name	Type	Attribute	Description
result	Object

public getCategoryFromFullName() source

Obtains search category with name

public getIndex(string: name): algoliasearch.Index source

Obtains an index

Params:

Name	Type	Attribute	Description
string	name

Return:

algoliasearch.Index

public getIndexFromCategory(varname: Category) source

Obtains index from category

Params:

Name	Type	Attribute	Description
varname	Category	optional	[description]

public getIndexName(name: string): string source

Obtains an index name

Params:

Name	Type	Attribute	Description
name	string		Input name

Return:

string

public globalSearch(query: string, opts: Object): MultiIndexSearch source

Performs a search across indexes.

Params:

Name	Type	Attribute	Description
query	string		The text for search
opts	Object		See MultiIndexSearch

Return:

MultiIndexSearch

Use this to iterate through pages.