JSPM

@loopservices/magnify

0.3.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q15133F
  • License MIT

Plug and play full-text search for your Adonis application.

Package Exports

  • @loopservices/magnify
  • @loopservices/magnify/commands
  • @loopservices/magnify/magnify_provider
  • @loopservices/magnify/services/main
  • @loopservices/magnify/types

Readme


@foadonis/magnify

Plug and play full-text search for your Adonis application


npm version npm downloads bundle size install size

Coverage

Description

Magnify provides a simple, driver based solution for adding full-text search to your Lucid models. Using Lucid hooks, Magnify automatically keep your search indexes in sync with your database.

Currently, Magnify ships with Algolia, Meilisearch and Typesense engines. Furthermore, writing custom engines is simple and you are free to extend Magnify with your own search implementations.

import { compose } from '@adonisjs/core/helpers'
import { BaseModel, column } from '@adonisjs/lucid/orm'
import { Searchable } from '@foadonis/magnify'

export default class Post extends compose(BaseModel, Searchable) {
  @column({ isPrimary: true })
  declare id: string

  @column()
  declare title: string
}
import Post from '#models/post'

const posts = await Post.search('Adonis').take(10).get()

Quickstart

Installation & Getting Started

License

MIT licensed.