{"_id":"@allroundexperts/tlor-sdk","name":"@allroundexperts/tlor-sdk","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@allroundexperts/tlor-sdk","version":"1.0.0","description":"SDK that communicates with the OneAPI to get the movies related to the Lord of the rings.","main":"dist/index.js","type":"module","scripts":{"build":"tsc","test":"jest","lint":"eslint .","format":"prettier --ignore-path .gitignore --write \"**/*.+(ts)\""},"keywords":["The lord of the rings","TLOR","SDK","OneAPI"],"author":{"name":"Sibtain Ali"},"license":"ISC","devDependencies":{"@types/jest":"^29.5.0","@types/node":"^18.15.11","@typescript-eslint/eslint-plugin":"^5.58.0","@typescript-eslint/parser":"^5.58.0","eslint":"^8.38.0","eslint-config-prettier":"^8.8.0","fetch-mock-jest":"^1.5.1","jest":"^29.5.0","prettier":"^2.8.7","ts-jest":"^29.1.0","typescript":"^5.0.4"},"dependencies":{"node-fetch":"^2.6.7","reflect-metadata":"^0.1.13","tsyringe":"^4.7.0"},"jest":{"setupFilesAfterEnv":["./jest/setup.ts"],"preset":"ts-jest","testEnvironment":"node","transform":{"^.+\\.ts?$":"ts-jest"}},"types":"./dist/index.d.ts","gitHead":"451e70cf57a6da31508f26e20de7f268513cddc0","_id":"@allroundexperts/tlor-sdk@1.0.0","_nodeVersion":"16.17.1","_npmVersion":"8.15.0","dist":{"integrity":"sha512-JQEzSRHEpAltNhGw3PKqwpytxBpgckO0KcdADPm0rN4FbQ3RiM5yYzWNmd6FzxPu2rxKxr6vRckR4mSZGLy23g==","shasum":"9cdb3a2fd6d624b2c968fc74be08c56b4390227b","tarball":"https://registry.npmjs.org/@allroundexperts/tlor-sdk/-/tlor-sdk-1.0.0.tgz","fileCount":12,"unpackedSize":18127,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCQVC5ieIFskWcNSGtrxTuWfhESJZYGUun0W6X/ldYueAIgUr/rWILATKviRcaV3e60vke+EHlkDH8/bJ5JrOrL5J4="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkO8yLACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoY3A//fXZCqT08yeyyieWvBDh8MzO4oEOTVtYwVr9Zg69HZH0tbOFp\r\naDQJqQknOBHdjv32oyNssnRSLU3tO7A7240rvLM7vX+ftDvZ36vaZwtpl7T2\r\n6a9WBsA6x7kbt5eupfzOJgRPv2WjpzyKQ5/h25AcXeNZ+w7U/18EQ4VolhbF\r\n/hljhfD+KiV72FxCawgjlJBFOmW2/Xq2w3hez727/XE4RYuAwfYdU5TsrYA4\r\n36crWozBjRAsSd3gTUEdeeXQGb74kjjDGpmGmhiXeT7K2/wDMk57moiZlJoO\r\nsLTzfk3WG3HZJz445S2qwPQUulrKT27ZKpatZMmuUXrVq4IkTLeRqcUfx780\r\nJ8h5P2nYrvIQ50o9CWQcQaXDrmKRKQrP4ZKV7MVTSsPGbDGDgi7W3r2tBDnl\r\nGr5vSzSjlcrr0Yt9wh71TSJoRJI9RRkIXxloR17Z2TaDsOunN1gWi5jNhEqE\r\nl2uhFnf/jcIhTRgP/tVI9k4fQZ6LOQqx4OGbBqiu3STihTIXOryM7sDsIOO/\r\nIMewThQydswsBj3pxMp0dQBNJOWfaPfHvlvoVbbjTaWepKtKX1/u029cevrD\r\n2rq73JV2z1DvvDUcUNuO1D1lXeRSzH6OOvYCD6aAxs62GjxBWwWtuo++vrZn\r\njnUVCErvl/+0xW4Q6KFyUljZ4idMb4uFZFM=\r\n=aeKq\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"allroundexperts","email":"allroundexperts@gmail.com"},"directories":{},"maintainers":[{"name":"allroundexperts","email":"allroundexperts@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tlor-sdk_1.0.0_1681640587730_0.5688081315221123"},"_hasShrinkwrap":false}},"time":{"created":"2023-04-16T10:23:07.680Z","1.0.0":"2023-04-16T10:23:07.958Z","modified":"2023-04-16T10:23:08.124Z"},"maintainers":[{"name":"allroundexperts","email":"allroundexperts@gmail.com"}],"description":"SDK that communicates with the OneAPI to get the movies related to the Lord of the rings.","keywords":["The lord of the rings","TLOR","SDK","OneAPI"],"author":{"name":"Sibtain Ali"},"license":"ISC","readme":"# Installation\n\n```bash\nnpm install @allroundexperts/tlor-sdk\n```\n\n# API\nThis SDK uses the API documented [here](https://the-one-api.dev/documentation)\n\n# Usage\n\n```js\nimport TLOR from '@allroundexperts/tlor-sdk';\n\nconst tlor = new TLOR('your-api-key');\n\nconst movie = await tlor.movie.getOne();\n```\n\n## Resources\n\n### Movie\n\n**Get All Movies**\n```js\nawait sdk.movie.getAll();\n```\n\n**Get One Movie**\n```js\nawait sdk.movie.getOne(id);\n```\n\n### Pagination\n\n```js\nsdk.movie.getAll({\n    limit: 20, \n    offset: 10,\n    page: 1,\n});\n```\n\n### Sorting\n\n```js\nsdk.movie.getAll({\n    sortBy: 'name',\n    sortDirection: 'ASC',\n});\n```\n\n### Filter\n\nFilter tokens available:\n```js\nEQUAL\nNOT_EQUAL\nINCLUDE\nNOT_INCLUDE\nEXISTS\nNOT_EXISTS\nLIKE\nGREATER_THAN\nLESS_THAN\nGREATER_THAN_EQUAL_TO\nLESS_THAN_EQUAL_TO\n```\n\n```js\nimport {FilterToken} from \"resource/IResosurce\";\nsdk.movie.getAll({\n    filter: {[\n        {key: 'name', op: FilterToken.EQUAL, value: 'Test'},\n        {key: 'academyAwardWins', op: FilterToken.GREATER_THAN, value: 10}\n    ]}\n});\n```","readmeFilename":"README.md"}