{"_id":"@briannpham/lotr-sdk","name":"@briannpham/lotr-sdk","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@briannpham/lotr-sdk","version":"1.0.0","description":"A JavaScript SDK for LOTR API","main":"index.js","scripts":{"start":"node index.js","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/briannpham/Brian_Pham-SDK.git"},"keywords":[],"author":"","license":"ISC","bugs":{"url":"https://github.com/briannpham/Brian_Pham-SDK/issues"},"homepage":"https://github.com/briannpham/Brian_Pham-SDK#readme","dependencies":{"node-fetch":"^2.6.7"},"devDependencies":{"jest":"^29.3.1"},"gitHead":"d91d1dffe9db419e7ce35e7b7d5c136fc82d991d","_id":"@briannpham/lotr-sdk@1.0.0","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-FlOU1kDCsQC+0W5iiMlp8a2GWCJNCAwLlo0QwPs0sgD4tXswF1Deuq4aK7txJELGUhSiQL1Uep/jRIcp5n27yQ==","shasum":"c70836caaabc141aab929f89dcdb5cf82348972f","tarball":"https://registry.npmjs.org/@briannpham/lotr-sdk/-/lotr-sdk-1.0.0.tgz","fileCount":6,"unpackedSize":14658,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICnUwGDVVMbVGQXXyn7b28LQ0mZDqvqkDfbxkhZ1IHuYAiEAynicbTbXTj1PXoUX8+s6zztggtnV+7X+gN56DmxPyx4="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjmDCiACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmphLA//VD+6KCxYdNqoSK8n9SiWJSpEFLmtlc6MyaE0wzCclCynP+EK\r\ndn6tuvHPEBlkXhnEz0AjRgaT4PPMD/1R9zS7ef8+lZqUOs/NsbBmdP1aelFF\r\nLlReN8WlQ2mo3EdsCDIjVruSDDoFtHw6PZHPnzDUs4ya/bNwoNquXqmV79RS\r\n7rxaqcBqcAjIgqoVRzBogGZuZAnqSwxeovYy+kGK0kywUO02FqngBYZgxWje\r\nU0kWpozPE4mI3XSOVAeCC3vcB62999FV17gFczMW3hw+Pr0ltsHQt4LAIDX5\r\nEI2AJ7VR+PFZey+mhbH0I+ZvPraF/yjtS5qyeOnVsiA6CXa1FhqOwAPKmks9\r\n9roh3kkNqrJx8NGvnWlA9gWflMQ4DGd8rZaWuws+a11K3vU1k2tpU398PfqB\r\nNolYCicln1ZCdSBn2+omLIMQwKH/dpYT8fMuI4VYDgJr0NaD2YWIp4IoeJ4m\r\nUFnYDCpVX7HELTUqeWJN0/orNHaul0N8BxlBojGMylJ57HL6ZcllUopdr7Ez\r\nqop6HQV3fy+h/5wuT4Hooc2VPNlDCplNq4WQYazB9ezDxYQHztsjRHNOCamh\r\nYE5Vt2sJev+HMLVWcJDsY+jq4XhyToCShSuFngAdN1GCdlnvbZpfCxmKRDBM\r\nMxXDP68ZngTg1zxWKUs9kkaQMeS+JVChxTo=\r\n=rNcP\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"briannpham","email":"br.pham13@gmail.com"},"directories":{},"maintainers":[{"name":"briannpham","email":"br.pham13@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/lotr-sdk_1.0.0_1670918306127_0.22809798355758248"},"_hasShrinkwrap":false}},"time":{"created":"2022-12-13T07:58:26.071Z","1.0.0":"2022-12-13T07:58:26.260Z","modified":"2022-12-13T07:58:26.447Z"},"maintainers":[{"name":"briannpham","email":"br.pham13@gmail.com"}],"description":"A JavaScript SDK for LOTR API","homepage":"https://github.com/briannpham/Brian_Pham-SDK#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/briannpham/Brian_Pham-SDK.git"},"bugs":{"url":"https://github.com/briannpham/Brian_Pham-SDK/issues"},"license":"ISC","readme":"# Lord Of The Ring SDK\n\nA JavaScript SDK for accessing Lord Of The Ring API\n\n<hr>\n\n## Getting Started\n\nThis SDK is developed for the below API. All routes requests will be prefixed with\n\n```sh\nhttps://the-one-api.dev/v2\n```\n\n## Installing\n\nInstall this package into your project\n\n```sh\nnpm install @briannpham/lotr-sdk\n```\n\nImport all necessary pre-defined SDK functions into your project. Refer to the [documentation](https://github.com/briannpham/Brian_Pham-SDK/blob/main/design.md) for all provided SDKs\n\n```sh\nconst { getAllBooks, getAllChapters, lessThan } = require('@briannpham/lotr-sdk');\n```\n\n<hr>\n\n## Example\n\nAll provides SDKs return a Promise. Promise chaining or ```async/await``` must be used to work with SDKs\n\n```js\nconst allLOTRBooks = async () => {\n\tconst books = await getAllBooks();\n\n\treturn books\n};\n```\n\nor \n\n```js\ngetAllBooks()\n\t.then(books => console.log(books));\n```\n\n<hr>\n\n## Testing\n\nRefer to `index.test.js` for all SDK testing implementation\n\n### Example\n\n```js\nit('Get all book chapters', async () => {\n    const chapters = await getAllChapters();\n\n    expect(chapters.length).toBeGreaterThan(0);\n    expect(chapters[0]).toHaveProperty('chapterName');\n})\n```\n\n```js\nit('Return a list of movies that have RottenTomato score less than 70', \n    async () => {\n        const movies = await lessThan('movie', 'rottenTomatoesScore', 70);\n\n        expect(movies.length).toBe(3);\n        expect(movies[1].rottenTomatoesScore).toBe(64);\n});\n```","readmeFilename":"README.md"}