{"_id":"@_zaphod/scribejs","_rev":"3-1fab6d77383613567f60dc5744b324a6","name":"@_zaphod/scribejs","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.1":{"name":"@_zaphod/scribejs","version":"1.0.1","description":"A package to procedurally generate sentences.","main":"src/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","prettier":"prettier --ignore-path .gitignore \"**/*.+(js|json|ts|tsx|jsx)\"","format":"npm run prettier -- --write","check-format":"npm run prettier -- --list-different"},"repository":{"type":"git","url":"git+https://github.com/ZaphodAndo/scribejs.git"},"keywords":["Procedural","Generator","Sentences","Text"],"author":{"name":"Zaphod"},"license":"MIT","bugs":{"url":"https://github.com/ZaphodAndo/scribejs/issues"},"homepage":"https://github.com/ZaphodAndo/scribejs#readme","devDependencies":{"prettier":"^2.1.2"},"gitHead":"64a573ca20e0acbb11455408ca4a6d4f061b42ef","_id":"@_zaphod/scribejs@1.0.1","_nodeVersion":"10.16.2","_npmVersion":"6.14.5","dist":{"integrity":"sha512-5lrjmmErhETiDhCHIDnOIGh09a+SAAPGoPjQqfvQ4C9kCwc4dAoyYY01Hnx+wrSZJ+a8wANWlGwpvLbCLU6F8Q==","shasum":"7459f389f204d388cd42f1149425718595119c55","tarball":"https://registry.npmjs.org/@_zaphod/scribejs/-/scribejs-1.0.1.tgz","fileCount":9,"unpackedSize":8339,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftqQrCRA9TVsSAnZWagAAQb0P+wZ7DYrW+vCpPpobWEcX\nm7Id8NhwIAXkOTP1H4lByU7pQqEJnz1FQX/vTdhyAhqhJ/Qv+5B6AEkemAby\n6KOraRxjMpK7f98fqH3L/uz79XX69qPGdn08j1CMhsKNe12bPBiWfDI4wKK9\njNbX3KfN9QleRSIBqHJNyuMNqdjRFj+zQL22K8AnPC3sZDx6/CDnDzCPJ9CP\nQ0W9/2xwel9y7X9C+lVUngaj1dNM5ujYvq3Fu8ejY4Li0wUGv7UBZCVCYewr\nSuD3yo5PCCBS05ZTF4UlEDpZj4QNKZQ8Ptc5o9+nIE6vyEzivSqD/3TyUjAk\nKj9KQ10JaGZEoMGcUrdN3EgNm2sSPZQOSG9rWFaB9J5lzeczlbRFZFVl1Q1W\nkZRDLx6TV+wifm+wGKqajdMr+rr3eLcnnbh7fsSFy/9Z4dWaqV2M0c+RxZCH\nz3lUMyf5Gf5JerW6JvCvVoKxpgmVqQlwPai1b5thQcoOn9UGR20Nn2FZWDTc\nm4HLgm20YMYoLXmhNMVAzWSSkO5RmM7EzqSqy3JrWCJoCs2oVNesh0XY9bFp\n1ant6ZmpEMd0lf7Q9rnHgyb/QV2ZIXkjAkMmm5057JE1DfKgzwhiwv+hi8ae\nopGcvDF2qTq3zrIQMvs3M97gxfqiD3ZKYbauNHTsxXS76rVnPO2DRoRw7xdX\nIjxS\r\n=3NSl\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC6Ry3FgxCo/2wkPFaNFUoovqgxByHz0H/ly+ueBAOhHgIhALUsrYPAoewLoMR7FNC9RoxfHR3eZT1zAXiSCU3uxr//"}]},"_npmUser":{"name":"_zaphod","email":"ethan.anderson00@gmail.com"},"directories":{},"maintainers":[{"name":"_zaphod","email":"ethan.anderson00@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/scribejs_1.0.1_1605805099117_0.3978118399956099"},"_hasShrinkwrap":false},"1.0.2":{"name":"@_zaphod/scribejs","version":"1.0.2","description":"A package to procedurally generate sentences.","main":"src/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","prettier":"prettier --ignore-path .gitignore \"**/*.+(js|json|ts|tsx|jsx)\"","format":"npm run prettier -- --write","check-format":"npm run prettier -- --list-different"},"repository":{"type":"git","url":"git+https://github.com/ZaphodAndo/scribejs.git"},"keywords":["Procedural","Generator","Sentences","Text"],"author":{"name":"Zaphod"},"license":"MIT","bugs":{"url":"https://github.com/ZaphodAndo/scribejs/issues"},"homepage":"https://github.com/ZaphodAndo/scribejs#readme","devDependencies":{"prettier":"^2.1.2"},"gitHead":"d9338f3f4244a0006539fb454f588192ede4873a","_id":"@_zaphod/scribejs@1.0.2","_nodeVersion":"10.16.2","_npmVersion":"6.14.5","dist":{"integrity":"sha512-sRZ3ftlyejL/i0vdx10oKOTSFemhwThNbwLLpvWJETQTA14aof4xVkEmCKKp6IwEmNhU9D1uhoupiibYgQ0Jqw==","shasum":"7347010453057920a0aba13a09eebb03c8e98691","tarball":"https://registry.npmjs.org/@_zaphod/scribejs/-/scribejs-1.0.2.tgz","fileCount":9,"unpackedSize":8439,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftqk5CRA9TVsSAnZWagAAiB8QAIfHgJfW76bfAPgqvw2Y\n02JUUcZUlXtXnvwZ1yTZH7Zv4vswLr5HA2Rq9WBK6fIVwaRiNmpDWzEyfCs1\niNl0136aygmVuMVyJ9d5Ax02ayDpngtI1aEsJV4//ZznrWL4P3coB+JSZ6hQ\n2Bt/Sdpl1iIHCTL4m1lQEKcrx9fSIZrtIoWJG5gi/ToO5hRy+EIZ3B7Bd7Jc\nz0/w6WAd5P9LS7Z7nE8q7lgJBzQ8zipCyZRMLpm59qctUP81Z+FcgncOub3a\nmwLyjk94SGdG+XsfrUxKTRZ5hXltNffv/NnodI00ck+vw5iURoDmr3F9uM/0\nN3/2+RwF1GNFje9vGUNGKdQOBGEoswCtW0nWP+6+byMw7LcN7eOGYW801A7i\nieDldfIqOb8VnwLCZ9rWeokrmEJYxKwlBSNMKBAnb6HcbBtzcdIyOQPUfed8\nuUTJIMAYLLSes4D5qSynsbD2c4GCw7aPg2QoftLHuptVMQ5Q/Nr6wKISQbat\nhoiqB2wSpUIUt8vKxqtWYax1N5fNSMbWh5NVPaamsVS28pTurTxUG/IBFDdW\nofAP8a4KPLkZWahjXYyzbeeciLXgaf/ttnuBQL6eHjrjlHqm+fFEFOD8i6PY\nEnFTF2VdLiCkCevIYZTFNLSr1VsfdSlV5+Ue2TTAnMP/gR9wvNHKLLzzU8lb\nRDfi\r\n=nPE5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDftDiYWLmd101I7f52MgSLYLc5KNJbJHkMgIlBChIfUQIhAIPxuW9/hr73q7xUTzy8A1ueKlzPukJFMeK7TZsGz1/V"}]},"_npmUser":{"name":"_zaphod","email":"ethan.anderson00@gmail.com"},"directories":{},"maintainers":[{"name":"_zaphod","email":"ethan.anderson00@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/scribejs_1.0.2_1605806392537_0.17180209445115202"},"_hasShrinkwrap":false},"1.0.3":{"name":"@_zaphod/scribejs","version":"1.0.3","description":"A package to procedurally generate sentences.","main":"src/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","prettier":"prettier --ignore-path .gitignore \"**/*.+(js|json|ts|tsx|jsx)\"","format":"npm run prettier -- --write","check-format":"npm run prettier -- --list-different"},"repository":{"type":"git","url":"git+https://github.com/ZaphodAndo/scribejs.git"},"keywords":["Procedural","Generator","Sentences","Text"],"author":{"name":"Zaphod"},"license":"MIT","bugs":{"url":"https://github.com/ZaphodAndo/scribejs/issues"},"homepage":"https://github.com/ZaphodAndo/scribejs#readme","devDependencies":{"prettier":"^2.1.2"},"gitHead":"e3cb1489d3d69d4e69ea72f49bc5c4694650d4fd","_id":"@_zaphod/scribejs@1.0.3","_nodeVersion":"12.18.3","_npmVersion":"6.14.6","dist":{"integrity":"sha512-lxyk+XNdNHU2k8XrkPCXa6fddqPiZTR9x0V78vnk5JgQWI9ikyRh6DFXObSR6UOwXzCe5im9/xeviHI7fKsrbA==","shasum":"c1cf8d83f6bf7fd0f88c71c7c1dbbdc64240a800","tarball":"https://registry.npmjs.org/@_zaphod/scribejs/-/scribejs-1.0.3.tgz","fileCount":7,"unpackedSize":7944,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftq9DCRA9TVsSAnZWagAAFi8P/RFJLvgfkcTFBWANlgjg\n20r2V1vAdoRGGilld/UuagBFWSZXPjjLOhDePrxH8c/yE42u3mWYQVebLteP\nJ93QwrYSqsFU9uNmbZb3zvQh793LFwa4beJITpWndAxcRBPMUyLGUr1lApHy\n32dNaKpQpijavBYris/xwTJECegfrLFRWfPW7B7zY/RO4uhFrxSuyh15cmWX\nRHwD54mFzw+CNXdtCYFni4TYMg9amveEA8BCOqTNZAjhM39x6KeMiLoQ2T7E\ncn/4O367OYhCe0/XJWHFkBMXdP1LX22q5PHE3TiQd5WLvZbm+qgbDVi/YTm/\nNiRn46kwKSzE6ViAWOW1Ptx+wNIoa68RaKtcdYflrtD6sjknXRn6xORnzJB7\nMhc/u7v4lNT+tcXJACQziE73+pEIuh5tgEy9hpBFaIdyLwNnRTDryjSulV1Z\nZJgkpWyFFRGlomdNMyjbAqmF4mBNBjb7PMlcdKeREHHQx2l5rdDlu+yrIxI/\nn+s7VpO4oPCQNYN65y/wqCP3kJD5kdsmR6qD8+FbqR29MKssohFy11/Vnpzd\n1yaaeCiI2Vu+KefTHz71aVzJ4g+KUVRTudq+9GgF4iWTKfIKkEY80HxSTTF4\n9v77mBNguffB7arBBgJEW+lC2AlOvt9w+f3g/riFFraO4KcmWyUBX+dBugkB\nwXZq\r\n=6TEE\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDm/OdMHg7OImcGbkkJrAfLMnV+wcdZYnEJQGQqZ4euZwIhAOSiisM0uO8LjL/3qZkt9TsYGFz/lONYggzYe995HGZV"}]},"_npmUser":{"name":"_zaphod","email":"ethan.anderson00@gmail.com"},"directories":{},"maintainers":[{"name":"_zaphod","email":"ethan.anderson00@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/scribejs_1.0.3_1605807938701_0.06046279204756266"},"_hasShrinkwrap":false}},"time":{"created":"2020-11-19T16:58:19.086Z","1.0.1":"2020-11-19T16:58:19.238Z","modified":"2022-04-04T10:51:44.614Z","1.0.2":"2020-11-19T17:19:52.646Z","1.0.3":"2020-11-19T17:45:38.834Z"},"maintainers":[{"name":"_zaphod","email":"ethan.anderson00@gmail.com"}],"description":"A package to procedurally generate sentences.","homepage":"https://github.com/ZaphodAndo/scribejs#readme","keywords":["Procedural","Generator","Sentences","Text"],"repository":{"type":"git","url":"git+https://github.com/ZaphodAndo/scribejs.git"},"author":{"name":"Zaphod"},"bugs":{"url":"https://github.com/ZaphodAndo/scribejs/issues"},"license":"MIT","readme":"# ScribeJS 📝\n\nScribeJS is a package that allows you to create randomly generated sentences by providing datasets of values and\nspecifying which parts of a sentence you wish to randomise.\n\n## Syntax\n\n### Defining datasets\n\nAll of your datasets should be arrays and the values that they contain should be strings.\\\nThese datasets should then all be placed within an object that can then be passed to ScribeJS to be used.\n\nExample:\n\n```json\n{\n  \"animals\": [\"cat\", \"dog\", \"cow\", \"pig\", \"monkey\"],\n  \"names\": [\"Sylvan\", \"Kieran\", \"Tej\", \"Jon\", \"AJ\"],\n  \"places\": [\"London\", \"Birmingham\", \"Telford\", \"Liverpool\"],\n  \"objects\": [\"cup\", \"pen\", \"keyboard\", \"glass\"]\n}\n```\n\n### Defining datasets in sentences\n\nTo specify what words in a sentence you wish to randomise and which dataset they should use you simply write the name of\nyour dataset like this: `|animals|` and embed it into the sentence where ever you want it to generate a word from that\ndataset.\n\nExample in sentence: `Hello my name is |names|`\n\n## API\n\n`generator(sentence: string): string`\n\n- Takes in a sentence that contains dataset references\n- Returns the sentence with the dataset references replaced with randomised values from that dataset.\n\n## Example\n\nThe example below shows how you might implement ScribeJS:\n\n```javascript\n// Import the package into our JS file.\nimport Scribe from \"scribejs\";\n\n// Define an array with datasets that we want to use.\nconst datasets = {\n  animal: [\"cat\", \"dog\", \"cow\", \"pig\", \"monkey\"],\n  person: [\"Sylvan\", \"Kieran\", \"Tej\", \"Jon\", \"AJ\"]\n};\n\n// Initalise ScribeJS and pass in the datasets.\nconst scribe = new Scribe(datasets);\n\n// Call the generator function and pass in the sentence we want to randomise.\nconst result = scribe.generator(\"|person| went to the park. At the park they saw a |animal|!\");\n```\n\nPotential outcomes for the example above include:\n\n```\nSylvan went to the park. At the park he saw a cat!\nKieran went to the park. At the park he saw a dog!\nAJ went to the park. At the park he saw a cow!\nSylvan went to the park. At the park he saw a monkey!\nect...\n```\n","readmeFilename":"README.md"}