From 1ed8c2e147d7f4715c32d93beb573c3a934241b8 Mon Sep 17 00:00:00 2001 From: "deepsource-autofix[bot]" <62050782+deepsource-autofix[bot]@users.noreply.github.com> Date: Tue, 2 Aug 2022 17:50:32 +0000 Subject: [PATCH] Format code with prettier This commit fixes the style issues introduced in a986954 according to the output from prettier. Details: https://deepsource.io/gh/MinecraftJS/rcon/transform/efb7afd2-828f-45fc-883a-d2594971a53f/ --- docs/assets/search.js | 4 +- docs/classes/RCONClient.html | 4222 +++++++++++++++++++++++---- docs/classes/RCONPacket.html | 1265 ++++++-- docs/classes/RCONPacketBuilder.html | 760 ++++- docs/classes/RCONPacketHandler.html | 659 ++++- docs/enums/RCONPacketType.html | 783 ++++- docs/interfaces/HandledPacket.html | 585 +++- 7 files changed, 7152 insertions(+), 1126 deletions(-) diff --git a/docs/assets/search.js b/docs/assets/search.js index 7692e7b..7e12d70 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1,3 @@ -window.searchData = JSON.parse("{\"kinds\":{\"8\":\"Enumeration\",\"16\":\"Enumeration Member\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\"},\"rows\":[{\"kind\":128,\"name\":\"RCONClient\",\"url\":\"classes/RCONClient.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RCONClient.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":1024,\"name\":\"host\",\"url\":\"classes/RCONClient.html#host\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":1024,\"name\":\"port\",\"url\":\"classes/RCONClient.html#port\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":1024,\"name\":\"authenticated\",\"url\":\"classes/RCONClient.html#authenticated\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":1024,\"name\":\"connected\",\"url\":\"classes/RCONClient.html#connected\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":1024,\"name\":\"password\",\"url\":\"classes/RCONClient.html#password\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":1024,\"name\":\"authRequestId\",\"url\":\"classes/RCONClient.html#authRequestId\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":1024,\"name\":\"handler\",\"url\":\"classes/RCONClient.html#handler\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":1024,\"name\":\"socket\",\"url\":\"classes/RCONClient.html#socket\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":2048,\"name\":\"connect\",\"url\":\"classes/RCONClient.html#connect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":2048,\"name\":\"executeCommand\",\"url\":\"classes/RCONClient.html#executeCommand\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":2048,\"name\":\"executeCommandAsync\",\"url\":\"classes/RCONClient.html#executeCommandAsync\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":2048,\"name\":\"disconnect\",\"url\":\"classes/RCONClient.html#disconnect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":2048,\"name\":\"handleMessage\",\"url\":\"classes/RCONClient.html#handleMessage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":2048,\"name\":\"write\",\"url\":\"classes/RCONClient.html#write\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":2048,\"name\":\"throw\",\"url\":\"classes/RCONClient.html#throw\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONClient\"},{\"kind\":128,\"name\":\"RCONPacket\",\"url\":\"classes/RCONPacket.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":1024,\"name\":\"MAX_CLIENT_PAYLOAD_LENGTH\",\"url\":\"classes/RCONPacket.html#MAX_CLIENT_PAYLOAD_LENGTH\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONPacket\"},{\"kind\":1024,\"name\":\"MAX_SERVER_PAYLOAD_LENGTH\",\"url\":\"classes/RCONPacket.html#MAX_SERVER_PAYLOAD_LENGTH\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONPacket\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RCONPacket.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"RCONPacket\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/RCONPacket.html#type\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONPacket\"},{\"kind\":1024,\"name\":\"payload\",\"url\":\"classes/RCONPacket.html#payload\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONPacket\"},{\"kind\":1024,\"name\":\"buf\",\"url\":\"classes/RCONPacket.html#buf\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONPacket\"},{\"kind\":2048,\"name\":\"write\",\"url\":\"classes/RCONPacket.html#write\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONPacket\"},{\"kind\":2048,\"name\":\"read\",\"url\":\"classes/RCONPacket.html#read\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONPacket\"},{\"kind\":128,\"name\":\"RCONPacketBuilder\",\"url\":\"classes/RCONPacketBuilder.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RCONPacketBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"RCONPacketBuilder\"},{\"kind\":1024,\"name\":\"buffer\",\"url\":\"classes/RCONPacketBuilder.html#buffer\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONPacketBuilder\"},{\"kind\":1024,\"name\":\"requestId\",\"url\":\"classes/RCONPacketBuilder.html#requestId\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RCONPacketBuilder\"},{\"kind\":256,\"name\":\"HandledPacket\",\"url\":\"interfaces/HandledPacket.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"requestId\",\"url\":\"interfaces/HandledPacket.html#requestId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"HandledPacket\"},{\"kind\":1024,\"name\":\"packet\",\"url\":\"interfaces/HandledPacket.html#packet\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"HandledPacket\"},{\"kind\":128,\"name\":\"RCONPacketHandler\",\"url\":\"classes/RCONPacketHandler.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RCONPacketHandler.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"RCONPacketHandler\"},{\"kind\":2048,\"name\":\"handle\",\"url\":\"classes/RCONPacketHandler.html#handle\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RCONPacketHandler\"},{\"kind\":8,\"name\":\"RCONPacketType\",\"url\":\"enums/RCONPacketType.html\",\"classes\":\"tsd-kind-enum\"},{\"kind\":16,\"name\":\"ERROR\",\"url\":\"enums/RCONPacketType.html#ERROR\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"RCONPacketType\"},{\"kind\":16,\"name\":\"RESPONSE\",\"url\":\"enums/RCONPacketType.html#RESPONSE\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"RCONPacketType\"},{\"kind\":16,\"name\":\"AUTH_RESPONSE\",\"url\":\"enums/RCONPacketType.html#AUTH_RESPONSE\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"RCONPacketType\"},{\"kind\":16,\"name\":\"COMMAND\",\"url\":\"enums/RCONPacketType.html#COMMAND\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"RCONPacketType\"},{\"kind\":16,\"name\":\"LOGIN\",\"url\":\"enums/RCONPacketType.html#LOGIN\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"RCONPacketType\"},{\"kind\":64,\"name\":\"generateRequestId\",\"url\":\"functions/generateRequestId.html\",\"classes\":\"tsd-kind-function\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,33.787]],[\"comment/0\",[]],[\"name/1\",[1,22.801]],[\"comment/1\",[]],[\"name/2\",[2,33.787]],[\"comment/2\",[]],[\"name/3\",[3,33.787]],[\"comment/3\",[]],[\"name/4\",[4,33.787]],[\"comment/4\",[]],[\"name/5\",[5,33.787]],[\"comment/5\",[]],[\"name/6\",[6,33.787]],[\"comment/6\",[]],[\"name/7\",[7,33.787]],[\"comment/7\",[]],[\"name/8\",[8,33.787]],[\"comment/8\",[]],[\"name/9\",[9,33.787]],[\"comment/9\",[]],[\"name/10\",[10,33.787]],[\"comment/10\",[]],[\"name/11\",[11,33.787]],[\"comment/11\",[]],[\"name/12\",[12,33.787]],[\"comment/12\",[]],[\"name/13\",[13,33.787]],[\"comment/13\",[]],[\"name/14\",[14,33.787]],[\"comment/14\",[]],[\"name/15\",[15,28.679]],[\"comment/15\",[]],[\"name/16\",[16,33.787]],[\"comment/16\",[]],[\"name/17\",[17,33.787]],[\"comment/17\",[]],[\"name/18\",[18,33.787]],[\"comment/18\",[]],[\"name/19\",[19,33.787]],[\"comment/19\",[]],[\"name/20\",[1,22.801]],[\"comment/20\",[]],[\"name/21\",[20,33.787]],[\"comment/21\",[]],[\"name/22\",[21,33.787]],[\"comment/22\",[]],[\"name/23\",[22,33.787]],[\"comment/23\",[]],[\"name/24\",[15,28.679]],[\"comment/24\",[]],[\"name/25\",[23,33.787]],[\"comment/25\",[]],[\"name/26\",[24,33.787]],[\"comment/26\",[]],[\"name/27\",[1,22.801]],[\"comment/27\",[]],[\"name/28\",[25,33.787]],[\"comment/28\",[]],[\"name/29\",[26,28.679]],[\"comment/29\",[]],[\"name/30\",[27,33.787]],[\"comment/30\",[]],[\"name/31\",[26,28.679]],[\"comment/31\",[]],[\"name/32\",[28,33.787]],[\"comment/32\",[]],[\"name/33\",[29,33.787]],[\"comment/33\",[]],[\"name/34\",[1,22.801]],[\"comment/34\",[]],[\"name/35\",[30,33.787]],[\"comment/35\",[]],[\"name/36\",[31,33.787]],[\"comment/36\",[]],[\"name/37\",[32,33.787]],[\"comment/37\",[]],[\"name/38\",[33,33.787]],[\"comment/38\",[]],[\"name/39\",[34,33.787]],[\"comment/39\",[]],[\"name/40\",[35,33.787]],[\"comment/40\",[]],[\"name/41\",[36,33.787]],[\"comment/41\",[]],[\"name/42\",[37,33.787]],[\"comment/42\",[]]],\"invertedIndex\":[[\"auth_response\",{\"_index\":34,\"name\":{\"39\":{}},\"comment\":{}}],[\"authenticated\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"authrequestid\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"buf\",{\"_index\":22,\"name\":{\"23\":{}},\"comment\":{}}],[\"buffer\",{\"_index\":25,\"name\":{\"28\":{}},\"comment\":{}}],[\"command\",{\"_index\":35,\"name\":{\"40\":{}},\"comment\":{}}],[\"connect\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"connected\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"20\":{},\"27\":{},\"34\":{}},\"comment\":{}}],[\"disconnect\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"error\",{\"_index\":32,\"name\":{\"37\":{}},\"comment\":{}}],[\"executecommand\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"executecommandasync\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"generaterequestid\",{\"_index\":37,\"name\":{\"42\":{}},\"comment\":{}}],[\"handle\",{\"_index\":30,\"name\":{\"35\":{}},\"comment\":{}}],[\"handledpacket\",{\"_index\":27,\"name\":{\"30\":{}},\"comment\":{}}],[\"handlemessage\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"handler\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"host\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"login\",{\"_index\":36,\"name\":{\"41\":{}},\"comment\":{}}],[\"max_client_payload_length\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"max_server_payload_length\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"packet\",{\"_index\":28,\"name\":{\"32\":{}},\"comment\":{}}],[\"password\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"payload\",{\"_index\":21,\"name\":{\"22\":{}},\"comment\":{}}],[\"port\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"rconclient\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"rconpacket\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"rconpacketbuilder\",{\"_index\":24,\"name\":{\"26\":{}},\"comment\":{}}],[\"rconpackethandler\",{\"_index\":29,\"name\":{\"33\":{}},\"comment\":{}}],[\"rconpackettype\",{\"_index\":31,\"name\":{\"36\":{}},\"comment\":{}}],[\"read\",{\"_index\":23,\"name\":{\"25\":{}},\"comment\":{}}],[\"requestid\",{\"_index\":26,\"name\":{\"29\":{},\"31\":{}},\"comment\":{}}],[\"response\",{\"_index\":33,\"name\":{\"38\":{}},\"comment\":{}}],[\"socket\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"throw\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"type\",{\"_index\":20,\"name\":{\"21\":{}},\"comment\":{}}],[\"write\",{\"_index\":15,\"name\":{\"15\":{},\"24\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse( + '{"kinds":{"8":"Enumeration","16":"Enumeration Member","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method"},"rows":[{"kind":128,"name":"RCONClient","url":"classes/RCONClient.html","classes":"tsd-kind-class"},{"kind":512,"name":"constructor","url":"classes/RCONClient.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"RCONClient"},{"kind":1024,"name":"host","url":"classes/RCONClient.html#host","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONClient"},{"kind":1024,"name":"port","url":"classes/RCONClient.html#port","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONClient"},{"kind":1024,"name":"authenticated","url":"classes/RCONClient.html#authenticated","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONClient"},{"kind":1024,"name":"connected","url":"classes/RCONClient.html#connected","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONClient"},{"kind":1024,"name":"password","url":"classes/RCONClient.html#password","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONClient"},{"kind":1024,"name":"authRequestId","url":"classes/RCONClient.html#authRequestId","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONClient"},{"kind":1024,"name":"handler","url":"classes/RCONClient.html#handler","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONClient"},{"kind":1024,"name":"socket","url":"classes/RCONClient.html#socket","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONClient"},{"kind":2048,"name":"connect","url":"classes/RCONClient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONClient"},{"kind":2048,"name":"executeCommand","url":"classes/RCONClient.html#executeCommand","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONClient"},{"kind":2048,"name":"executeCommandAsync","url":"classes/RCONClient.html#executeCommandAsync","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONClient"},{"kind":2048,"name":"disconnect","url":"classes/RCONClient.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONClient"},{"kind":2048,"name":"handleMessage","url":"classes/RCONClient.html#handleMessage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONClient"},{"kind":2048,"name":"write","url":"classes/RCONClient.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONClient"},{"kind":2048,"name":"throw","url":"classes/RCONClient.html#throw","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONClient"},{"kind":128,"name":"RCONPacket","url":"classes/RCONPacket.html","classes":"tsd-kind-class"},{"kind":1024,"name":"MAX_CLIENT_PAYLOAD_LENGTH","url":"classes/RCONPacket.html#MAX_CLIENT_PAYLOAD_LENGTH","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONPacket"},{"kind":1024,"name":"MAX_SERVER_PAYLOAD_LENGTH","url":"classes/RCONPacket.html#MAX_SERVER_PAYLOAD_LENGTH","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONPacket"},{"kind":512,"name":"constructor","url":"classes/RCONPacket.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"RCONPacket"},{"kind":1024,"name":"type","url":"classes/RCONPacket.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONPacket"},{"kind":1024,"name":"payload","url":"classes/RCONPacket.html#payload","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONPacket"},{"kind":1024,"name":"buf","url":"classes/RCONPacket.html#buf","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONPacket"},{"kind":2048,"name":"write","url":"classes/RCONPacket.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONPacket"},{"kind":2048,"name":"read","url":"classes/RCONPacket.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONPacket"},{"kind":128,"name":"RCONPacketBuilder","url":"classes/RCONPacketBuilder.html","classes":"tsd-kind-class"},{"kind":512,"name":"constructor","url":"classes/RCONPacketBuilder.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"RCONPacketBuilder"},{"kind":1024,"name":"buffer","url":"classes/RCONPacketBuilder.html#buffer","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONPacketBuilder"},{"kind":1024,"name":"requestId","url":"classes/RCONPacketBuilder.html#requestId","classes":"tsd-kind-property tsd-parent-kind-class","parent":"RCONPacketBuilder"},{"kind":256,"name":"HandledPacket","url":"interfaces/HandledPacket.html","classes":"tsd-kind-interface"},{"kind":1024,"name":"requestId","url":"interfaces/HandledPacket.html#requestId","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HandledPacket"},{"kind":1024,"name":"packet","url":"interfaces/HandledPacket.html#packet","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HandledPacket"},{"kind":128,"name":"RCONPacketHandler","url":"classes/RCONPacketHandler.html","classes":"tsd-kind-class"},{"kind":512,"name":"constructor","url":"classes/RCONPacketHandler.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"RCONPacketHandler"},{"kind":2048,"name":"handle","url":"classes/RCONPacketHandler.html#handle","classes":"tsd-kind-method tsd-parent-kind-class","parent":"RCONPacketHandler"},{"kind":8,"name":"RCONPacketType","url":"enums/RCONPacketType.html","classes":"tsd-kind-enum"},{"kind":16,"name":"ERROR","url":"enums/RCONPacketType.html#ERROR","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RCONPacketType"},{"kind":16,"name":"RESPONSE","url":"enums/RCONPacketType.html#RESPONSE","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RCONPacketType"},{"kind":16,"name":"AUTH_RESPONSE","url":"enums/RCONPacketType.html#AUTH_RESPONSE","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RCONPacketType"},{"kind":16,"name":"COMMAND","url":"enums/RCONPacketType.html#COMMAND","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RCONPacketType"},{"kind":16,"name":"LOGIN","url":"enums/RCONPacketType.html#LOGIN","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RCONPacketType"},{"kind":64,"name":"generateRequestId","url":"functions/generateRequestId.html","classes":"tsd-kind-function"}],"index":{"version":"2.3.9","fields":["name","comment"],"fieldVectors":[["name/0",[0,33.787]],["comment/0",[]],["name/1",[1,22.801]],["comment/1",[]],["name/2",[2,33.787]],["comment/2",[]],["name/3",[3,33.787]],["comment/3",[]],["name/4",[4,33.787]],["comment/4",[]],["name/5",[5,33.787]],["comment/5",[]],["name/6",[6,33.787]],["comment/6",[]],["name/7",[7,33.787]],["comment/7",[]],["name/8",[8,33.787]],["comment/8",[]],["name/9",[9,33.787]],["comment/9",[]],["name/10",[10,33.787]],["comment/10",[]],["name/11",[11,33.787]],["comment/11",[]],["name/12",[12,33.787]],["comment/12",[]],["name/13",[13,33.787]],["comment/13",[]],["name/14",[14,33.787]],["comment/14",[]],["name/15",[15,28.679]],["comment/15",[]],["name/16",[16,33.787]],["comment/16",[]],["name/17",[17,33.787]],["comment/17",[]],["name/18",[18,33.787]],["comment/18",[]],["name/19",[19,33.787]],["comment/19",[]],["name/20",[1,22.801]],["comment/20",[]],["name/21",[20,33.787]],["comment/21",[]],["name/22",[21,33.787]],["comment/22",[]],["name/23",[22,33.787]],["comment/23",[]],["name/24",[15,28.679]],["comment/24",[]],["name/25",[23,33.787]],["comment/25",[]],["name/26",[24,33.787]],["comment/26",[]],["name/27",[1,22.801]],["comment/27",[]],["name/28",[25,33.787]],["comment/28",[]],["name/29",[26,28.679]],["comment/29",[]],["name/30",[27,33.787]],["comment/30",[]],["name/31",[26,28.679]],["comment/31",[]],["name/32",[28,33.787]],["comment/32",[]],["name/33",[29,33.787]],["comment/33",[]],["name/34",[1,22.801]],["comment/34",[]],["name/35",[30,33.787]],["comment/35",[]],["name/36",[31,33.787]],["comment/36",[]],["name/37",[32,33.787]],["comment/37",[]],["name/38",[33,33.787]],["comment/38",[]],["name/39",[34,33.787]],["comment/39",[]],["name/40",[35,33.787]],["comment/40",[]],["name/41",[36,33.787]],["comment/41",[]],["name/42",[37,33.787]],["comment/42",[]]],"invertedIndex":[["auth_response",{"_index":34,"name":{"39":{}},"comment":{}}],["authenticated",{"_index":4,"name":{"4":{}},"comment":{}}],["authrequestid",{"_index":7,"name":{"7":{}},"comment":{}}],["buf",{"_index":22,"name":{"23":{}},"comment":{}}],["buffer",{"_index":25,"name":{"28":{}},"comment":{}}],["command",{"_index":35,"name":{"40":{}},"comment":{}}],["connect",{"_index":10,"name":{"10":{}},"comment":{}}],["connected",{"_index":5,"name":{"5":{}},"comment":{}}],["constructor",{"_index":1,"name":{"1":{},"20":{},"27":{},"34":{}},"comment":{}}],["disconnect",{"_index":13,"name":{"13":{}},"comment":{}}],["error",{"_index":32,"name":{"37":{}},"comment":{}}],["executecommand",{"_index":11,"name":{"11":{}},"comment":{}}],["executecommandasync",{"_index":12,"name":{"12":{}},"comment":{}}],["generaterequestid",{"_index":37,"name":{"42":{}},"comment":{}}],["handle",{"_index":30,"name":{"35":{}},"comment":{}}],["handledpacket",{"_index":27,"name":{"30":{}},"comment":{}}],["handlemessage",{"_index":14,"name":{"14":{}},"comment":{}}],["handler",{"_index":8,"name":{"8":{}},"comment":{}}],["host",{"_index":2,"name":{"2":{}},"comment":{}}],["login",{"_index":36,"name":{"41":{}},"comment":{}}],["max_client_payload_length",{"_index":18,"name":{"18":{}},"comment":{}}],["max_server_payload_length",{"_index":19,"name":{"19":{}},"comment":{}}],["packet",{"_index":28,"name":{"32":{}},"comment":{}}],["password",{"_index":6,"name":{"6":{}},"comment":{}}],["payload",{"_index":21,"name":{"22":{}},"comment":{}}],["port",{"_index":3,"name":{"3":{}},"comment":{}}],["rconclient",{"_index":0,"name":{"0":{}},"comment":{}}],["rconpacket",{"_index":17,"name":{"17":{}},"comment":{}}],["rconpacketbuilder",{"_index":24,"name":{"26":{}},"comment":{}}],["rconpackethandler",{"_index":29,"name":{"33":{}},"comment":{}}],["rconpackettype",{"_index":31,"name":{"36":{}},"comment":{}}],["read",{"_index":23,"name":{"25":{}},"comment":{}}],["requestid",{"_index":26,"name":{"29":{},"31":{}},"comment":{}}],["response",{"_index":33,"name":{"38":{}},"comment":{}}],["socket",{"_index":9,"name":{"9":{}},"comment":{}}],["throw",{"_index":16,"name":{"16":{}},"comment":{}}],["type",{"_index":20,"name":{"21":{}},"comment":{}}],["write",{"_index":15,"name":{"15":{},"24":{}},"comment":{}}]],"pipeline":[]}}' +); diff --git a/docs/classes/RCONClient.html b/docs/classes/RCONClient.html index a99407b..1aafc13 100644 --- a/docs/classes/RCONClient.html +++ b/docs/classes/RCONClient.html @@ -1,598 +1,3632 @@ -
Private
+ handleHandle incoming messages
+Optional
+ event:
+ E
+ Private
+ throw
+ Throw an error
+Error to throw
+Optional
+ isRCON: boolean
+ Whether or not this error comes from RCON
+Private
+ write
+ Write a message to the server
+Message to send
++ Generated using + TypeDoc +
+Read or write a packet
-Optional
buf: BufWrapper<BufWrapperPlugins>Buffer to create the packet from, can be undefined
if you are building a packet
BufWrapper instance that wraps the buffer for this packet
-Payload of the packet
-Type of the packet
+ + + + + +Read or write a packet
+Optional
+ buf: BufWrapper<BufWrapperPlugins>
+
+ Buffer to create the packet from, can be
+ undefined
if you are building a packet
+
BufWrapper instance that wraps the buffer for this packet
+Payload of the packet
+Static
Readonly
MAX_Maximum client to server packet length
-Static
Readonly
MAX_Maximum server to client packet length
-Read the packet content
-Write the data to the packet
-Optional
type: RCONPacketTypeType of the RCONPacket
-Optional
payload: stringPayload for this packet
-Generated using TypeDoc
Static
+ Readonly
+ MAX_Maximum client to server packet length
+Static
+ Readonly
+ MAX_Maximum server to client packet length
+Read the packet content
+Write the data to the packet
+Optional
+ type:
+ RCONPacketType
+ Type of the RCONPacket
+Optional
+ payload: string
+ Payload for this packet
++ Generated using + TypeDoc +
+RCON Packet Builder, used -to create fully built packets
-Create a new packet ready to be sent
-Type of the RCONPacket
-Payload for this packet
-Packet buffer, contains the packet data
-Request ID of that packet
-Generated using TypeDoc
RCON Packet Builder, used to create fully built packets
+Create a new packet ready to be sent
+Type of the RCONPacket
+Payload for this packet
+Packet buffer, contains the packet data
+Request ID of that packet
++ Generated using + TypeDoc +
+Handle a packet
+ + + + + +Handle a packet
-All handled packets
-Raw buffer
-Generated using TypeDoc
All handled packets
+Raw buffer
++ Generated using + TypeDoc +
+Generated using TypeDoc
Enum of the different packet types
++ Generated using + TypeDoc +
+The packet itself
-Request ID generated for that packet
-Generated using TypeDoc
The packet itself
+Request ID generated for that packet
++ Generated using + TypeDoc +
+
RCONClient Class
+ + + + + ++- Preparing search index...
+ - The search index is not available
+
+ @minecraft-js/rcon ++- @minecraft-js/rcon
+ - RCONClient
+
+Class RCONClient
+RCONClient Class
-See
https://wiki.vg/RCON for more information
-Hierarchy
--- TypedEventEmitter<RCONClientEvents, this>
-
-- RCONClient
-
-Index
Constructors
-Properties
-Methods
-Constructors
-constructor
--- new RCONClient(host: string, password: string, port?: number): RCONClient
---
-
-
-
-
Instantiate a new RCONClient instance
-Parameters
---
-
--
-
--
-
host: string
-Host for this RCONClient
-password: string
-Password used to login
-port: number = 25575
-Port to use, defaults to 25575
-Returns RCONClient
Properties
- Request Id
-Private
authRequest ID of the login packet
-authenticated
-Whether or not this client has been authenticated
-connected
-Whether or not this client is connected
-
-Private
handlerPacket handler
-host
-Host this client is linked to
-
-Private
passwordPassword used to login
-port
-Port this client is linked to
-
-Private
socketTCP socket
-Methods
-add Listener
--- add
Listener<E>(event: E, listener: RCONClientEvents[E]): RCONClient
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
--
-
event: E
listener: RCONClientEvents[E]
Returns RCONClient
connect
--- connect(): RCONClient
---
-
+
Connect to the Minecraft server
+See
++ https://wiki.vg/RCON for more + information +
+Hierarchy
++-
+ TypedEventEmitter<RCONClientEvents, this>
+
+
++- RCONClient
+
++
++ + Index +
+Constructors
+Properties
+Methods
+Constructors
++ constructor +
++-
+ new RCONClient(host: string, password: string, port?: number): RCONClient
+
+
++-
+
+
+
+
+
+
+Instantiate a new RCONClient instance
+Parameters
++-
+
+
+
+ -
+
+
+
+ -
+
+
+
+
++ host: string +
+Host for this RCONClient
++ password: string +
+Password used to login
++ port: number = 25575 +
+Port to use, defaults to 25575
++ Returns + RCONClient +
+ +Properties
++ Request Id
+
+Private
+ authRequest ID of the login packet
++ authenticated +
+Whether or not this client has been authenticated
++ connected +
+Whether or not this client is connected
++
+Private
+ handler +Packet handler
+ host +
+Host this client is linked to
++
+Private
+ password +Password used to login
++ port +
+Port this client is linked to
++
+Private
+ socket +TCP socket
Methods
++ add Listener
+
++-
+ add
Listener<E>(event: E, listener: RCONClientEvents[E]): RCONClient
+
+
++-
+
+
+
+
+
+
+Type Parameters
++-
+
+
++ E extends keyof RCONClientEvents +
+Parameters
++-
+
+ -
+
+
++ event: + E +
++ listener: + RCONClientEvents[E] +
++ Returns + RCONClient +
+ ++ connect +
++-
+ connect(): RCONClient
+
+
++-
+
+
-
Connect to the Minecraft server
-Returns
The RCONClient
-Returns RCONClient
disconnect
--- disconnect(): void
---
-
-
Disconnect the client and end the connection
-Returns void
emit
--- emit<E>(event: E, ...args: Parameters<RCONClientEvents[E]>): boolean
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
--
-
event: E
Rest
...args: Parameters<RCONClientEvents[E]>Returns boolean
event Names
--- event
Names(): (string | symbol)[]
---
-
Returns (string | symbol)[]
execute Command
--- execute
Command(command: string): number
---
-
+
+
+Execute a command on the server
-This method isn't deprecated but it's -way better to use
+RCONClient#executeCommandAsync
-because it handles fragmentation unlike this oneReturns
+The RCONClient
++ Returns + RCONClient +
++ disconnect +
++-
+ disconnect(): void
+
+
++-
+
+
+
+
+Disconnect the client and end the connection
++ Returns void +
++ emit +
++-
+ emit<E>(event: E, ...args: Parameters<RCONClientEvents[E]>): boolean
+
+
++-
+
+
+
+
+
+
+Type Parameters
++-
+
+
++ E extends keyof RCONClientEvents +
+Parameters
++-
+
+ -
+
+
++ event: + E +
++
+Rest
+ ...args: + Parameters<RCONClientEvents[E]> ++ Returns boolean +
+ ++ event Names
+
++-
+ event
Names(): (string | symbol)[]
+
+
++-
+
+
++ Returns (string | symbol)[] +
+ ++ execute Command
+
++-
+ execute
Command(command: string): number
+
+
++-
+
+
-
-
-
Execute a command on the server
++ This method isn't deprecated but it's way better to + use
-RCONClient#executeCommandAsync
because it + handles fragmentation unlike this one +Returns
The request ID (use it to catch the response)
-Parameters
---
-
command: string
-Command to execute on the server
-Returns number
execute Command Async
--- execute
Command Async(command: string, timeout?: number): Promise<string>
---
-
+
+
+
+
+Execute a command and asynchronously -get its output
-This method handles everything (including -fragmentation) so you don't have to worry -about it.
+Returns
+The request ID (use it to catch the response)
+Parameters
++-
+
+
+
+
++ command: string +
+Command to execute on the server
++ Returns number +
++ execute Command Async
+
++-
+ execute
Command Async(command: string, timeout?: number): Promise<string>
+
+
++-
+
+
-
-
-
Execute a command and asynchronously get its output
++ This method handles everything (including fragmentation) so + you don't have to worry about it. +
-Returns
A promise that resolves with the command's output
-Parameters
---
-
--
-
command: string
-Command to execute
-
-Optional
timeout: numberTimeout before the -promise is rejected (prevents promise -from indefinitely being on pending -if something fails), in milliseconds
-Returns Promise<string>
get Max Listeners
--- get
Max Listeners(): number
---
-
Returns number
Message
-Private
handle-- handle
Message(buffer: Buffer): void
---
-
-
-
-
Handle incoming messages
-Parameters
---
-
buffer: Buffer
Returns void
listener Count
--- listener
Count<E>(event: E): number
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
event: E
Returns number
listeners
--- listeners<E>(event: E): RCONClientEvents[E][]
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
event: E
Returns RCONClientEvents[E][]
off
--- off<E>(event: E, listener: RCONClientEvents[E]): RCONClient
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
--
-
event: E
listener: RCONClientEvents[E]
Returns RCONClient
on
--- on<E>(event: E, listener: RCONClientEvents[E]): RCONClient
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
--
-
event: E
listener: RCONClientEvents[E]
Returns RCONClient
once
--- once<E>(event: E, listener: RCONClientEvents[E]): RCONClient
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
--
-
event: E
listener: RCONClientEvents[E]
Returns RCONClient
prepend Listener
--- prepend
Listener<E>(event: E, listener: RCONClientEvents[E]): RCONClient
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
--
-
event: E
listener: RCONClientEvents[E]
Returns RCONClient
prepend Once Listener
--- prepend
Once Listener<E>(event: E, listener: RCONClientEvents[E]): RCONClient
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
--
-
event: E
listener: RCONClientEvents[E]
Returns RCONClient
raw Listeners
--- raw
Listeners<E>(event: E): RCONClientEvents[E][]
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
event: E
Returns RCONClientEvents[E][]
remove All Listeners
--- remove
All Listeners<E>(event?: E): RCONClient
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
Optional
event: EReturns RCONClient
remove Listener
--- remove
Listener<E>(event: E, listener: RCONClientEvents[E]): RCONClient
---
-
-
-
-
-
Type Parameters
---
-
E extends keyof RCONClientEvents
Parameters
---
-
--
-
event: E
listener: RCONClientEvents[E]
Returns RCONClient
set Max Listeners
--- set
Max Listeners(maxListeners: number): RCONClient
---
-
-
-
Parameters
---
-
maxListeners: number
Returns RCONClient
-Private
throw-- throw(error: Error, isRCON?: boolean): void
---
-
-
-
-
Throw an error
-Parameters
---
-
--
-
error: Error
-Error to throw
-
-Optional
isRCON: booleanWhether or not this error comes from RCON
-Returns void
-Private
write-- write(buffer: Buffer): void
---
-
-
-
-
Write a message to the server
-Parameters
---
-
buffer: Buffer
-Message to send
-Returns void
-
-Settings
Member Visibility
Theme
Generated using TypeDoc
Returns
+A promise that resolves with the command's output
+Parameters
++-
+
+
+
+ -
+
+
+
+
++ command: string +
+Command to execute
++
+Optional
+ timeout: number ++ Timeout before the promise is rejected (prevents + promise from indefinitely being on pending if + something fails), in milliseconds +
++ Returns Promise<string> +
+ + +