🌍
☄️
️ Impact
Create a Lyra database from anywhere.
Installation
You can install Lyra using npm, yarn, pnpm:
npm i @mateonunez/lyra-impact
yarn add @mateonunez/lyra-impact
pnpm add @mateonunez/lyra-impact
Examples
See the full list of examples: mateonunez/lyra-impact-examples
Usage
import { search } from "@lyrasearch/lyra"
import { impact } from "@mateonunez/lyra-impact"
(async () => {
const lyra = await impact("https://raw.githubusercontent.com/LyraSearch/lyra/main/examples/with-vue/public/pokedex.json")
const { hits } = search(lyra, { term: "pikachu" })
console.log(hits)
})();
Result
[
{
num: '025',
name: 'Pikachu',
img: 'http://www.serebii.net/pokemongo/pokemon/025.png',
type: [ 'Electric' ],
height: '0.41 m',
weight: '6.0 kg',
candy: 'Pikachu Candy',
candy_count: 50,
egg: '2 km',
spawn_chance: 0.21,
avg_spawns: 21,
spawn_time: '04:00',
multipliers: [ 2.34 ],
weaknesses: [ 'Ground' ],
next_evolution: [ { num: '026', name: 'Raichu' } ]
}
];
Formats and fetchers
lyra-impact supports the following formats and fetchers:
| Format | Fetcher | Description |
|---|---|---|
JSON |
fetch, filesystem |
Fetches a JSON response or file |
GraphQL |
graphql |
Fetches a GraphQL endpoint |
CSV |
fetch, filesystem |
Fetches a CSV file from a URL or filesystem |
XML (REMOVED) |
fetch, filesystem |
Fetches a XML file from a URL or filesystem |
With GraphQL
import { search } from "@lyrasearch/lyra"
import { impact } from "@mateonunez/lyra-impact"
(async () => {
const lyra = await impact("https://rickandmortyapi.com/graphql", {
fetch: {
fetcher: "graphql",
query: `{
characters {
results {
type
status
species
name
id
gender
}
}
}`,
property: "characters.results"
}
})
const { hits } = search(lyra, {
term: "Morty"
})
console.log(hits)
})()
With Filesystem
import { search } from "@lyrasearch/lyra"
import { impact } from "@mateonunez/lyra-impact"
(async () => {
const lyra = await impact("./data/examples/characters.csv", {
fetch: {
fetcher: "filesystem"
}
})
const { hits } = search(lyra, {
term: "Morty"
})
console.log(hits)
})()
Collision
collision method allows you to fetch and search a term in the API results.
url: stringsearchOptions: SearchOptionsimpactOptions: ImpactOptions
import { collision } from "@mateonunez/lyra-impact"
(async () => {
const { hits } = await collision("https://raw.githubusercontent.com/LyraSearch/lyra/main/examples/with-vue/public/pokedex.json", {
term: "pikachu"
})
console.log(hits)
})();
Result
[
{
num: '025',
name: 'Pikachu',
img: 'http://www.serebii.net/pokemongo/pokemon/025.png',
type: [ 'Electric' ],
height: '0.41 m',
weight: '6.0 kg',
candy: 'Pikachu Candy',
candy_count: 50,
egg: '2 km',
spawn_chance: 0.21,
avg_spawns: 21,
spawn_time: '04:00',
multipliers: [ 2.34 ],
weaknesses: [ 'Ground' ],
next_evolution: [ { num: '026', name: 'Raichu' } ]
}
];
29 Dec 20, 2022
8 Oct 6, 2022
115 Dec 22, 2022
1.3k Jan 5, 2023
4 Sep 20, 2022
5 May 13, 2021
14 Nov 16, 2022
17 Dec 9, 2022
370 Nov 5, 2022
12 Sep 26, 2022
6 Nov 11, 2022
6 Dec 16, 2022
4 Nov 16, 2022
4 Mar 20, 2023
7 Dec 26, 2022
6 Aug 17, 2022
18 Dec 4, 2022
60 Dec 29, 2022