Custom Search Engine

If the available Search Engines does not fit your needs you can integrate your own custom search engine.

Writing the Engine

Your Search Engine should extend the MagnifyEngine class and implement the following methods:

import { SearchableModel, SearchableRow } from '@foadonis/magnify/types'
import { MagnifyEngine } from '@foadonis/magnify'
 
export class CustomSearchEngine extends MagnifyEngine {
  async update(...models: SearchableRow[]) {}
 
  async delete(...models: SearchableRow[]) {}
 
  async search(builder: Builder) {}
 
  async map(builder: SearchBuilder, results: any) {}
 
  async paginate(builder: SearchBuilder, perPage: number, page: number) {}
 
  async flush(model: SearchableModel) {}
}

You can head to the natively supported Search Engines source code for more information about the implementation.

Registering the Engine

You can now add your CustomSearchEngine to the config/magnify.ts file:

config/magnify.ts

const magnifyConfig = defineConfig({
  default: 'custom',
  engines: {
    custom: new CustomSearchEngine(),
  },
})
 
export default magnifyConfig

Writing the Engine

Registering the Engine

On this page