{"_id":"@adonisjs/websocket-packet","_rev":"11-b63db29f9184c312457a20300bcaa9b9","name":"@adonisjs/websocket-packet","dist-tags":{"latest":"1.0.6","legacy":"1.0.6"},"versions":{"1.0.0":{"name":"@adonisjs/websocket-packet","version":"1.0.0","description":"Verify,create adonis websocket packets","main":"index.js","browser":"browser.js","module":"browser.js","files":["index.js","browser.js"],"scripts":{"build":"babel --out-file=browser.js index.js --presets=env","lint":"standard","prepublishOnly":"npm run build","pretest":"npm run lint","test":"japa","posttest":"nyc report --reporter=text-lcov | coveralls"},"keywords":["websocket","ws","socketio"],"author":{"name":"virk"},"license":"MIT","devDependencies":{"babel-cli":"^6.26.0","babel-core":"^6.26.0","babel-preset-env":"^1.6.1","coveralls":"^3.0.0","japa":"^1.0.6","japa-cli":"^1.0.1","nyc":"^11.4.1","standard":"^11.0.0"},"standard":{"ignore":["browser.js"]},"gitHead":"dd2d400d86bf7889d50948662a166108cbcf1b96","_id":"@adonisjs/websocket-packet@1.0.0","_npmVersion":"5.6.0","_nodeVersion":"9.3.0","_npmUser":{"name":"virk","email":"virk@adonisjs.com"},"dist":{"integrity":"sha512-Tzlj7wKxujeTPtQ2avdCNoOtb7i1+JxelIcNNOTEewD4xOk3mlfm/mtG/3JF+m+BL08ftysjx4VDdSpWaLgSng==","shasum":"8778b9157047dcce1b74499265a65daffddd36c3","tarball":"https://registry.npmjs.org/@adonisjs/websocket-packet/-/websocket-packet-1.0.0.tgz","fileCount":5,"unpackedSize":24401,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDeZPvKS9RSjV9fcY5ZUj2TvOJVN/ZfHJZQShSncXUUrwIgNWtIIwfiVf2AhQlUEW9HfDHq1O5LP9gLTkfuMWxH0yk="}]},"maintainers":[{"name":"virk","email":"virk@adonisjs.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/websocket-packet_1.0.0_1519135959042_0.4055042970286058"},"_hasShrinkwrap":false},"1.0.1":{"name":"@adonisjs/websocket-packet","version":"1.0.1","description":"Verify,create adonis websocket packets","main":"index.js","browser":"browser.js","module":"browser.js","files":["index.js","browser.js"],"scripts":{"build":"babel --out-file=browser.js index.js --presets=env","lint":"standard","prepublishOnly":"npm run build","pretest":"npm run lint","test":"nyc japa","posttest":"nyc report --reporter=text-lcov | coveralls"},"keywords":["websocket","ws","socketio"],"author":{"name":"virk"},"license":"MIT","devDependencies":{"babel-cli":"^6.26.0","babel-core":"^6.26.0","babel-preset-env":"^1.6.1","coveralls":"^3.0.0","japa":"^1.0.6","japa-cli":"^1.0.1","nyc":"^11.4.1","standard":"^11.0.0"},"standard":{"ignore":["browser.js"]},"nyc":{"exclude":["browser.js"]},"gitHead":"3be1f0e744a3772dd127d2e8407ae21ef6327ae3","_id":"@adonisjs/websocket-packet@1.0.1","_npmVersion":"5.6.0","_nodeVersion":"9.3.0","_npmUser":{"name":"virk","email":"virk@adonisjs.com"},"dist":{"integrity":"sha512-rNNw7NTVuriAr/CHnVnFYFRjd2G3iNrfjYROloJzRG3i4SpZtgm9AJtyPQYyKcY/Q1xng72fRNsLiXDJZja5kA==","shasum":"f3b6ff6881229e68a07a2aead6aa545439a67ed9","tarball":"https://registry.npmjs.org/@adonisjs/websocket-packet/-/websocket-packet-1.0.1.tgz","fileCount":5,"unpackedSize":25030,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFGSwIVDSmf/4eE/nXvDrA5lefdqKwLvxGmVJgV9PVwXAiEAz61BVmPj99CuD0xz3gxwqXPyakDZsd9Tg9aQnE43tag="}]},"maintainers":[{"name":"virk","email":"virk@adonisjs.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/websocket-packet_1.0.1_1519137561044_0.17950440577516047"},"_hasShrinkwrap":false},"1.0.2":{"name":"@adonisjs/websocket-packet","version":"1.0.2","description":"Verify,create adonis websocket packets","main":"index.js","browser":"browser.js","module":"browser.js","files":["index.js","browser.js"],"scripts":{"build":"webpack --mode=development","lint":"standard","prepublishOnly":"npm run build","pretest":"npm run lint","test":"nyc japa","posttest":"nyc report --reporter=text-lcov | coveralls"},"keywords":["websocket","ws","socketio"],"author":{"name":"virk"},"license":"MIT","devDependencies":{"babel-core":"^6.26.0","babel-preset-env":"^1.6.1","coveralls":"^3.0.0","japa":"^1.0.6","japa-cli":"^1.0.1","nyc":"^11.4.1","standard":"^11.0.0"},"standard":{"ignore":["browser.js"]},"nyc":{"exclude":["browser.js"]},"dependencies":{"webpack":"^4.0.0","webpack-cli":"^2.0.8"},"gitHead":"cc23fa572ff63dc149223912b86f54a69f8539cd","_id":"@adonisjs/websocket-packet@1.0.2","_npmVersion":"5.6.0","_nodeVersion":"9.3.0","_npmUser":{"name":"virk","email":"virk@adonisjs.com"},"dist":{"integrity":"sha512-g989RUEhcbG5dqWZCBAqjW9/xehI4siL6TwWpAPA1dr/Ux4LGVe8qyMGOdeWqWbhxoV0aBB2NwE5KzZNZ8kkJA==","shasum":"2cd5703e19e5df91077fa25df65ac0fa77ca9555","tarball":"https://registry.npmjs.org/@adonisjs/websocket-packet/-/websocket-packet-1.0.2.tgz","fileCount":5,"unpackedSize":29319,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIB3Jf8I0h5W+jFes2Besg3U2RX2JZwbfN58nHMh/aDZIAiAEpRU5ZCqnqwVTRFGLCCBHYAEIAVajCeKHe9A2vux6pQ=="}]},"maintainers":[{"name":"virk","email":"virk@adonisjs.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/websocket-packet_1.0.2_1519557751741_0.8117176354325399"},"_hasShrinkwrap":false},"1.0.3":{"name":"@adonisjs/websocket-packet","version":"1.0.3","description":"Verify,create adonis websocket packets","main":"index.js","browser":"browser.js","module":"browser.js","files":["index.js","browser.js"],"scripts":{"build":"webpack --mode=development","lint":"standard","prepublishOnly":"npm run build","pretest":"npm run lint","test":"nyc japa","posttest":"nyc report --reporter=text-lcov | coveralls"},"keywords":["websocket","ws","socketio"],"author":{"name":"virk"},"license":"MIT","devDependencies":{"babel-core":"^6.26.0","babel-preset-env":"^1.6.1","coveralls":"^3.0.0","japa":"^1.0.6","japa-cli":"^1.0.1","nyc":"^11.4.1","standard":"^11.0.0"},"standard":{"ignore":["browser.js"]},"nyc":{"exclude":["browser.js"]},"dependencies":{"webpack":"^4.0.0","webpack-cli":"^2.0.8"},"gitHead":"c57eb648188177728a5c4ca1c0dacb7a2568b375","_id":"@adonisjs/websocket-packet@1.0.3","_npmVersion":"5.6.0","_nodeVersion":"9.3.0","_npmUser":{"name":"virk","email":"virk@adonisjs.com"},"dist":{"integrity":"sha512-H9XOvdvr90htIgxL3McuBNnxlJRgB5HBtAKtjNnO0Ppf4v8eFY8P1FcCw8VenWQ1sGRVykCkvzg40ydez2dW+A==","shasum":"81f7daf166893a8780b23f340cdfeb16a6eaa003","tarball":"https://registry.npmjs.org/@adonisjs/websocket-packet/-/websocket-packet-1.0.3.tgz","fileCount":5,"unpackedSize":29579,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAO0vuCc4KZqjH/erF6ruDjP2hmaginhfVX13iztatzSAiEAgkwKHalGLgcAJ1kNAnhOYtMVcRpXxnjcd3vF5ES6kjI="}]},"maintainers":[{"name":"virk","email":"virk@adonisjs.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/websocket-packet_1.0.3_1519732777958_0.6691347459439527"},"_hasShrinkwrap":false},"1.0.4":{"name":"@adonisjs/websocket-packet","version":"1.0.4","description":"Verify,create adonis websocket packets","main":"index.js","browser":"browser.js","module":"browser.js","files":["index.js","browser.js"],"scripts":{"build":"webpack --mode=production","lint":"standard","prepublishOnly":"npm run build","pretest":"npm run lint","test":"nyc japa","posttest":"nyc report --reporter=text-lcov | coveralls"},"keywords":["websocket","ws","socketio"],"author":{"name":"virk"},"license":"MIT","devDependencies":{"babel-loader":"^7.1.3","babel-preset-env":"^1.6.1","coveralls":"^3.0.0","japa":"^1.0.6","japa-cli":"^1.0.1","nyc":"^11.4.1","standard":"^11.0.0","webpack":"^4.1.0","webpack-cli":"^2.0.10"},"standard":{"ignore":["browser.js"]},"nyc":{"exclude":["browser.js"]},"dependencies":{},"gitHead":"bd6b98cddd112bbdc36225b7b789f461611aec60","_id":"@adonisjs/websocket-packet@1.0.4","_npmVersion":"5.6.0","_nodeVersion":"9.3.0","_npmUser":{"name":"virk","email":"virk@adonisjs.com"},"dist":{"integrity":"sha512-TWjU1OE0MfC1/i2NSs+NrwLxi17A1fpF4Jh8r9nAm0eWNhSZY7wXUUcRRzMLrBjwXvc2MUOH+mpuJp2E0r02rA==","shasum":"2394509ef813ad37272a0c1610f8a00677f627a8","tarball":"https://registry.npmjs.org/@adonisjs/websocket-packet/-/websocket-packet-1.0.4.tgz","fileCount":5,"unpackedSize":21562,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAgeZ/NrBwfU1cKETb3BdcTUHp/lDT0Hes/GpdQTesSbAiEA05Ukx5A4R9/xHWEdotzxT6CQJqwO1ItkEx1QjROezoY="}]},"maintainers":[{"name":"virk","email":"virk@adonisjs.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/websocket-packet_1.0.4_1520318067854_0.6391305653173092"},"_hasShrinkwrap":false},"1.0.5":{"name":"@adonisjs/websocket-packet","version":"1.0.5","description":"Verify,create adonis websocket packets","main":"dist/wsp.node.js","browser":"dist/wsp.browser.js","module":"dist/wsp.es.js","files":["dist"],"scripts":{"build":"rollup -c","lint":"standard","prepublishOnly":"npm run build","pretest":"npm run lint && npm run build","test:node":"japa","test:karma":"karma start","test":"npm run test:node && npm run test:karma"},"keywords":["websocket","ws","socketio"],"author":{"name":"virk"},"license":"MIT","devDependencies":{"babel-core":"^6.26.0","babel-plugin-external-helpers":"^6.22.0","babel-preset-env":"^1.6.1","japa":"^1.0.6","japa-cli":"^1.0.1","karma":"^2.0.0","karma-chrome-launcher":"^2.2.0","karma-japa":"^1.0.2","karma-rollup-preprocessor":"^5.1.1","puppeteer":"^1.1.1","rollup":"^0.56.5","rollup-plugin-babel":"^3.0.3","rollup-plugin-uglify":"^3.0.0","standard":"^11.0.0"},"standard":{"ignore":["dist/*.js"],"globals":["group","test"]},"dependencies":{},"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/adonisjs/adonis-websocket-packet.git"},"bugs":{"url":"https://github.com/adonisjs/adonis-websocket-packet/issues"},"homepage":"https://github.com/adonisjs/adonis-websocket-packet#readme","gitHead":"d78b3fac21889ec197deb41aaf80ac001c010e4f","_id":"@adonisjs/websocket-packet@1.0.5","_npmVersion":"5.6.0","_nodeVersion":"9.3.0","_npmUser":{"name":"virk","email":"virk@adonisjs.com"},"dist":{"integrity":"sha512-7we3GqdwzuCuEzZHGWPPVIoz31xFLtfEBN/Y68n8kGt9UxTHo4G+Iz7Dk0EQFm3Yr+jXu3G66cnuqILnSsd06Q==","shasum":"2efbf5957de0db4eb012eafaedafe69b04070217","tarball":"https://registry.npmjs.org/@adonisjs/websocket-packet/-/websocket-packet-1.0.5.tgz","fileCount":6,"unpackedSize":29890,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDoybb4oJq09DN00yRsqwp83fgAnYoMvO1zRpb0RAmp8AiEA87hDxM8nCWnqEsCnGO25zFZzX9QWkfyepzGhLvnP3js="}]},"maintainers":[{"name":"virk","email":"virk@adonisjs.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/websocket-packet_1.0.5_1520772373077_0.7635278214675074"},"_hasShrinkwrap":false},"1.0.6":{"name":"@adonisjs/websocket-packet","version":"1.0.6","description":"Verify,create adonis websocket packets","main":"dist/wsp.node.js","browser":"dist/wsp.browser.js","module":"dist/wsp.es.js","files":["dist"],"scripts":{"build":"rollup -c","lint":"standard","prepublishOnly":"npm run build","pretest":"npm run lint && npm run build","test:node":"japa","test:karma":"karma start","test":"npm run test:node && npm run test:karma"},"keywords":["websocket","ws","socketio"],"author":{"name":"virk"},"license":"MIT","devDependencies":{"babel-core":"^6.26.0","babel-plugin-external-helpers":"^6.22.0","babel-preset-env":"^1.6.1","japa":"^1.0.6","japa-cli":"^1.0.1","karma":"^2.0.0","karma-chrome-launcher":"^2.2.0","karma-japa":"^1.0.2","karma-rollup-preprocessor":"^5.1.1","puppeteer":"^1.1.1","rollup":"^0.56.5","rollup-plugin-babel":"^3.0.3","rollup-plugin-uglify":"^3.0.0","standard":"^11.0.0"},"standard":{"ignore":["dist/*.js"],"globals":["group","test"]},"dependencies":{},"directories":{"test":"test"},"repository":{"type":"git","url":"git+https://github.com/adonisjs/adonis-websocket-packet.git"},"bugs":{"url":"https://github.com/adonisjs/adonis-websocket-packet/issues"},"homepage":"https://github.com/adonisjs/adonis-websocket-packet#readme","gitHead":"e234b9ad0d6ea1127df868caa3f8f50004dd8093","_id":"@adonisjs/websocket-packet@1.0.6","_npmVersion":"5.6.0","_nodeVersion":"9.3.0","_npmUser":{"name":"virk","email":"virk@adonisjs.com"},"dist":{"integrity":"sha512-4MlcnwfJ5fy9EGBA0gNDAUThfrK4JeisQzHkRg0Z/Y3WGeciSuzgRB8hdwi2YEFeNOsEFcKme4ubEZXTAF020g==","shasum":"7b310c777fd66793149ff2de94c6b2be46302bdc","tarball":"https://registry.npmjs.org/@adonisjs/websocket-packet/-/websocket-packet-1.0.6.tgz","fileCount":6,"unpackedSize":29930,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAePgW1IndPYacD712LFmBGzuPp2OGK5hO9KnFBR90/6AiAx2o2e/177odXW39u2DUTV9SIbf98VlRXBFqe8hFBjsQ=="}]},"maintainers":[{"name":"virk","email":"virk@adonisjs.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/websocket-packet_1.0.6_1521014064211_0.4459152317618069"},"_hasShrinkwrap":false}},"time":{"created":"2018-02-20T14:12:38.957Z","1.0.0":"2018-02-20T14:12:39.139Z","modified":"2023-05-08T04:48:47.401Z","1.0.1":"2018-02-20T14:39:22.230Z","1.0.2":"2018-02-25T11:22:31.819Z","1.0.3":"2018-02-27T11:59:38.035Z","1.0.4":"2018-03-06T06:34:27.996Z","1.0.5":"2018-03-11T12:46:13.153Z","1.0.6":"2018-03-14T07:54:24.260Z"},"maintainers":[{"email":"julien@ripouteau.com","name":"julien-r44"},{"email":"romain.lanz+npm@pm.me","name":"romainlanz"},{"email":"virk@adonisjs.com","name":"virk"}],"description":"Verify,create adonis websocket packets","keywords":["websocket","ws","socketio"],"author":{"name":"virk"},"license":"MIT","readme":"# Websocket packets\nThis library is used to create/validate the websocket packets used by AdonisJs. \n\nIf you are writing a Javascript client, this is the library you must use. When writing client libraries for other platforms, simply follow the docs and the code to create your implementations.\n\n[![Travis](https://img.shields.io/travis/adonisjs/adonis-websocket-packet.svg?style=for-the-badge)](https://github.com/adonisjs/adonis-websocket-packet)\n\n## Installation\n\n## Node/Webpack\n```bash\nnpm i --save @adonisjs/websocket-packet\n```\n\n```js\nconst wsp = require('@adonisjs/websocket-packet')\n\n// or\nimport wsp from '@adonisjs/websocket-packet'\n\nconsole.log(wsp.codes)\nwsp.isJoinPacket(packet)\n```\n\n## CDN\n```html\n<script src=\"https://unpkg.com/@adonisjs/websocket-packet\"></script>\n<script type=\"text/javascript\">\n  console.log(adonis.wsp.codes)\n  console.log(adonis.wsp.isJoinPacket(packet))\n</script>\n```\n\n## Constants\n\n<dl>\n<dt><a href=\"#codes\">codes</a> : <code>Object</code></dt>\n<dd><p>Packet codes. The actual packet will have the numbers</p>\n</dd>\n<dt><a href=\"#fns\">fns</a></dt>\n<dd><p>Fns to be exported</p>\n</dd>\n</dl>\n\n## Functions\n\n<dl>\n<dt><a href=\"#isJoinPacket\">isJoinPacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>JOIN</code> code.</p>\n</dd>\n<dt><a href=\"#isLeavePacket\">isLeavePacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>LEAVE</code> code.</p>\n</dd>\n<dt><a href=\"#isOpenPacket\">isOpenPacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>OPEN</code> code.</p>\n</dd>\n<dt><a href=\"#isJoinAckPacket\">isJoinAckPacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>JOIN_ACK</code> code.</p>\n</dd>\n<dt><a href=\"#isJoinErrorPacket\">isJoinErrorPacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>JOIN_ERROR</code> code.</p>\n</dd>\n<dt><a href=\"#isLeaveAckPacket\">isLeaveAckPacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>LEAVE_ACK</code> code.</p>\n</dd>\n<dt><a href=\"#isLeaveErrorPacket\">isLeaveErrorPacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>LEAVE_ERROR</code> code.</p>\n</dd>\n<dt><a href=\"#isEventPacket\">isEventPacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>EVENT</code> code.</p>\n</dd>\n<dt><a href=\"#isPingPacket\">isPingPacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>PING</code> code.</p>\n</dd>\n<dt><a href=\"#isPongPacket\">isPongPacket(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Validates if packet code is a <code>PONG</code> code.</p>\n</dd>\n<dt><a href=\"#hasTopic\">hasTopic(packet)</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Finding if a packet has a topic.</p>\n</dd>\n<dt><a href=\"#isValidJoinPacket\">isValidJoinPacket()</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Makes sure packet is a valid join packet. Do call <code>isJoinPacket</code>\nbefore calling this method.</p>\n</dd>\n<dt><a href=\"#isValidLeavePacket\">isValidLeavePacket()</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Makes sure packet is a valid leave packet. Do call <code>isLeavePacket</code>\nbefore calling this method.</p>\n</dd>\n<dt><a href=\"#isValidEventPacket\">isValidEventPacket()</a> ⇒ <code>Boolean</code></dt>\n<dd><p>Makes sure packet is a valid event packet. Do call <code>isEventPacket</code>\nbefore calling this method.</p>\n</dd>\n<dt><a href=\"#joinPacket\">joinPacket(topic)</a> ⇒ <code>Object</code></dt>\n<dd><p>Makes a join packet</p>\n</dd>\n<dt><a href=\"#leavePacket\">leavePacket(topic)</a> ⇒ <code>Object</code></dt>\n<dd><p>Makes a leave packet</p>\n</dd>\n<dt><a href=\"#joinAckPacket\">joinAckPacket(topic)</a> ⇒ <code>Object</code></dt>\n<dd><p>Makes join acknowledge packet</p>\n</dd>\n<dt><a href=\"#joinErrorPacket\">joinErrorPacket(topic, message)</a> ⇒ <code>Object</code></dt>\n<dd><p>Makes join error packet</p>\n</dd>\n<dt><a href=\"#leaveAckPacket\">leaveAckPacket(topic)</a> ⇒ <code>Object</code></dt>\n<dd><p>Makes leave packet</p>\n</dd>\n<dt><a href=\"#leaveErrorPacket\">leaveErrorPacket(topic, message)</a> ⇒ <code>Object</code></dt>\n<dd><p>Makes leave error packet</p>\n</dd>\n<dt><a href=\"#eventPacket\">eventPacket(topic, event, data)</a> ⇒ <code>Object</code></dt>\n<dd><p>Makes the event packet</p>\n</dd>\n<dt><a href=\"#pingPacket\">pingPacket()</a> ⇒ <code>Object</code></dt>\n<dd><p>Makes ping packet</p>\n</dd>\n<dt><a href=\"#pongPacket\">pongPacket()</a> ⇒ <code>Object</code></dt>\n<dd><p>Makes pong packet</p>\n</dd>\n</dl>\n\n<a name=\"codes\"></a>\n\n## codes : <code>Object</code>\nPacket codes. The actual packet will have the numbers\n\n**Kind**: global constant  \n**Example**  \n```\n{\n OPEN: 0,\n JOIN: 1,\n LEAVE: 2,\n JOIN_ACK: 3,\n JOIN_ERROR: 4,\n LEAVE_ACK: 5,\n LEAVE_ERROR: 6,\n EVENT: 7,\n PING: 8,\n PONG: 9\n}\n```\n<a name=\"fns\"></a>\n\n## fns\nFns to be exported\n\n**Kind**: global constant  \n<a name=\"isJoinPacket\"></a>\n\n## isJoinPacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `JOIN` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isLeavePacket\"></a>\n\n## isLeavePacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `LEAVE` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isOpenPacket\"></a>\n\n## isOpenPacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `OPEN` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isJoinAckPacket\"></a>\n\n## isJoinAckPacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `JOIN_ACK` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isJoinErrorPacket\"></a>\n\n## isJoinErrorPacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `JOIN_ERROR` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isLeaveAckPacket\"></a>\n\n## isLeaveAckPacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `LEAVE_ACK` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isLeaveErrorPacket\"></a>\n\n## isLeaveErrorPacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `LEAVE_ERROR` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isEventPacket\"></a>\n\n## isEventPacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `EVENT` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isPingPacket\"></a>\n\n## isPingPacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `PING` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isPongPacket\"></a>\n\n## isPongPacket(packet) ⇒ <code>Boolean</code>\nValidates if packet code is a `PONG` code.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"hasTopic\"></a>\n\n## hasTopic(packet) ⇒ <code>Boolean</code>\nFinding if a packet has a topic.\n\n**Kind**: global function  \n\n| Param | Type |\n| --- | --- |\n| packet | <code>Object</code> | \n\n<a name=\"isValidJoinPacket\"></a>\n\n## isValidJoinPacket() ⇒ <code>Boolean</code>\nMakes sure packet is a valid join packet. Do call `isJoinPacket`\nbefore calling this method.\n\n**Kind**: global function  \n<a name=\"isValidLeavePacket\"></a>\n\n## isValidLeavePacket() ⇒ <code>Boolean</code>\nMakes sure packet is a valid leave packet. Do call `isLeavePacket`\nbefore calling this method.\n\n**Kind**: global function  \n<a name=\"isValidEventPacket\"></a>\n\n## isValidEventPacket() ⇒ <code>Boolean</code>\nMakes sure packet is a valid event packet. Do call `isEventPacket`\nbefore calling this method.\n\n**Kind**: global function  \n<a name=\"joinPacket\"></a>\n\n## joinPacket(topic) ⇒ <code>Object</code>\nMakes a join packet\n\n**Kind**: global function  \n**Throws**:\n\n- <code>Error</code> If topic is not defined or not a string\n\n\n| Param | Type |\n| --- | --- |\n| topic | <code>String</code> | \n\n<a name=\"leavePacket\"></a>\n\n## leavePacket(topic) ⇒ <code>Object</code>\nMakes a leave packet\n\n**Kind**: global function  \n**Throws**:\n\n- <code>Error</code> If topic is not defined or not a string\n\n\n| Param | Type |\n| --- | --- |\n| topic | <code>String</code> | \n\n<a name=\"joinAckPacket\"></a>\n\n## joinAckPacket(topic) ⇒ <code>Object</code>\nMakes join acknowledge packet\n\n**Kind**: global function  \n**Throws**:\n\n- <code>Error</code> If topic is not defined or is not a string\n\n\n| Param | Type |\n| --- | --- |\n| topic | <code>String</code> | \n\n<a name=\"joinErrorPacket\"></a>\n\n## joinErrorPacket(topic, message) ⇒ <code>Object</code>\nMakes join error packet\n\n**Kind**: global function  \n**Throws**:\n\n- <code>Error</code> If topic is not defined or not a string\n- <code>Error</code> If message is not defined or not a string\n\n\n| Param | Type |\n| --- | --- |\n| topic | <code>String</code> | \n| message | <code>String</code> | \n\n<a name=\"leaveAckPacket\"></a>\n\n## leaveAckPacket(topic) ⇒ <code>Object</code>\nMakes leave packet\n\n**Kind**: global function  \n**Throws**:\n\n- <code>Error</code> If topic is not defined or not a string\n\n\n| Param | Type |\n| --- | --- |\n| topic | <code>String</code> | \n\n<a name=\"leaveErrorPacket\"></a>\n\n## leaveErrorPacket(topic, message) ⇒ <code>Object</code>\nMakes leave error packet\n\n**Kind**: global function  \n**Throws**:\n\n- <code>Error</code> If topic is not defined or not a string\n- <code>Error</code> If message is not defined or not a string\n\n\n| Param | Type |\n| --- | --- |\n| topic | <code>String</code> | \n| message | <code>String</code> | \n\n<a name=\"eventPacket\"></a>\n\n## eventPacket(topic, event, data) ⇒ <code>Object</code>\nMakes the event packet\n\n**Kind**: global function  \n**Throws**:\n\n- <code>Error</code> If topic is not defined or not a string\n- <code>Error</code> If event is not defined\n- <code>Error</code> If data is not defined\n\n\n| Param | Type |\n| --- | --- |\n| topic | <code>String</code> | \n| event | <code>String</code> | \n| data | <code>Mixed</code> | \n\n<a name=\"pingPacket\"></a>\n\n## pingPacket() ⇒ <code>Object</code>\nMakes ping packet\n\n**Kind**: global function  \n<a name=\"pongPacket\"></a>\n\n## pongPacket() ⇒ <code>Object</code>\nMakes pong packet\n\n**Kind**: global function  \n","readmeFilename":"README.md","homepage":"https://github.com/adonisjs/adonis-websocket-packet#readme","repository":{"type":"git","url":"git+https://github.com/adonisjs/adonis-websocket-packet.git"},"bugs":{"url":"https://github.com/adonisjs/adonis-websocket-packet/issues"}}