Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

meilisearch-name-synonyms

atlas-bi124GPL-31.1.0TypeScript support: included

List of common names and nicknames to be used in a meilisearch username index as a synonym list

meilisearch, synonyms, nicknames

readme

Meilisearch Name Synonyms

This is an importable list of nicknames to be used as a meilisearch synonym list.

Installing

npm i meilisearch-name-synonyms

Usage

Assuming you have a search index for people:

import { MeiliSearch } from "meilisearch";
import { nameSynonyms } from "meilisearch-name-synonyms";

const client = new MeiliSearch({ host: "http://localhost:7700" });

const userIndex = client.index("users");

await userIndex.updateSynonyms(nameSynonyms);

/// or if you need to add in a few more
await userIndex.updateSynonyms({ ...nameSynonyms, superman: ["wow"] });

Sources

Name list is provided by https://github.com/carltonnorthern/nicknames/blob/master/names.csv and licensed under Apache-2.0

changelog

1.1.0 (2023-03-09)

  • fixed formatting (4440073)
  • Merge pull request #3 from atlas-bi/dev (6dac00e), closes #3
  • udpated release files (c1a3918)
  • updated name (f58c281)
  • updated readme (5a4d394)
  • feat(types): added types (07f3d82)
  • fix(dupes): prevented dupes from disappearing (3d82602)
  • ci(action): fixed action trigger (4331dfc)

1.0.1 (2023-03-08)

  • Merge branch 'master' of github.com:atlas-bi/meilisearch-name-synonyms (df26e83)
  • fix(import): fixed import (bc25753)

1.0.0 (2023-03-08)

  • ci(action): fixed folder struc (ed0ff11)
  • feat(initial): initial commit (cdc60ea)