{"_id":"@buttercup/search","_rev":"2-955eb1c4ef31391f3a6a017ff614aee5","name":"@buttercup/search","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"@buttercup/search","version":"0.1.0","description":"Vault searching components","main":"source/index.js","scripts":{"docs":"jsdoc2md source/**/*.js > API.md","format":"prettier --write '{source,test}/**/*.js'","test":"npm run test:specs && npm run test:format","test:format":"prettier-check '{source,test}/**/*.js'","test:specs":"nyc mocha -r test/index.js test/specs/**/*.spec.js"},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"{source,test}/**/*.js":["prettier --write"]},"repository":{"type":"git","url":"git+https://github.com/buttercup/search.git"},"keywords":["buttercup","vault","search","find"],"author":{"name":"Perry Mitchell","email":"perry@perrymitchell.net"},"license":"MIT","bugs":{"url":"https://github.com/buttercup/search/issues"},"homepage":"https://github.com/buttercup/search#readme","dependencies":{"debounce":"^1.2.0","deep-equal":"^1.1.0","eventemitter3":"^4.0.0","fuse.js":"^3.4.5"},"devDependencies":{"@buttercup/app-env":"^0.5.0","@buttercup/facades":"^1.6.0","buttercup":"^3.0.0-rc3.2","chai":"^4.2.0","husky":"^4.2.3","jsdoc-to-markdown":"^5.0.3","lint-staged":"^10.0.8","mocha":"^7.1.0","nyc":"^15.0.0","prettier":"^1.19.1","prettier-check":"^2.0.0","sinon":"^9.0.0"},"gitHead":"e1790d1ac2192bb4352d72d0383380115cf1a3e7","_id":"@buttercup/search@0.1.0","_nodeVersion":"12.14.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-KeM62XK+5G702UmpHkqsYWSveR4VxMCHhh2mBeDHA+Mu3RG2E5mfug6qjX0c+K5qxccKrOJPdZE3tjgdbRWAWg==","shasum":"c2f50ae6ae18318a6f50a964d0e51b9b51653452","tarball":"https://registry.npmjs.org/@buttercup/search/-/search-0.1.0.tgz","fileCount":14,"unpackedSize":15770,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeXs3NCRA9TVsSAnZWagAAgRAQAJljcAz6QFzZGNu6bZ0t\nE1MNQcSsgnhEwkorn78h5IHIiax/D46Myg6QoZUZVtt80uqlyo+Rl/dhXD4W\nmEiZ51tln2rkqJY4o5q5/m4A5n//pO/rLEvZTKk27NowculAwUwnCsT/jbkl\nKDSuy2aAh7UzYyj12d0tmxYWMi2H/HsAhDYmGZ8iUzYubNjhHHMPCqtLCikI\nD+iVRbdSi5o702HX1xBe5lkJaKUUlBRfeRzqQuB5+sHZNCOuauR1tm7hYibz\nOk+pTzXiEyNojW7/EDtbnYDWIhLDfKtDxtyPWSVPGubmxZHSdJ2lUov+HL4+\nHyjo0KvKl+XKc83cSUqF0PDEG4TMbbiStCZawVT/Vf3HNHvbAI34HKUpwOrU\nUmOjl7ffqF3kpErSTlu9xuCZtrtkw7meLM0EvataYt8OSeB/yx2asoCnbqoU\ny2rfOIMM2IgioBvv1wQlLi0GQbVrmVtWxO9Yqy6lB2MhCCGxFwM/CHyZ8oiH\noBK1i9xdLb8tBI5lvpgVT8Ug2AcA0VaHO2B6hnMP1QbsPO/Zz7S5Swwf6dAQ\nhsdcA1O3Codhzw/KIBDJs1m7z64r/EH6J4UrqPr8U04VRNmUw8pJAimOZ+WY\nzbOyCBmCfVbZJ4TZW6xrl7qLCVFZcAW2rFTpq0+cgkNV8XLiqDT38kRHHk0Z\ndB9C\r\n=V6G1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCGPOZKIIQW8pDpLpWBb1vs4uHORqO4mgCh9AXdamlBYQIhAM+IyuJHh4dNT0QNmrtAJuYzyUF2wAtKaF3Xj7uHELW1"}]},"maintainers":[{"name":"perrymitchell","email":"perry@perrymitchell.net"},{"name":"sallar","email":"sallar.kaboli@gmail.com"}],"_npmUser":{"name":"perrymitchell","email":"perry@perrymitchell.net"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/search_0.1.0_1583271373405_0.33268544232867603"},"_hasShrinkwrap":false},"0.2.0":{"name":"@buttercup/search","version":"0.2.0","description":"Vault searching components","main":"source/index.js","scripts":{"docs":"jsdoc2md source/**/*.js > API.md","format":"prettier --write '{source,test}/**/*.js'","test":"npm run test:specs && npm run test:format","test:format":"prettier-check '{source,test}/**/*.js'","test:specs":"nyc mocha -r test/index.js test/specs/**/*.spec.js"},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"{source,test}/**/*.js":["prettier --write"]},"repository":{"type":"git","url":"git+https://github.com/buttercup/search.git"},"keywords":["buttercup","vault","search","find"],"author":{"name":"Perry Mitchell","email":"perry@perrymitchell.net"},"license":"MIT","bugs":{"url":"https://github.com/buttercup/search/issues"},"homepage":"https://github.com/buttercup/search#readme","dependencies":{"debounce":"^1.2.0","deep-equal":"^1.1.0","eventemitter3":"^4.0.0","extract-domain":"^2.2.1","fuse.js":"^3.4.5"},"devDependencies":{"@buttercup/app-env":"^0.5.0","@buttercup/facades":"^1.6.0","buttercup":"^3.0.0-rc3.2","chai":"^4.2.0","husky":"^4.2.3","jsdoc-to-markdown":"^5.0.3","lint-staged":"^10.0.8","mocha":"^7.1.0","nyc":"^15.0.0","prettier":"^1.19.1","prettier-check":"^2.0.0","sinon":"^9.0.0"},"peerDependencies":{"buttercup":">= 3.0.0-rc3.2"},"gitHead":"0ba0548114d516d79f95a099df5e8ac009ca1272","_id":"@buttercup/search@0.2.0","_nodeVersion":"12.14.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-dJgqe7eUIatWwUKtVkzK1Nf+wzyuZHe6rIdC0P6umnkncwE4qCKF9+HqdTFaNMyLRIi6GCV8yTgr3pXW8PeJGw==","shasum":"c818ab0895d228ec21769a086f7656c81cadce41","tarball":"https://registry.npmjs.org/@buttercup/search/-/search-0.2.0.tgz","fileCount":16,"unpackedSize":21590,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeYB8yCRA9TVsSAnZWagAAX9UP+gIGsqp48h+ytRsATMWS\n2sQvjdrZvhVcogwr5YpDtxtFoIcBuuL95aAz6MSBvgrE4LpwNOBi3xij1Pl5\n7qgwwT0zOWEu88Ufy01x9mgUyWWeCVKZXbI03aFJTmR56jVrd93mRZyYP0c5\nei1Eof6hIPO1fdevGmhrdLVK44bSPdUMwiE3Um/QJUHRKfPOZ7VEJUmWA6MF\noPGRtFa8Rwd4iDKhNaEu36X+Uos+9i0awSn825Sh1pL7YoxC1pFHe3J01kRl\ndlt+sX8aJChuot4Bk4Ob5pEB8R46iZBAe2OV2OpAwhVSa+5b0YgxkBNER8fm\nP8NUaCRXHmDm2RYNp7CQJwg/0CjNSGEbWpF4MJwXWwkr9tmZc/Kowg6zmX11\nIKWPlvnk6WZPtCttMZ6496UDgPMUSVWn5Mbxr0mbzYLbt773UdJNalN5NUyp\nA/3u/23opoTz0/H/yde3pHXNjkK/4oINoB1h9zFmRJTCxUjsb97yuJFek01t\nvIGJN44noYgeGCSLU55yaRRQ9ZeAFD2XyCP1F3K3NwP8D/Li12MfDeOLLlmH\nTA3odNfnJ4uUjTsrsoZo3S6POLhqlMvBZYlwipSOm1dpUEphLVjYpgJHpxsF\n2nZcDOdAXa3cZoPXiHb7x8r8brya8EWGJLcEzyhajiqqBUms03IZ6OPYmZZJ\nbbyS\r\n=Ry4L\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDaavIozbol6W7Shzr5pSxikMmpu1bb+BEwBZvsPXCskwIgBr+huxMoNByldTFH57WybTxO0aq8WeecnmkisblomSc="}]},"maintainers":[{"name":"perrymitchell","email":"perry@perrymitchell.net"},{"name":"sallar","email":"sallar.kaboli@gmail.com"}],"_npmUser":{"name":"perrymitchell","email":"perry@perrymitchell.net"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/search_0.2.0_1583357746346_0.7978683302994154"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-03T21:36:13.285Z","0.1.0":"2020-03-03T21:36:13.529Z","modified":"2022-04-04T21:10:16.733Z","0.2.0":"2020-03-04T21:35:46.453Z"},"maintainers":[{"name":"perrymitchell","email":"perry@perrymitchell.net"},{"name":"sallar","email":"sallar.kaboli@gmail.com"}],"description":"Vault searching components","homepage":"https://github.com/buttercup/search#readme","keywords":["buttercup","vault","search","find"],"repository":{"type":"git","url":"git+https://github.com/buttercup/search.git"},"author":{"name":"Perry Mitchell","email":"perry@perrymitchell.net"},"bugs":{"url":"https://github.com/buttercup/search/issues"},"license":"MIT","readme":"# Search\n> Vault searching components\n\n[![Build Status](https://travis-ci.org/buttercup/search.svg?branch=master)](https://travis-ci.org/buttercup/search)\n\n## About\n\nThis library provides searching utilities for finding entries in Buttercup vaults.\n\n## Usage\n\nUse the extraction methods to extract search targets from vaults:\n\n```javascript\nconst { extractEntriesFromArchive } = require(\"@buttercup/search\");\n\nconst searchItems = extractEntriesFromArchive(vault);\n```\n\nOr vault facades:\n\n```javascript\nconst { extractEntriesFromArchiveFacade } = require(\"@buttercup/search\");\n\nconst searchItems = extractEntriesFromArchiveFacade(vaultFacade);\n```\n\nProvide these results to the `Search` class:\n\n```javascript\nconst { Search } = require(\"@buttercup/search\");\n\nconst search = new Search(searchItems);\nsearch.on(\"results\", evt => {\n    // evt is like:\n    // {\n    //     results: [],\n    //     term: \"some term\"\n    // }\n});\nsearch.update(\"some term\");\n```\n\nCheck out the [API documentation](API.md) for more information.\n","readmeFilename":"README.md"}