fastify-lyra v0.3.1

fastify-lyra

Lyra plugin for Fastify.

Installation

npm install fastify-lyra

Usage

Example

const Fastify = require('fastify')
const FastifyLyra = require('fastify-lyra')

const app = Fastify()

await app.register(FastifyLyra, {
  schema: {
    quote: "string",
    author: "string"
  }
})

app.get('/quotes/:query', async function (req, reply) {
  try {
    const { params: { query } } = req

    const search = await app.lyra.search({
      term: query,
      properties: ["quote"]
    })

    return { quotes: search.hits }
  } catch (err) {
    return err;
  }
})

app.listen(3000)

Usage with data persistence

This plugin implements @lyrasearch/plugin-data-persistence to allow users to load or save database instances.

Example

const Fastify = require('fastify')
const FastifyLyra = require('fastify-lyra')

const app = Fastify()

// The database must exists to load it in your Fastify application
await app.register(FastifyLyra, {
  persistence: true,
  persistency: {
    name: './quotes.json',
    format: 'json'
  }
})

app.post('/quotes', async function (req, reply) {
  try {
    const { body: { author, quote } } = req

    await fastify.lyra.insert({
      author,
      quote
    })

    await fastify.lyra.save()

    return { success: true }
  } catch (err) {
    return err;
  }
})

app.listen(3000)

License

FastifyLyra is licensed under the MIT license.