\n\n## Introduction\nNode.js Telescope is an elegant debug assistant based on Telescope for Laravel framework. \nTelescope provides insight into the requests coming into your application, \nexceptions, console.log entries, variable dumps and more. Telescope makes a \nwonderful companion to your local development environment.\n\n### [Laravel Telescope](https://github.com/laravel/telescope)\n\n\n\n## Docs\n### 1. Installation\n\n```npm\nnpm i @damianchojnacki/telescope\n```\n\n### 2. Usage\nSetup Telescope BEFORE any route. Setup ErrorWatcher if needed at the end.\n\n```javascript\nimport Telescope, { ErrorWatcher } from '@damianchojnacki/telescope'\n\nconst app = express()\n\nconst telescope = Telescope.setup(app)\n\napp.get('/', (request, response) => {\n response.send('Hello world')\n})\n\nErrorWatcher.setup(telescope)\n```\n\nNow you can access telescope panel at `/telescope`.\n\n#### RequestWatcher\n\nIntercepts requests and responses.\n\n#### LogWatcher\n\nIntercepts console messages.\n\n`console.log` - creates `info` level log\n`console.warn` - creates `warning` level log\n`console.table` - creates `info` level table log\n\n```javascript\nconsole.log(message, ...content)\n```\n\n#### ClientRequestWatcher\n\nIntercepts axios requests and responses.\n\n#### ErrorWatcher\n\nLogs unhandled errors.\n\n#### DumpWatcher\n\nSaves dump messages.\n\n```javascript\nimport { dump } from \"@damianchojnacki/telescope\"\n\ndump(\"foo\")\n```\n\n### 3. Note about ErrorWatcher (only express < 5.0.0)\n\nUnhandled exception thrown in async function causes that Telescope will is unable to create associated request:\nSee [Express docs](http://expressjs.com/en/advanced/best-practice-performance.html#use-promises)
\n`WRONG ❌`\n```javascript\napp.get('/', async (request, response) => {\n await someAsyncFuncThatThrowsException()\n \n response.send('Hello world')\n})\n```\n\n`GOOD ✅`\n```javascript\napp.get('/', async (request, response, next) => {\n try{\n await someAsyncFuncThatThrowsException()\n } catch(error) {\n next(error)\n }\n \n response.send('Hello world')\n})\n```\n### 4. Configuration\n\n#### Enabled watchers\n\n```javascript\nTelescope.setup(app, {\n enabledWatchers: {\n RequestWatcher,\n ErrorWatcher,\n ClientRequestWatcher,\n DumpWatcher,\n LogWatcher,\n },\n responseSizeLimit: 128,\n paramsToHide: [\n 'password',\n '_csrf'\n ],\n ignorePaths: [\n '/admin*',\n '/docs'\n ],\n ignoreErrors: [\n TypeError\n ],\n isAuthorized: (request, response, next) => {\n if(!request.isAuthenticated()){\n response.redirect('/login')\n\n return\n }\n \n next()\n },\n getUser: (request) => request.user, // {id: 1, email: 'user@example.com', name: 'John'}\n})\n```\n`enabledWatchers` - list of enabled watchers\n\n`responseSizeLimit` - response size limit (KB).\nIf limit is exceed watcher will not log response body.\n\n`paramsToHide` - filter sensitive data,\nIf paramsToFilter matches request param it will be converted to *******.\n\n`ignorePaths` - paths to ignore, exact paths or wildcard can be specified\n\n`ignoreErrors` - errors to ignore\n\n`isAuthorized` - be default telescope is disabled on production, if you want to change this behaviour you can provide custom isAuthorized function\n\n`getUser` - telescope will display provided user on the request preview page, id is required, name and email are optional\n\n#### Database drivers\nCustomizing database driver:\n```javascript\nimport { MemoryDriver } from \"@damianchojnacki/telescope\"\n\nconst telescope = Telescope.setup(app, {\n databaseDriver: MemoryDriver\n})\n```\n\nAt the moment available are two drivers:\n1. LowDriver (LowDB) - data is stored in json file and persist between application restart.\n2. MemoryDriver - data is stored in memory and will be lost after application restart.\n\nFeel free to create custom driver. It must implement `DatabaseDriver`:\n```typescript\nget(name: WatcherEntryCollectionType, take?: number): Promise[]>\n\nfind(name: WatcherEntryCollectionType, id: string): Promise | undefined>\n\nbatch(batchId: string): Promise[]>\n\nsave(name: WatcherEntryCollectionType, data: WatcherEntry): Promise\n\nupdate(name: WatcherEntryCollectionType, index: number, toUpdate: WatcherEntry): Promise\n\ntruncate(): Promise\n```\n\n## License\n\nNode.js Telescope is open-sourced software licensed under the [MIT license](LICENSE.md).\n","readmeFilename":"README.md","homepage":"https://github.com/damianchojnacki/telescope#readme","repository":{"type":"git","url":"git+https://github.com/damianchojnacki/telescope.git"},"bugs":{"url":"https://github.com/damianchojnacki/telescope/issues"}}
![\"Telescope](\"https://raw.githubusercontent.com/damianchojnacki/damianchojnacki/main/telescope.svg\")
![\"Express](\"https://img.shields.io/badge/express-%3E%3D%204.0.0-blue\"){kind=icon}
![\"License](\"https://img.shields.io/badge/license-MIT-brightgreen\"){kind=icon}
![\"Downloads\"/](\"https://img.shields.io/npm/dm/@damianchojnacki/telescope\")
![\"Build\"/](\"https://img.shields.io/github/workflow/status/damianchojnacki/telescope/Node.js%20CI\")