{"_id":"@darthhahn/tolog","_rev":"1-570a25735b0e51bd5191e93ad89ebd1d","name":"@darthhahn/tolog","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@darthhahn/tolog","version":"0.0.1","description":"Sends messages to a file.","repository":{"type":"git","url":"git+https://github.com/WalterHahn/tolog.git"},"main":"index.js","scripts":{"test":"jest"},"keywords":["log"],"author":{"name":"Walter F. Hahn"},"license":"MIT","dependencies":{"moment":"^2.24.0"},"devDependencies":{"jest":"^24.9.0"},"gitHead":"eba0ea03322b3b9a27ba0265cfb2069a293f38cf","bugs":{"url":"https://github.com/WalterHahn/tolog/issues"},"homepage":"https://github.com/WalterHahn/tolog#readme","_id":"@darthhahn/tolog@0.0.1","_nodeVersion":"10.16.0","_npmVersion":"6.10.1","dist":{"integrity":"sha512-+TzA5z93iWsk2mcWtoqrL+nRNslR/iP3nx7JCHQQXMQ0JRYHrsyuF4FwB2hRI7k+XpSDnKyHJoYgKauvDvEqpQ==","shasum":"67653155a9bef499bacdef5e5e30f1025dad3550","tarball":"https://registry.npmjs.org/@darthhahn/tolog/-/tolog-0.0.1.tgz","fileCount":4,"unpackedSize":4249,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJddADJCRA9TVsSAnZWagAAwVoP/3YYdtUKkxegjGR1LAzk\nJobDh4j6dmW/p8A5NqKTuWpsnwak3ki+FpgBTOEXUQ/q3wgOtdJjiPugpyYK\n7hB6YrTHzEk29QMkx56FL01s9HFSDMM2SsL3bzkNwuuBcqUijwZz75+bSTlR\nkEqFq424n7qsCdEsrSnuew1M0ZVv/SDo1FfwthlUpOsYpGoJtKIcWbOhee9X\nrc5ROHdXLG7t9HdDa0BPDqyOcsQ1ZFCD4+ro2XszVUUTjbOq/dVvJKLPKg49\nKmCSx9ViZtc88pouQ4oyFsyXx8H3MI5svCwqxqpdu1LiSBuJcasbi6cdjcgU\nDqkHsPb5swefkLnJ7G2jlCJHZgm4s0+uigx0z7tr9nlj3In6TjVrj4/HBr2l\nTJxMzd7oi/LAAj8CTK82UI1heCpTz7ILore9ueNdqKNWvPHS78mQl5NfGFfR\naf8BAliZk5fMypyfXuSmSVlhaGgM+D3IOPikgpXdFySZNFc0z+M/Otm09U9p\nFlRgXZht7+NEYErRnSxyED7J/pzNMhZJjsQHLbH52/66UiPrC5F+7+4RqrZI\n5p2tu+ac+Eyi4zpubWdE3Kj6cHn0cDY/97CINK3Er647+j12HTAPJjAy+enb\nnw7reYqmd7b9x+wpkk7BiE+0wWEDveJAWaA9OOSjbItP6knb5Uona6RWgt4A\nbMzU\r\n=1pKD\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAytAzCcr6QhzqQti0LU8a8b5vvx3uldfEKHSEowvNcqAiEA3GLFrMaUspNYZovEcY/9x0+gUh3n2esw+iryhrO74NU="}]},"maintainers":[{"name":"darthhahn","email":"darth.hahn@gmail.com"}],"_npmUser":{"name":"darthhahn","email":"darth.hahn@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tolog_0.0.1_1567883465322_0.9001527119344683"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-07T19:11:05.105Z","0.0.1":"2019-09-07T19:11:05.442Z","modified":"2022-04-05T02:46:08.811Z"},"maintainers":[{"name":"darthhahn","email":"darth.hahn@gmail.com"}],"description":"Sends messages to a file.","homepage":"https://github.com/WalterHahn/tolog#readme","keywords":["log"],"repository":{"type":"git","url":"git+https://github.com/WalterHahn/tolog.git"},"author":{"name":"Walter F. Hahn"},"bugs":{"url":"https://github.com/WalterHahn/tolog/issues"},"license":"MIT","readme":"# tolog\r\n\r\nLogs messages to files.\r\n\r\n\r\n\r\n## Usage\r\n\r\nTo start logging, run the start method.  This will initialize options and open the file stream.\r\n\r\n```javascript\r\nvar tolog require('../index');\r\n\r\ntolog.start({\r\n    path: './to.log',\r\n    logToConsole: true\r\n});\r\n```\r\n\r\nThere are multiple methods available for logging.  Each method prepends the date and time to each appended line in the format `2019-01-11T00:00:00-07:00`.\r\n\r\n```javascript\r\n// appends `$date info foo` to log file\r\ntolog.info('foo');\r\n\r\n// appends `$date error bar` to log file\r\ntolog.error('bar');\r\n```\r\n\r\nLogging with custom context is also supported.\r\n\r\n```javascript\r\n// appends `$date foo bar` to log file\r\ntolog.log('foo', 'bar');\r\n```\r\n\r\nTo stop logging to file, execute the end method.\r\n\r\n```javascript\r\ntolog.end();\r\n```\r\n\r\n\r\n\r\n## Options\r\n\r\n| Option       | Default  |                                                 |\r\n| ------------ | -------- | ----------------------------------------------- |\r\n| logToConsole | false    | If true, messages will log to file and console. |\r\n| path         | ./to.log | File path of log file.                          |\r\n\r\n\r\n\r\n## Testing\r\n\r\n**tolog** uses the [jest](https://jestjs.io/) framework.  To execute all tests, run `npm test`.","readmeFilename":"README.md"}