{"_id":"@danny270793/levenshtein","_rev":"1-7ca099d49a96c5794397ed9c222f0843","name":"@danny270793/levenshtein","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@danny270793/levenshtein","version":"1.0.0","keywords":["levenshtein"],"author":{"url":"https://danny270793.github.io/#/","name":"Danny Vaca","email":"danny270793@gmail.com"},"license":"MIT","_id":"@danny270793/levenshtein@1.0.0","maintainers":[{"name":"danny270793","email":"danny270793@gmail.com"}],"contributors":[{"name":"Neil Vaca","email":"nvaca@maintlatam.com"}],"homepage":"https://github.com/danny270793/NodeLevenshtein#readme","bugs":{"url":"https://github.com/danny270793/NodeLevenshtein/issues"},"dist":{"shasum":"3aca433b4001ead2f11b9d25b57d2506302a8848","tarball":"https://registry.npmjs.org/@danny270793/levenshtein/-/levenshtein-1.0.0.tgz","fileCount":3,"integrity":"sha512-Px4BzMtdUEL18/IkAQC2q+qp2mu91Cce+TcaSOblswCMQGJWkh/mNdbndZnH4XN+s6sEebRIhlr4zU82G8z/PA==","signatures":[{"sig":"MEQCIGDZxn0JeXZ/fCGEpc1k98tiRE5chj5u+32zDDreoaaKAiAZMlhVvfP2l25tv1eHZiXCsc6gCXsotbbSx84TFziRPQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":7223},"main":"build/index.js","types":"build/index.d.ts","gitHead":"023c39e157ac2207224a70c59ce750036403f5d7","scripts":{"lint":"eslint . --ext .ts","test":"jest --config jestconfig.json","build":"rm -r -f && tsc","start":"node build/index.js","format":"pretty-quick","git:commit":"npm run format && npm run lint && npm run lint:markdown && git add . && git commit","test:watch":"nodemon --ext \"ts\" --exec \"npm run test\" --watch \"./src/*\"","documentate":"typedoc --out ./public/docs src","git:release":"npm run git:commit && standard-version && git push --follow-tags origin master","husky:setup":"npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1' && npx husky add .husky/pre-commit 'npx --no-install pretty-quick --staged'","start:watch":"nodemon --ext \"ts\" --exec \"npm run build && npm run start\" --watch \"./src/*\"","husky:install":"rm -r -f .husky && husky install","install:force":"rm -r -f node_modules && npm install -f","lint:markdown":"markdownlint \"**/*.md\" --config=.markdownlint.json --ignore-path=.markdownlintignore"},"_npmUser":{"name":"danny270793","email":"danny270793@gmail.com"},"repository":{"url":"git+https://github.com/danny270793/NodeLevenshtein.git","type":"git"},"_npmVersion":"10.8.1","description":"library to measure levenshtein distance between words","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^27.0.6","husky":"^7.0.1","eslint":"^7.32.0","nodemon":"^2.0.12","ts-jest":"^27.0.4","ts-node":"^10.1.0","typedoc":"^0.21.5","prettier":"^2.3.2","jest-junit":"^12.2.0","typescript":"^4.3.5","@types/jest":"^26.0.24","@types/node":"^16.4.12","pretty-quick":"^3.1.1","@commitlint/cli":"^12.1.4","markdownlint-cli":"^0.28.1","standard-version":"^9.3.1","jest-html-reporters":"^2.1.6","@typescript-eslint/parser":"^4.29.0","@commitlint/config-conventional":"^12.1.4","@typescript-eslint/eslint-plugin":"^4.29.0"},"_npmOperationalInternal":{"tmp":"tmp/levenshtein_1.0.0_1723092427235_0.9744402249429502","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@danny270793/levenshtein","contributors":[{"name":"Neil Vaca","email":"nvaca@maintlatam.com"}],"version":"1.0.1","description":"library to measure levenshtein distance between words","main":"build/index.js","types":"build/index.d.ts","scripts":{"husky:install":"rm -r -f .husky && husky install","husky:setup":"npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1' && npx husky add .husky/pre-commit 'npx --no-install pretty-quick --staged'","install:force":"rm -r -f node_modules && npm install -f","format":"pretty-quick","lint":"eslint . --ext .ts","lint:markdown":"markdownlint \"**/*.md\" --config=.markdownlint.json --ignore-path=.markdownlintignore","documentate":"typedoc --out ./public/docs src","git:commit":"npm run format && npm run lint && npm run lint:markdown && git add . && git commit","git:release":"npm run git:commit && standard-version && git push --follow-tags origin master","build":"rm -r -f && tsc","start":"node build/index.js","start:watch":"nodemon --ext \"ts\" --exec \"npm run build && npm run start\" --watch \"./src/*\"","test":"jest --config jestconfig.json","test:watch":"nodemon --ext \"ts\" --exec \"npm run test\" --watch \"./src/*\""},"keywords":["levenshtein"],"author":{"name":"Danny Vaca","email":"danny270793@gmail.com","url":"https://danny270793.github.io/#/"},"repository":{"type":"git","url":"git+https://github.com/danny270793/NodeLevenshtein.git"},"license":"MIT","devDependencies":{"@commitlint/cli":"^12.1.4","@commitlint/config-conventional":"^12.1.4","@types/jest":"^26.0.24","@types/node":"^16.4.12","@typescript-eslint/eslint-plugin":"^4.29.0","@typescript-eslint/parser":"^4.29.0","eslint":"^7.32.0","husky":"^7.0.1","jest":"^27.0.6","jest-html-reporters":"^2.1.6","jest-junit":"^12.2.0","markdownlint-cli":"^0.28.1","nodemon":"^2.0.12","prettier":"^2.3.2","pretty-quick":"^3.1.1","standard-version":"^9.3.1","ts-jest":"^27.0.4","ts-node":"^10.1.0","typedoc":"^0.21.5","typescript":"^4.3.5"},"_id":"@danny270793/levenshtein@1.0.1","gitHead":"95bc26c993a94fb458b58e971e3a47946fe18c1d","bugs":{"url":"https://github.com/danny270793/NodeLevenshtein/issues"},"homepage":"https://github.com/danny270793/NodeLevenshtein#readme","_nodeVersion":"20.16.0","_npmVersion":"10.8.1","dist":{"integrity":"sha512-DtUzizC5MnGK6s77yjyeZMviQJ01zvkMmHe0NijLWkl200W9pc8Wd4h+/9oPBumtyBm3LqLDi0rlGz+iMxGw/w==","shasum":"7ee6bc3d0b00a8c35af9b7bd180347162fc84cf9","tarball":"https://registry.npmjs.org/@danny270793/levenshtein/-/levenshtein-1.0.1.tgz","fileCount":7,"unpackedSize":12633,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBtEeycO3myZz6l0d9nsT8q16fQtFG0zCg4fChFKR2M5AiBs4KuAFrsZ0Gy4Qh5xCT2ERF2Eq6je6+d9FK01A1jCTw=="}]},"_npmUser":{"name":"danny270793","email":"danny270793@gmail.com"},"directories":{},"maintainers":[{"name":"danny270793","email":"danny270793@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/levenshtein_1.0.1_1723093157167_0.5938846448747939"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-08T04:47:07.141Z","modified":"2024-08-08T04:59:17.518Z","1.0.0":"2024-08-08T04:47:07.401Z","1.0.1":"2024-08-08T04:59:17.348Z"},"bugs":{"url":"https://github.com/danny270793/NodeLevenshtein/issues"},"author":{"name":"Danny Vaca","email":"danny270793@gmail.com","url":"https://danny270793.github.io/#/"},"license":"MIT","homepage":"https://github.com/danny270793/NodeLevenshtein#readme","keywords":["levenshtein"],"repository":{"type":"git","url":"git+https://github.com/danny270793/NodeLevenshtein.git"},"description":"library to measure levenshtein distance between words","contributors":[{"name":"Neil Vaca","email":"nvaca@maintlatam.com"}],"maintainers":[{"name":"danny270793","email":"danny270793@gmail.com"}],"readme":"# Levenshtein\n\n[![Github pipeline status](https://github.com/danny270793/NodeLevenshtein/actions/workflows/releaser.yaml/badge.svg)](https://github.com/danny270793/NodeLevenshtein/actions/workflows/releaser.yaml)\n![NPM Type Definitions](https://img.shields.io/npm/types/@danny270793/levenshtein)\n\n[![install size](https://packagephobia.com/badge?p=@danny270793/levenshtein)](https://packagephobia.com/result?p=@danny270793/levenshtein)\n![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/@danny270793/levenshtein)\n![GitHub repo size](https://img.shields.io/github/repo-size/danny270793/NodeLevenshtein)\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/danny270793/NodeLevenshtein)\n![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@danny270793/levenshtein)\n\n![GitHub commit activity](https://img.shields.io/github/commit-activity/m/danny270793/NodeLevenshtein)\n![NPM Downloads](https://img.shields.io/npm/dy/@danny270793/levenshtein)\n![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/danny270793/NodeLevenshtein/total)\n\nLibrary to compute levenshtein distance between strings and find more similar phrase in a list \n\n## Instalation\n\nInstall package from public registry\n\n```bash\nnpm install @danny270793/levenshtein\n```\n\n## Examples\n\nCompute the levenshtein distance between two strings\n\n```ts\nimport Levenshtein from '@danny270793/levenshtein'\n\nconst referenceWord: string = 'danny'\nconst valueToCompare: string = 'danni'\nconst computePercentage: number = Levenshtein.computePercentage(\n    referenceWord,\n    valueToCompare\n)\nconsole.log(computePercentage)\n```\n\nYou can customize thw weight of each type of change in a word specifying `costs`\n\n```ts\nimport Levenshtein, { Costs } from '@danny270793/levenshtein'\n\nconst referenceWord: string = 'danny'\nconst valueToCompare: string = 'danni'\nconst costs: string = { inserts: 0, updates: 1, deletes: 0 }],\nconst computePercentage: number = Levenshtein.computePercentage(\n    referenceWord,\n    valueToCompare,\n    costs\n)\nconsole.log(computePercentage)\n```\n\nYou can provide a list of values `options` to detect which is more similar to and specific word `matching`\n\n```ts\nimport Levenshtein, { Costs, BestMatch } from '@danny270793/levenshtein'\n\nconst options: string[] = ['danni', 'danniel', 'dani']\nconst matching: string = 'danny'\nconst bestMatch: BestMatch = Levenshtein.getBestMatch(\n    options,\n    matching\n)\nconsole.log(`more similar string ${bestMatch.text}`)\nconsole.log(`levenshtein distance of the more similar ${bestMatch.match}`)\n```\n\n## Follow me\n\n[![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge&logo=YouTube&logoColor=white)](https://www.youtube.com/channel/UC5MAQWU2s2VESTXaUo-ysgg)\n[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://www.github.com/danny270793/)\n[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/danny270793)\n\n## LICENSE\n\n[![GitHub License](https://img.shields.io/github/license/danny270793/TSFramework)](license.md)\n\n## Version\n\n![GitHub Tag](https://img.shields.io/github/v/tag/danny270793/NodeLevenshtein)\n![GitHub Release](https://img.shields.io/github/v/release/danny270793/NodeLevenshtein)\n![GitHub package.json version](https://img.shields.io/github/package-json/v/danny270793/NodeLevenshtein)\n![NPM Version](https://img.shields.io/npm/v/%40danny270793%2Flevenshtein)\n\nLast update 07/08/2024\n","readmeFilename":"README.md"}