{"_id":"@atmosx/placefile-parser","_rev":"2-9ac1dfaac9e3a264536f3e4c26288912","name":"@atmosx/placefile-parser","dist-tags":{"latest":"2.0.1"},"versions":{"2.0.1":{"name":"@atmosx/placefile-parser","version":"2.0.1","keywords":["Weather","Placefiles","TypeScript","Parser","JavaScript","CommonJS","ESM"],"author":{"name":"k3yomi, StarflightWx"},"license":"MIT","_id":"@atmosx/placefile-parser@2.0.1","maintainers":[{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"}],"homepage":"https://github.com/AtmosphericX/placefile-parser#readme","bugs":{"url":"https://github.com/AtmosphericX/placefile-parser/issues"},"dist":{"shasum":"cf43aab998af09b1bdafc225d59a267b75535728","tarball":"https://registry.npmjs.org/@atmosx/placefile-parser/-/placefile-parser-2.0.1.tgz","fileCount":14,"integrity":"sha512-siuipcOdCB+P2OFaVQlEY4KpQAlBGdzkzpnFtO2Ga+Wh9NEA5LrC4umwQKbCi2roZ7/nqiN+ChAwWgEvT7gjRg==","signatures":[{"sig":"MEUCIEwMfVO+IeWWQovIQKUg96StOD0Oaz8qSkR+tIkxnfb0AiEAlbUvpfVeEygS2aOQ+MMqmAsq/K4AmWrtU4KkWPRQ1as=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":36992},"main":"dist/cjs/index.cjs","module":"dist/esm/index.mjs","gitHead":"b9a65ddf808d77f88ae55038fc6c9424332ba690","scripts":{"build":"tsup && cd ./test && node ./index.js","start":"cd ./test && node ./index.js","publish":"tsup && npm publish --access public","publish-beta":"tsup && npm publish --tag beta --access public"},"_npmUser":{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"},"repository":{"url":"git+https://github.com/AtmosphericX/placefile-parser.git","type":"git","branch":"beta"},"_npmVersion":"10.7.0","description":"WX Placefile Parser and Creation - Built for standalone and Project AtmosphericX Integration.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"typescript":"5.9.3"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"8.5.1","@types/node":"25.2.0"},"_npmOperationalInternal":{"tmp":"tmp/placefile-parser_2.0.1_1774727331608_0.4369896010614267","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-03-28T19:48:51.551Z","modified":"2026-03-28T21:54:24.764Z","2.0.1":"2026-03-28T19:48:51.747Z"},"bugs":{"url":"https://github.com/AtmosphericX/placefile-parser/issues"},"author":{"name":"k3yomi, StarflightWx"},"license":"MIT","homepage":"https://github.com/AtmosphericX/placefile-parser#readme","keywords":["Weather","Placefiles","TypeScript","Parser","JavaScript","CommonJS","ESM"],"repository":{"url":"git+https://github.com/AtmosphericX/placefile-parser.git","type":"git","branch":"beta"},"description":"WX Placefile Parser and Creation - Built for standalone and Project AtmosphericX Integration.","maintainers":[{"name":"k3y0mi","email":"7dz9w57av@mozmail.com"}],"readme":"\r\n<h1 style='font-size: 65px'; align=\"center\">🗺️ AtmosphericX - Placefile Parser 🌎</h1>\r\n<div align=\"center\">\r\n  \t<p align = \"center\">A Placefile is a structured text file used to provide geospatial data for mapping applications, often for weather alerts, storm reports, or points of interest. A Placefile contains instructions for displaying locations on a map, including coordinates, labels, colors, icons, and refresh intervals. This module is primarily intended for use with the https://github.com/k3yomi/AtmosphericX project.</small></p>\r\n  \t<p align = \"center\">Documentation written by @k3yomi</p>\r\n\t<div align=\"center\" style=\"border: none;\">\r\n\t\t<img alt=\"GitHub Repo stars\" src=\"https://img.shields.io/github/stars/AtmosphericX/placefile-parser\">\r\n\t\t<img alt=\"GitHub forks\" src=\"https://img.shields.io/github/forks/AtmosphericX/placefile-parser\">\r\n\t\t<img alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/AtmosphericX/placefile-parser\">\r\n\t\t<img alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/AtmosphericX/placefile-parser\">\r\n\t</div>\r\n</div>\r\n\r\n## Installation (NPM)\r\n```bash\r\nnpm install @atmosx/placefile-parser\r\n```\r\n\r\n## Example Usage\r\n```javascript\r\nconst { PlacefileManager } = require('@atmosx/placefile-parser'); // CJS\r\nimport { PlacefileManager } from '@atmosx/placefile-parser'; // ESM\r\n\r\n\r\nconst sample = fs.readFileSync(\"test\", \"utf-8\"); // For testing...\r\n\r\n// Parsing a basic placefile\r\nPlacefileManager.parsePlacefile(sample).then((objects) => {\r\n    console.log(\"Parsed Objects:\", objects);\r\n})\r\n\r\n// Parsing a table\r\nPlacefileManager.parseTable(sample).then((table) => {\r\n    console.log(\"Parsed Table:\", table);\r\n})\r\n\r\n\r\n// Parsing GeoJSON\r\nPlacefileManager.parseGeoJSON(sample).then((geojson) => {\r\n    console.log(\"Parsed GeoJSON:\", geojson);\r\n})\r\n\r\n// Creating a placefile \r\nPlacefileManager.createPlacefile({\r\n    refresh: 60,\r\n    threshold: 50,\r\n    title: \"Sample Placefile\",\r\n    settings: \"ShowLabels, ShowIcons\",\r\n    type: \"Point\",\r\n    objects: [\r\n        {\r\n            coordinates: [34.0522, -118.2437],\r\n            label: \"Los Angeles\",\r\n            color: \"255 0 0\",\r\n        },\r\n        {\r\n            coordinates: [40.7128, -74.0060],\r\n            label: \"New York\",\r\n            color: \"0 0 255\",\r\n        }\r\n    ]\r\n}).then((placefile) => {\r\n    console.log(\"Generated Placefile:\\n\", placefile);\r\n});\r\n```\r\n\r\n## References\r\n[Documentation](https://atmosphericx.scriptkitty.cafe/documentation) |\r\n[Discord Server](https://atmosphericx-discord.scriptkitty.cafe) |\r\n[Project Board](https://github.com/users/AtmosphericX/projects/2) |\\\r\n[Code of Conduct](/CODE_OF_CONDUCT.md) |\r\n[Contributing](/CONTRIBUTING.md) |\r\n[License](/LICENSE) | \r\n[Security](/SECURITY.md) | \r\n[Changelogs](/CHANGELOGS.md) |\r\n\r\n## Acknowledgements\r\n- [k3yomi](https://github.com/k3yomi)\r\n    - Lead developer @ AtmosphericX and maintainer of this module.\r\n- [StarflightWx](https://x.com/starflightVR)\r\n    - For testing and providing feedback (Co-Developer and Spotter @ AtmosphericX)","readmeFilename":"README.md"}