{"_id":"@djwoodz/satisfactory-dedicated-server-query-port-probe","_rev":"2-642adae5a0b8fb08fcd33401fbf9aa7e","name":"@djwoodz/satisfactory-dedicated-server-query-port-probe","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@djwoodz/satisfactory-dedicated-server-query-port-probe","version":"0.1.0","keywords":["Satisfactory","Dedicated Server","Query Port"],"author":{"name":"DJ WoodZ"},"license":"MIT","_id":"@djwoodz/satisfactory-dedicated-server-query-port-probe@0.1.0","maintainers":[{"name":"djwoodz","email":"npm@djwoodz.com"}],"homepage":"https://github.com/DJWoodZ/satisfactory-dedicated-server-query-port-probe#readme","bugs":{"url":"https://github.com/DJWoodZ/satisfactory-dedicated-server-query-port-probe/issues"},"dist":{"shasum":"4be9bf5d1389c06e3d320a7d32c1474c31f99e7e","tarball":"https://registry.npmjs.org/@djwoodz/satisfactory-dedicated-server-query-port-probe/-/satisfactory-dedicated-server-query-port-probe-0.1.0.tgz","fileCount":5,"integrity":"sha512-clfaz6XYfZsQGGAk2B2koWWSJ5cuxrRlXNEoGx9xd/fqiJTS2ikpTEPrASanKt6MBX+Lcwqb/FvRzlGXH+e3+Q==","signatures":[{"sig":"MEUCIHow2acO94ZXCbz/HQiizjV3XirCpRcLwvtI5dYTEShYAiEA6lAR1fXsQ145g+CdrtB/0W707vtC08EHuNIxi7JResw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5745,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkNww1ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrtEA/6AhmwEi7ZwirftiWSHeMNfIcUn5B7hW0lbaXnXKU901yZFpUI\r\n4Moe4TMfA3YPQyB2P6gf4Kjl04WAQl201ZDCUBWUyUT9yyB6dEFAFPBNu/Oa\r\np7U1uA6dxPNh7rtws8b33q0Z3pyt52ALkYK5Z9vX91m/C4AH8N/2s0KjroWv\r\ntz/cdL4T22XVt9ckS18pA29fZMJLf5jiOzQlfKEklAvbi49gpKq2kpUXruKO\r\ndQv5ayGMX9BjMRsX/Dbea33HkkzcK5lxVVfbpcYKBYpMn6ngYaj6NHeOMMNo\r\nVykbn3AE072GA4ZCt1CtHV/0ITfbwkcD31c5tAuSgMxXCOWBxBMbcXCFnJh9\r\n58RUu0WpNklKVw1hajCkSRzjwLKdDZu6fUxK7cPVKb8cInXlqCobO74YVkPn\r\njJc+yW88WQrAf3UFV9Nd57FI5sdB+jTb48c8it2Ob+IUvu91Rpqk8ICAxzd3\r\n2a0WeSNd21zAfBoFXmfWCaDi5UVaBEsqpZgZGkU+hFxkbwykFm32vblqtpoh\r\nFXe1oQgcYu4TADcTd/AWqbUOF9j97lBOJ2oNEGFaeUrVYW2hxPW/MAW4+1r2\r\nPzPxP4gPRL9MW1bg/6lL1JO3nkx4/FVSAEeLFzqczzk5juVs8QBCZ7vR8cCT\r\nOSOKyTV5H753zt2QaBCcC0QNOjuQAPNvMQk=\r\n=AGpF\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"5d35855acac8b0af5b9cecd98a9d72efc1b7629c","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"djwoodz","email":"npm@djwoodz.com"},"repository":{"url":"git+https://github.com/DJWoodZ/satisfactory-dedicated-server-query-port-probe.git","type":"git"},"_npmVersion":"9.3.1","description":"A zero dependency Node.js library for probing the query port of a Satisfactory Dedicated Server.","directories":{},"_nodeVersion":"18.14.0","_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.38.0","eslint-plugin-import":"^2.27.5","eslint-config-airbnb-base":"^15.0.0"},"_npmOperationalInternal":{"tmp":"tmp/satisfactory-dedicated-server-query-port-probe_0.1.0_1681329205221_0.9666329487078327","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.1.1":{"name":"@djwoodz/satisfactory-dedicated-server-query-port-probe","version":"0.1.1","keywords":["Satisfactory","Dedicated Server","Query Port"],"author":{"name":"DJ WoodZ"},"license":"MIT","_id":"@djwoodz/satisfactory-dedicated-server-query-port-probe@0.1.1","maintainers":[{"name":"djwoodz","email":"npm@djwoodz.com"}],"homepage":"https://github.com/DJWoodZ/satisfactory-dedicated-server-query-port-probe#readme","bugs":{"url":"https://github.com/DJWoodZ/satisfactory-dedicated-server-query-port-probe/issues"},"dist":{"shasum":"71c62922c31a26c8ad219d12ad9e845bb6f30b5f","tarball":"https://registry.npmjs.org/@djwoodz/satisfactory-dedicated-server-query-port-probe/-/satisfactory-dedicated-server-query-port-probe-0.1.1.tgz","fileCount":5,"integrity":"sha512-q6J21WEIr051boclxT3RQVZIdoDf50ykVqVj8oPGUYN8ZS9LT4WHeYEZEQ8kDIld+in7DbjZFv8SNgj26bJK/A==","signatures":[{"sig":"MEYCIQC4YK9OdZMpf/VuRYy8y5WUf5pq0X4uYDDqukSjqVUgJAIhAJy5p6dFekfvTbyLtpD6nFlT+sRCzOqtlKvr5aAEcDJx","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5724},"main":"index.js","gitHead":"75179279573cec54e38808f47d51465f07450717","scripts":{"test":"npx eslint \"**/*.js\""},"_npmUser":{"name":"djwoodz","email":"npm@djwoodz.com"},"repository":{"url":"git+https://github.com/DJWoodZ/satisfactory-dedicated-server-query-port-probe.git","type":"git"},"_npmVersion":"9.3.1","description":"A zero dependency Node.js library for probing the query port of a Satisfactory Dedicated Server.","directories":{},"_nodeVersion":"18.14.0","_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.52.0","eslint-plugin-import":"^2.29.0","eslint-config-airbnb-base":"^15.0.0"},"_npmOperationalInternal":{"tmp":"tmp/satisfactory-dedicated-server-query-port-probe_0.1.1_1698229448733_0.0164638772216521","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2023-04-12T19:53:25.167Z","modified":"2024-09-20T10:44:33.336Z","0.1.0":"2023-04-12T19:53:25.424Z","0.1.1":"2023-10-25T10:24:08.900Z"},"bugs":{"url":"https://github.com/DJWoodZ/satisfactory-dedicated-server-query-port-probe/issues"},"author":{"name":"DJ WoodZ"},"license":"MIT","homepage":"https://github.com/DJWoodZ/satisfactory-dedicated-server-query-port-probe#readme","keywords":["Satisfactory","Dedicated Server","Query Port"],"repository":{"url":"git+https://github.com/DJWoodZ/satisfactory-dedicated-server-query-port-probe.git","type":"git"},"description":"A zero dependency Node.js library for probing the query port of a Satisfactory Dedicated Server.","maintainers":[{"name":"djwoodz","email":"npm@djwoodz.com"}],"readme":"Satisfactory Dedicated Server Query Port Probe\n==============================================\n\nA zero dependency Node.js library for probing the query port of a [Satisfactory Dedicated Server](https://satisfactory.fandom.com/wiki/Dedicated_servers).\n\nInstallation\n------------\n\n```\nnpm i @djwoodz/satisfactory-dedicated-server-query-port-probe\n```\n\nExample Usage\n-------------\n\n```js\n// import module\nconst { probe } = require('@djwoodz/satisfactory-dedicated-server-query-port-probe');\n```\n\n```js\n// probe using await\nconst data = await probe('127.0.0.1', 15777, 10000);\nconsole.log(data);\n```\n\n```js\n// probe using .then()\nprobe('127.0.0.1', 15777, 10000)\n  .then((data) => {\n    console.log(data);\n  });\n```\n\nExample Response\n----------------\n\n```js\n{\n  id: 1, // the message id\n  protocolVersion: 0, // the protocol version\n  clientData: 1681304201371n, // the unique data sent to the server (timestamp)\n  serverState: 'Game ongoing', // the state of the server\n  serverVersion: 211839, // the version of the server\n  queryPort: 15777 // the query port of the server\n}\n```\n\nAPI\n---\n\n## probe([address], [port], [timeout]) ⇒ <code>Promise</code>\n\nRequests data from a Satisfactory Dedicated Server's Query Port\n\n**Returns**: <code>Promise</code> - Promise object that represents Query Port data\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [address] | <code>string</code> | <code>&#x27;127.0.0.1&#x27;</code> | The address of the Satisfactory Dedicated Server (hostname or IP) |\n| [port] | <code>number</code> \\| <code>string</code> | <code>15777</code> | The Query Port number of the Satisfactory Dedicated Server |\n| [timeout] | <code>number</code> \\| <code>string</code> | <code>10000</code> | The timeout for the request (milliseconds) |","readmeFilename":"README.md"}