{"_id":"@aberoth-community/overheard","_rev":"3-e9b9858f82a124b47e053d1665a39a44","name":"@aberoth-community/overheard","dist-tags":{"latest":"3.0.3"},"versions":{"3.0.0":{"name":"@aberoth-community/overheard","version":"3.0.0","keywords":["aberoth","rpg"],"author":{"name":"ashnel3"},"license":"MIT","_id":"@aberoth-community/overheard@3.0.0","maintainers":[{"name":"ashnel3","email":"ashnel3333@gmail.com"}],"homepage":"https://github.com/aberoth-community/overheard#readme","bugs":{"url":"https://github.com/aberoth-community/overheard/issues"},"bin":{"overheard":"dist/bin.js"},"pkg":{"outputPath":"bin"},"dist":{"shasum":"ad285a42a98c697a13bf78877da889d0372d3c80","tarball":"https://registry.npmjs.org/@aberoth-community/overheard/-/overheard-3.0.0.tgz","fileCount":9,"integrity":"sha512-OmVG/+KZdMwilfMBe3c+NFIY6/HwbkwYCtuMRogGkko5SQ/xhoz0pyaYFqcuuGlxBKDkjcl/X+QvWyxGKVU/rg==","signatures":[{"sig":"MEUCIFWhD5tMXFuy9TmImSdayhpU9orXPKe3/7Uln5A1AxC3AiEA8pr8o9idNMY8RW/4lJL7Cpuhl5VILDHBYVN82vr8ccU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":21732},"main":"./dist/bin.js","type":"module","types":"./dist/bin.d.ts","engines":{"node":">=18"},"gitHead":"4c0de94afa7041208ef2db62b9553ec8886c31b6","scripts":{"fmt":"prettier -c --write \"**/*.{md,cjs,js,json,ts,yml,yaml}\"","lint":"pnpm run /^lint:.*/","test":"vitest --run","build":"tsc --stripInternal","clean":"rimraf bin dist docs","start":"vite-node src/bin.ts","lint:es":"eslint src/**/*","prepare":"husky","lint:fmt":"pnpm prettier --list-different \"**/*.{md,cjs,js,json,ts,yml,yaml}\"","build:dev":"tsc --sourceMap","build:pkg":"pkg ."},"_npmUser":{"name":"ashnel3","email":"ashnel3333@gmail.com"},"repository":{"url":"git+ssh://git@github.com/aberoth-community/overheard.git","type":"git"},"_npmVersion":"10.2.3","description":"A simple overheard scraper","directories":{},"_nodeVersion":"18.19.0","dependencies":{"commander":"^12.0.0","typescript-event-target":"^1.1.0"},"engineStrict":true,"_hasShrinkwrap":false,"devDependencies":{"pkg":"^5.8.1","vite":"^5.1.3","husky":"^9.0.10","eslint":"^8.56.0","rimraf":"^5.0.5","vitest":"^1.3.0","typedoc":"^0.25.8","prettier":"^3.2.4","vite-node":"^1.3.0","typescript":"^4.9.5","@types/node":"^20.11.16","eslint-plugin-n":"^16.6.2","eslint-plugin-import":"^2.29.1","eslint-plugin-promise":"^6.1.1","eslint-config-prettier":"^8.10.0","eslint-config-standard":"^17.1.0","eslint-plugin-prettier":"^5.1.3","@typescript-eslint/eslint-plugin":"^6.20.0","eslint-config-standard-with-typescript":"^43.0.1"},"_npmOperationalInternal":{"tmp":"tmp/overheard_3.0.0_1708430478081_0.5265540651761924","host":"s3://npm-registry-packages"}},"3.0.1":{"name":"@aberoth-community/overheard","version":"3.0.1","keywords":["aberoth","rpg"],"author":{"name":"ashnel3"},"license":"MIT","_id":"@aberoth-community/overheard@3.0.1","maintainers":[{"name":"ashnel3","email":"ashnel3333@gmail.com"}],"homepage":"https://github.com/aberoth-community/overheard#readme","bugs":{"url":"https://github.com/aberoth-community/overheard/issues"},"bin":{"overheard":"dist/bin.js"},"pkg":{"outputPath":"bin"},"dist":{"shasum":"0d7ebde95ef267d1c8b208aa8137ce746a25d602","tarball":"https://registry.npmjs.org/@aberoth-community/overheard/-/overheard-3.0.1.tgz","fileCount":9,"integrity":"sha512-vb3cLEVzybBznrMboCM52go3OPLtunqFEmMIragMkltnzWvB4jXywBhvV+7NjnbZe85Z+FJnPP0UVgiagwlkNQ==","signatures":[{"sig":"MEQCIG47JXXpMe+jYpqtGXJGxrWypja2fIEFlI7QK8sPnm3TAiBnwoMlqP/Wc5RPtCJ9MypJtkKBTJyRjmwq++8AI2PIjw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":22252},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"gitHead":"bec4f2e429b85a1fb91a59ffb9bc141ebfadbe77","scripts":{"fmt":"prettier -c --write \"**/*.{md,cjs,js,json,ts,yml,yaml}\"","lint":"pnpm run /^lint:.*/","test":"vitest --run","build":"tsc --stripInternal","clean":"rimraf bin dist docs","start":"vite-node src/bin.ts","lint:es":"eslint src/**/*","prepare":"husky","lint:fmt":"pnpm prettier --list-different \"**/*.{md,cjs,js,json,ts,yml,yaml}\"","build:dev":"tsc --sourceMap","build:pkg":"pkg ."},"_npmUser":{"name":"ashnel3","email":"ashnel3333@gmail.com"},"repository":{"url":"git+ssh://git@github.com/aberoth-community/overheard.git","type":"git"},"_npmVersion":"10.2.3","description":"A simple overheard scraper","directories":{},"_nodeVersion":"18.19.0","dependencies":{"typescript-event-target":"^1.1.0"},"engineStrict":true,"_hasShrinkwrap":false,"devDependencies":{"pkg":"^5.8.1","vite":"^5.1.3","husky":"^9.0.10","eslint":"^8.56.0","rimraf":"^5.0.5","vitest":"^1.3.0","typedoc":"^0.25.8","prettier":"^3.2.4","vite-node":"^1.3.0","typescript":"^4.9.5","@types/node":"^20.11.16","eslint-plugin-n":"^16.6.2","eslint-plugin-import":"^2.29.1","eslint-plugin-promise":"^6.1.1","eslint-config-prettier":"^9.1.0","eslint-config-standard":"^17.1.0","eslint-plugin-prettier":"^5.1.3","@typescript-eslint/eslint-plugin":"^6.20.0","eslint-config-standard-with-typescript":"^43.0.1"},"optionalDependencies":{"commander":"^12.0.0"},"_npmOperationalInternal":{"tmp":"tmp/overheard_3.0.1_1708493632871_0.886293048807661","host":"s3://npm-registry-packages"}},"3.0.2":{"name":"@aberoth-community/overheard","version":"3.0.2","keywords":["aberoth","rpg"],"author":{"name":"ashnel3"},"license":"MIT","_id":"@aberoth-community/overheard@3.0.2","maintainers":[{"name":"ashnel3","email":"ashnel3333@gmail.com"}],"homepage":"https://github.com/aberoth-community/overheard#readme","bugs":{"url":"https://github.com/aberoth-community/overheard/issues"},"dist":{"shasum":"0de1650bdf3697ba46d6b9756e7b457d71d6c42d","tarball":"https://registry.npmjs.org/@aberoth-community/overheard/-/overheard-3.0.2.tgz","fileCount":12,"integrity":"sha512-18/J6kRx9vZOurL6qZIAiUlaGnDaq6LaUhUSfYEieei4KYYm5F2uEU3hG0AlJekWlprEK5QEV20XSbSOlJhtPg==","signatures":[{"sig":"MEUCICZOANMh8AYW1i3QiruBayZNTOPTQKsDhv3jY82jALM9AiEA3ADe3Ya/xY1hN14PdM8CnMxCP8XZl55m7MTXJpXh3eA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24636},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"exports":{"./bin":{"import":"./dist/bin.js","require":"./dist/bin.cjs"},"./overheard":{"import":"./dist/index.js","require":"./dist/index.cjs"}},"gitHead":"ef82171bd38320cc85d0c1a91afb8c95ef17ea5a","scripts":{"fmt":"prettier -c --write \"**/*.{md,cjs,js,json,ts,yml,yaml}\"","lint":"pnpm run /^lint:.*/","test":"vitest --run","build":"vite build","clean":"rimraf bin dist docs","start":"vite-node src/bin.ts","lint:es":"eslint .","prepare":"husky","lint:fmt":"pnpm prettier --list-different \"**/*.{md,cjs,js,json,ts,yml,yaml}\""},"_npmUser":{"name":"ashnel3","email":"ashnel3333@gmail.com"},"repository":{"url":"git+ssh://git@github.com/aberoth-community/overheard.git","type":"git"},"_npmVersion":"10.7.0","description":"A simple overheard scraper","directories":{},"_nodeVersion":"18.20.4","dependencies":{"commander":"^12.0.0","typescript-event-target":"^1.1.1"},"engineStrict":true,"_hasShrinkwrap":false,"packageManager":"pnpm@9.8.0","devDependencies":{"vite":"^5.4.3","husky":"^9.1.5","eslint":"^9.9.1","rimraf":"^6.0.1","vitest":"^2.0.5","globals":"^15.9.0","typedoc":"^0.26.6","prettier":"^3.3.3","vite-node":"^2.0.5","@eslint/js":"^9.9.1","typescript":"^5.5.4","@types/node":"^22.5.4","vite-plugin-dts":"^4.1.0","typescript-eslint":"^8.4.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.2.1","rollup-plugin-node-externals":"^7.1.3"},"_npmOperationalInternal":{"tmp":"tmp/overheard_3.0.2_1725564717263_0.6450211075173764","host":"s3://npm-registry-packages"}},"3.0.3":{"name":"@aberoth-community/overheard","version":"3.0.3","description":"A simple overheard scraper","bin":{"overheard":"dist/bin.cjs"},"main":"./dist/index.js","type":"module","exports":{"./bin":{"import":"./dist/bin.js","require":"./dist/bin.cjs"},"./overheard":{"import":"./dist/index.js","require":"./dist/index.cjs"}},"scripts":{"start":"vite-node src/bin.ts","clean":"rimraf bin dist docs","build":"vite build","fmt":"prettier -c --write \"**/*.{md,cjs,js,json,ts,yml,yaml}\"","lint":"pnpm run /^lint:.*/","lint:es":"eslint .","lint:fmt":"pnpm prettier --list-different \"**/*.{md,cjs,js,json,ts,yml,yaml}\"","prepare":"husky","test":"vitest --run"},"repository":{"type":"git","url":"git+ssh://git@github.com/aberoth-community/overheard.git"},"keywords":["aberoth","rpg"],"author":{"name":"ashnel3"},"license":"MIT","bugs":{"url":"https://github.com/aberoth-community/overheard/issues"},"homepage":"https://github.com/aberoth-community/overheard#readme","engines":{"node":">=18"},"engineStrict":true,"packageManager":"pnpm@9.8.0","dependencies":{"commander":"^12.0.0","typescript-event-target":"^1.1.1"},"devDependencies":{"@eslint/js":"^9.9.1","@types/node":"^22.5.4","eslint":"^9.9.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.2.1","globals":"^15.9.0","husky":"^9.1.5","prettier":"^3.3.3","rimraf":"^6.0.1","rollup-plugin-node-externals":"^7.1.3","typedoc":"^0.26.6","typescript":"^5.5.4","typescript-eslint":"^8.4.0","vite":"^5.4.3","vite-node":"^2.0.5","vite-plugin-dts":"^4.1.0","vitest":"^2.0.5"},"_id":"@aberoth-community/overheard@3.0.3","gitHead":"3fef9e906d3b58395cc99fc4292a28a0f4b9cf2a","types":"./dist/index.d.ts","_nodeVersion":"18.20.4","_npmVersion":"10.7.0","dist":{"integrity":"sha512-Agr8B/jYK5gHkLMKBP92LzUhnRshgt8sL4VOYX6bv4QtlzIiULOj9CM69/DFzi5VZ0J1Wp0QzPPd0Vi7FYmzWQ==","shasum":"c83eea3a26a98a46683dd7e40d85b173608bc72f","tarball":"https://registry.npmjs.org/@aberoth-community/overheard/-/overheard-3.0.3.tgz","fileCount":12,"unpackedSize":24663,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCRlMaQlsgWAA1MAGdozewdtAFmjsRpvVyziCbpy2mR9AIhAO9+WG3CMv9sUMr3ZhIQ5jaVkR8XRG6JKPSPnnQYQEgr"}]},"_npmUser":{"name":"ashnel3","email":"ashnel3333@gmail.com"},"directories":{},"maintainers":[{"name":"ashnel3","email":"ashnel3333@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/overheard_3.0.3_1725565140595_0.4034584440056139"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-20T12:01:17.958Z","modified":"2024-09-05T19:39:01.020Z","3.0.0":"2024-02-20T12:01:18.212Z","3.0.1":"2024-02-21T05:33:53.043Z","3.0.2":"2024-09-05T19:31:57.440Z","3.0.3":"2024-09-05T19:39:00.799Z"},"bugs":{"url":"https://github.com/aberoth-community/overheard/issues"},"author":{"name":"ashnel3"},"license":"MIT","homepage":"https://github.com/aberoth-community/overheard#readme","keywords":["aberoth","rpg"],"repository":{"type":"git","url":"git+ssh://git@github.com/aberoth-community/overheard.git"},"description":"A simple overheard scraper","maintainers":[{"name":"ashnel3","email":"ashnel3333@gmail.com"}],"readme":"# @aberoth-community/overheard\n\n> [![Discord](https://img.shields.io/discord/370780258141601792)](https://discord.gg/kWZJVUjZAe) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/aberoth-community/overheard/main.yml?label=tests)](https://github.com/aberoth-community/overheard/actions) [![NPM Version](https://img.shields.io/npm/v/%40aberoth-community%2Foverheard)](https://www.npmjs.com/package/@aberoth-community/overheard) [![GitHubStars](https://img.shields.io/github/stars/aberoth-community/overheard)](https://github.com/aberoth-community/overheard/stargazers)\n\nA simple & portable [\"Aberoth Overheard\"](https://aberoth.com/highscore/overheard.html) scraper library and cli.\n\n## Installation:\n\n### Npm:\n\n| client | ...                                     |\n| ------ | --------------------------------------- |\n| npm    | `npm i @aberoth-community/overheard`    |\n| pnpm   | `pnpm i @aberoth-community/overheard`   |\n| yarn   | `yarn add @aberoth-community/overheard` |\n\n### Executables:\n\n> (See: [Releases](https://github.com/aberoth-community/overheard/releases))\n\nFor convenience overheard can also be downloaded as a standalone executable.\n\n## Usage:\n\n### Command-Line:\n\n```bash\n$ ./overheard --help\nUsage: overheard [options]\n\nOptions:\n  -h, --header [values...]  add request headers.\n  -i, --interval <int>      set scan interval.\n  -v, --version             output the version number\n  --help                    display help for command\n```\n\n### Example:\n\n> (See: [Api-Docs](https://aberoth-community.github.io/overheard), [examples/webhook.js](examples/webhook.js))\n\n```typescript\nimport Overheard from '@aberoth-community/overheard'\n\n// main\nvoid (async () => {\n  const overheard = new Overheard(\n    // scraper options\n    { headers: {}, interval: 30e3 },\n    // scraper cache (optional)\n    {\n      online: 50,\n      moon: 'full',\n      realms: {\n        [Overheard.OVERHEARD_SCHOOLS.yellow]: 'dark',\n      },\n    },\n  )\n\n  // start the scraper loop\n  overheard.start()\n  // stop scraper\n  overheard.stop()\n\n  // === events ===\n  overheard.addEventListener('error', (event) => {\n    console.error(event.error)\n  })\n  overheard.addEventListener('exit', (event) => {\n    console.log('exit!')\n  })\n  overheard.addEventListener('moon', (event) => {\n    console.log(`moon: ${event.phase}`)\n  })\n  overheard.addEventListener('realm', (event) => {\n    console.log(`scroll: ${event.name} ${event.phase}`)\n  })\n\n  // === getters ===\n  console.log(overheard.getRealms()) // [{ name: 'white', school: 'divination', phase: 'dark' }, ...]\n  console.log(overheard.getMoon()) // nearly_full\n  console.log(overheard.getOnline()) // 100\n})()\n```\n","readmeFilename":"README.md"}