{"_id":"@12joan/locale-includes","name":"@12joan/locale-includes","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.3":{"name":"@12joan/locale-includes","version":"1.0.3","description":"String.prototype.includes() but using localeCompare.","main":"lib/index.js","directories":{"lib":"lib"},"scripts":{"build":"babel src -d lib","build:watch":"babel src -d lib -w","prepublishOnly":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/idmadj/locale-includes.git"},"license":"MIT","bugs":{"url":"https://github.com/idmadj/locale-includes/issues"},"homepage":"https://github.com/idmadj/locale-includes#readme","keywords":["localeincludes","locale","includes","contains","string","localecompare","search","filter","match","diacritics","accents","case","insensitive","i18n","esm","module"],"devDependencies":{"@babel/cli":"^7.17.6","@babel/core":"^7.17.8","@babel/preset-env":"^7.16.11"},"gitHead":"ee89eba48091b5ff2505dcdc7965e291d749786f","_id":"@12joan/locale-includes@1.0.3","_nodeVersion":"18.10.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-piy4m1tGwqtbIU56weGsLoCxxymTsaZNOavwsW7ZhioqRFEA+lneeVho8ZtZkLpnlA9LanzQ3W5Fh5ehwhE5lg==","shasum":"4a111c3c9cad01bab7c56a1b65884bd7051d1e69","tarball":"https://registry.npmjs.org/@12joan/locale-includes/-/locale-includes-1.0.3.tgz","fileCount":4,"unpackedSize":5724,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD+pcCPfXO8iWDXjiLe7kMdYuudW8MHQ14pWSFpXNHTXAIhAM+CeVYIJiOBbnH4lt0trUFhsVUkBmQYpQJOaYWPX2W2"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjREOmACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpXQg/9Ehl5u2RBuN6waTjJh07XmDP3pGMfZnUgA57MwbpoNWLenRof\r\ns6v0iW3j4iG1vQG61rynk3t0QIKUBjkk2TJAOSJ3fzT90Sr8sVO/EHy1Lk7P\r\njCQaT1e/fVWxjFxImRaIxdXf8FYLql6+CY8pzGLv6sDXl4PcpCjqhVAyu5Za\r\nPuaJXNSHglrawfaiNmP/dwcfFHD9/djbE90MFVMwBeT7NL9iHF9kk1ZopS10\r\ny3yz0bE38NnbPojph4GPc2YUjzzePPNcAkjCf4rWhfTzJe+HvZ4VDMG69btm\r\n9WBVMovMXzglINQceMg3gaBMHjkp+kKtiLxp4IBXj2NwkMB8gokWidDI1r41\r\nqUVLIhSWshuo1LOoisUvChcmxniC5ZTzMgBOtAMAhnrBU6dFxfqrahqXzYgx\r\nshkWHr++orSx5Hhfn9SBzA/TetnrumahiiahkV0wXipr8aX7yV8JlWa1c2Rb\r\nc/dnMPYOeMWucZTDacM6m8/MAG8eb4ItUCMR4clZRCHFSTz8BlgoydRgXsRO\r\nGGtJuekwisSrGa59FBy3g8mtN68+Pw0f58yKefQWYYHb23nXSkJPd1GKu7PK\r\nWykhdTlnhx/vEhASdkB0+UW3d81ZXykba9BlwCwqTK/iQBP40Sa7ym0OTCAk\r\nZYzEuv9+6YZOiJYQKvXegkNcW2w0kpmxtC0=\r\n=LTco\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"12joan","email":"joe_npmjs@osbert.me"},"maintainers":[{"name":"12joan","email":"joe_npmjs@osbert.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/locale-includes_1.0.3_1665418150385_0.2982704222430723"},"_hasShrinkwrap":false}},"time":{"created":"2022-10-10T16:09:10.331Z","1.0.3":"2022-10-10T16:09:10.577Z","modified":"2022-10-10T16:09:10.705Z"},"maintainers":[{"name":"12joan","email":"joe_npmjs@osbert.me"}],"description":"String.prototype.includes() but using localeCompare.","homepage":"https://github.com/idmadj/locale-includes#readme","keywords":["localeincludes","locale","includes","contains","string","localecompare","search","filter","match","diacritics","accents","case","insensitive","i18n","esm","module"],"repository":{"type":"git","url":"git+https://github.com/idmadj/locale-includes.git"},"bugs":{"url":"https://github.com/idmadj/locale-includes/issues"},"license":"MIT","readme":"# localeIncludes()\n[![npm](https://img.shields.io/npm/v/locale-includes.svg)](https://www.npmjs.com/package/locale-includes)\n![npm bundle size (minified)](https://img.shields.io/bundlephobia/min/locale-includes.svg)\n\n[`String.prototype.includes()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes) but using [`localeCompare`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare).\n\n\n## Install\n```sh\nnpm i locale-includes\n```\n\n\n## Syntax\n```js\nlocaleIncludes(string, searchString[, options])\n```\n\n### Parameters\n+ `string` (string)  \n  A string to be searched within.\n\n+ `searchString` (string)  \n  A string to be searched for within `string`.\n\n+ `options` (object) - *Optional*  \n  An object with some or all of the following properties:\n\n  + `position` (number) - *Default: 0*  \n    The position within `string` at which to begin searching for `searchString`.\n\n  + `locales` (string|array)  \n    Passed through as the `locales` parameter to [`String.prototype.localeCompare()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare#Parameters).\n\n  + *Any other property*  \n    Passed through in the `options` parameter to [`String.prototype.localeCompare()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare#Parameters).\n\n### Return value\n+ (bool)  \n  Whether the search string is found anywhere within the given string or not.\n\n\n## Examples\n```js\nimport {localeIncludes} from `locale-includes`;\n\nlocaleIncludes(\"Abcdef\", \"cde\");\n// true\n\nlocaleIncludes(\"Abcdef\", \"cde\", {position: 3});\n// false\n\nlocaleIncludes(\"àḃḉdÉf\", \"bCde\", {usage: \"search\", sensitivity: \"base\"});\n// true\n```\n\n## See also\n[`String.prototype.includes()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes)  \n[`String.prototype.localeCompare()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare)  ","readmeFilename":"README.md"}