{"_id":"@ablanc/reverso-api","_rev":"1-ba8fb90916dc94b72f60c9ad6e2693dd","name":"@ablanc/reverso-api","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"version":"0.1.0","license":"MIT","main":"dist/index.js","typings":"dist/index.d.ts","engines":{"node":">=10"},"scripts":{"start":"tsdx watch","build":"tsdx build","test":"tsdx test","lint":"tsdx lint","prepare":"tsdx build","size":"size-limit","analyze":"size-limit --why"},"peerDependencies":{},"husky":{"hooks":{"pre-commit":"tsdx lint"}},"prettier":{"printWidth":80,"semi":true,"singleQuote":true,"trailingComma":"es5"},"name":"@ablanc/reverso-api","author":{"name":"ablanc"},"module":"dist/reverso-api.esm.js","size-limit":[{"path":"dist/reverso-api.cjs.production.min.js","limit":"10 KB"},{"path":"dist/reverso-api.esm.js","limit":"10 KB"}],"devDependencies":{"@size-limit/preset-small-lib":"^4.9.1","@types/node-fetch":"^2.5.8","husky":"^4.3.8","size-limit":"^4.9.1","tsdx":"^0.14.1","tslib":"^2.1.0","typescript":"^4.1.3"},"dependencies":{"node-fetch":"^2.6.1"},"gitHead":"c2ff1e513cce3b958f0c9a6123b149db26beb681","description":"A node.js module to use reverso spell checking API.","_id":"@ablanc/reverso-api@0.1.0","_nodeVersion":"12.15.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-TMHTLClnGMt2fKsburbljtS54r52IrGpSx3DREVAHH++I4Ahk3ikcl6evlR/AmtSe7+wSO5iEO4K/Fj318dK6w==","shasum":"836b67d77ecc8d9becf293d9f941f4c0077f77a2","tarball":"https://registry.npmjs.org/@ablanc/reverso-api/-/reverso-api-0.1.0.tgz","fileCount":14,"unpackedSize":198142,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgEEPGCRA9TVsSAnZWagAAxGYP/2+vEMl/cuLeuX4Y0J99\n4TMHYeQDPjDLB2V6+mIjitUIONRbutLswuTi7MwSlbO3f+KD3UrGHxvE0tee\nQSW8w2PeWkQfe/WQ1Qe0D+POnMU5RV6YUb+yGq6HKnE9lbO1eMuZxoaOOx7R\n4R+ofk1s0YDonut5bn0IOu488hOqzq89XzdZmTOWEu/hJpIAvEIEPf5IkeCF\nLTc4wzcIxL2I4cIbjBaxDxv7H8hmV5AD8q+1h4b2RTgZ63kxZ3y87iiE3BCd\nfBSvHCY3UCcd75CIIf4DzJ3wulBmqA+bIV4NuhMgPJujohQFAatuT+t9XPGx\nuEm2ICYgCAp9audBpHt5uy5PoA0pbGj139hk8bpRhLpx8sxTNE3ot0UeWvsa\nYBNGtofuNI9RKjBvgVf4JPqS4BBjO3dzMGfo5KU1uZFq7/3bBe3/SVOU21nH\nuTsb/RFGiiRQzI9ap9qhd6Ucdz/VgfF7unj+NNTaDN4lDLYNGAyX7kjiVT1C\nMjlaQ5l2rWZzD/uRYLrKNnQs6lzX5TSahMZQeJ3QSSqYUTlUGnCe8/IK3Yv/\nPpAYhu5sO5GZWiQWaD0+XtalxFqojNNDnKs7J48HUnbG4zjvUfaWipisPVC8\n+nt4UGqrzFy6yNj1tNbSJM2AOpJJbG79cy5JJ1GU+A7o/nUiYIiSP64yL7tD\np/El\r\n=pmdp\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEmjJEeDfcyVEmxCk2cLQWnazGHxQyN5tgdoJcv2mbf3AiEA/PveKjIBKnF3aummSGpceA9DHTkDMN+cHqGEEF0xTfA="}]},"_npmUser":{"name":"ablanc","email":"ablanc@student.42.fr"},"directories":{},"maintainers":[{"name":"ablanc","email":"ablanc@student.42.fr"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/reverso-api_0.1.0_1611678661542_0.7734603968314331"},"_hasShrinkwrap":false}},"time":{"created":"2021-01-26T16:31:01.510Z","0.1.0":"2021-01-26T16:31:01.708Z","modified":"2022-04-04T10:59:44.420Z"},"maintainers":[{"name":"ablanc","email":"ablanc@student.42.fr"}],"description":"A node.js module to use reverso spell checking API.","author":{"name":"ablanc"},"license":"MIT","readme":"# reverso-api\n\nA node.js module to use reverso spell checking API.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n\n## Installation\n\n```sh\nnpm install @ablanc/reverso-api\n\n# or with yarn\nyarn add @ablanc/reverso-api\n```\n\n## Usage\n\n```ts\nimport { checkSpelling } from '@ablanc/reverso-api';\n\nasync function test() {\n  const res = await checkSpelling({ text: 'salut les amis' });\n\n  console.log(res);\n}\n\ntest();\n```\n\nHere are the properties you can override when calling `checkSpelling` :\n\n```ts\ninterface Params {\n  autoReplace?: boolean;\n  generateSynonyms?: boolean;\n  getCorrectionDetails?: boolean;\n  interfaceLanguage?: string;\n  language?: 'fra' | 'eng';\n  locale?: string;\n  origin?: string;\n  text: string;\n}\n```\n\nThe result object should look like this :\n\n```ts\ninterface Result {\n  id: string;\n  language: string;\n  text: string;\n  engine: 'Cordial' | 'Ginger';\n  truncated: boolean;\n  timeTaken: number;\n  corrections: Correction[];\n  sentences: any[];\n  autoReplacements: any[];\n}\n\ninterface Correction {\n  group: string;\n  type: string;\n  shortDescription: string;\n  longDescription: string;\n  startIndex: number;\n  endIndex: number;\n  mistakeText: string;\n  correctionText: string;\n  suggestions: Suggestion[];\n}\n\ninterface Suggestion {\n  text: string;\n}\n```\n","readmeFilename":"README.md"}