From 67d2bc8b2ca46907bf0ea76de6722b735707e626 Mon Sep 17 00:00:00 2001 From: Jason Antwi-Appah Date: Tue, 6 Feb 2024 00:13:31 -0600 Subject: [PATCH 1/2] Add workflow to rebuild docs site (#85) * Remove typedoc output from repo * Add docs directory to gitignore * Run yarn with frozen lockfile in Actions * Document how to access documentation * Add workflow to build/deploy site * Only deploy on pushes to main * Cache deps --- .github/workflows/docs.yml | 46 + .gitignore | 1 + docs/.nojekyll | 1 - docs/CNAME | 1 - docs/assets/highlight.css | 29 - docs/assets/main.js | 2343 --------------- docs/assets/navigation.js | 2 - docs/assets/search.js | 2 - docs/assets/style.css | 1414 --------- .../server_api_tcp_interface.BotTunnel.html | 2566 ----------------- .../server_api_tcp_interface.TCPServer.html | 1703 ----------- .../server_command_command.CommandBase.html | 1756 ----------- .../server_command_command.CommandGroup.html | 1867 ------------ ..._command_command.ParallelCommandGroup.html | 1857 ------------ .../server_command_command.RobotCommand.html | 1872 ------------ ...ommand_command.SequentialCommandGroup.html | 1860 ------------ ...rver_command_executor.CommandExecutor.html | 1579 ---------- ...mand_move_command.AbsoluteMoveCommand.html | 1940 ------------- ...nd_move_command.AbsoluteRotateCommand.html | 1928 ------------- ...rver_command_move_command.MoveCommand.html | 1948 ------------- ...mand_move_command.RelativeMoveCommand.html | 2047 ------------- ...nd_move_command.RelativeRotateCommand.html | 2032 ------------- ...er_command_move_command.RotateCommand.html | 1935 ------------- ...and_move_command.RotateToStartCommand.html | 1855 ------------ .../server_command_move_piece.MovePiece.html | 1908 ------------ docs/classes/server_robot_pair.Indices.html | 2137 -------------- docs/classes/server_robot_pair.Position.html | 2139 -------------- docs/classes/server_robot_piece.Piece.html | 1490 ---------- ...rver_robot_piece_manager.PieceManager.html | 1402 --------- docs/classes/server_robot_robot.Robot.html | 2083 ------------- ...server_robot_robot_socket.RobotSocket.html | 1659 ----------- docs/classes/server_robot_square.Square.html | 1808 ------------ .../server_api_tcp_interface.PacketType.html | 1870 ------------ docs/enums/server_robot_types.PieceType.html | 1416 --------- docs/enums/server_robot_types.Side.html | 1206 -------- docs/functions/client_api.post.html | 1133 -------- docs/functions/client_app.App.html | 1071 ------- docs/functions/client_body.Body.html | 1073 ------- ..._chessboard_wrapper.ChessboardWrapper.html | 1095 ------- .../client_navbar_menu.NavbarMenu.html | 1094 ------- docs/functions/client_pages_debug.Debug.html | 1075 ------- .../server_api_api.websocketHandler.html | 1157 -------- .../server_robot_types.getStartHeading.html | 1094 ------- .../server_utils_units.clampHeading.html | 1092 ------- docs/hierarchy.html | 1319 --------- docs/index.html | 1137 -------- .../server_command_command.Command.html | 1446 ---------- .../server_command_command.Reversible.html | 1265 -------- docs/modules/client_api.html | 1057 ------- docs/modules/client_app.html | 1057 ------- docs/modules/client_body.html | 1057 ------- docs/modules/client_chessboard_wrapper.html | 1060 ------- docs/modules/client_main.html | 1037 ------- docs/modules/client_navbar_menu.html | 1061 ------- docs/modules/client_pages_debug.html | 1061 ------- docs/modules/client_vite_env.html | 1028 ------- docs/modules/server_api_api.html | 1058 ------- docs/modules/server_api_tcp_interface.html | 1085 ------- docs/modules/server_command_command.html | 1129 -------- docs/modules/server_command_executor.html | 1060 ------- docs/modules/server_command_move_command.html | 1130 -------- docs/modules/server_command_move_piece.html | 1060 ------- docs/modules/server_main.html | 1037 ------- .../server_robot___tests___robot_test.html | 1040 ------- docs/modules/server_robot_pair.html | 1094 ------- docs/modules/server_robot_piece.html | 1059 ------- docs/modules/server_robot_piece_manager.html | 1059 ------- docs/modules/server_robot_robot.html | 1059 ------- docs/modules/server_robot_robot_socket.html | 1059 ------- docs/modules/server_robot_square.html | 1059 ------- docs/modules/server_robot_types.html | 1086 ------- docs/modules/server_utils_units.html | 1094 ------- .../server_robot_pair.ZERO_INDICES.html | 1063 ------- .../server_robot_pair.ZERO_POSITION.html | 1063 ------- docs/variables/server_utils_units.DEGREE.html | 1066 ------- .../server_utils_units.FULL_ROTATION.html | 1060 ------- docs/variables/server_utils_units.RADIAN.html | 1062 ------- readme.md | 2 +- 78 files changed, 48 insertions(+), 97607 deletions(-) create mode 100644 .github/workflows/docs.yml delete mode 100644 docs/.nojekyll delete mode 100644 docs/CNAME delete mode 100644 docs/assets/highlight.css delete mode 100644 docs/assets/main.js delete mode 100644 docs/assets/navigation.js delete mode 100644 docs/assets/search.js delete mode 100644 docs/assets/style.css delete mode 100644 docs/classes/server_api_tcp_interface.BotTunnel.html delete mode 100644 docs/classes/server_api_tcp_interface.TCPServer.html delete mode 100644 docs/classes/server_command_command.CommandBase.html delete mode 100644 docs/classes/server_command_command.CommandGroup.html delete mode 100644 docs/classes/server_command_command.ParallelCommandGroup.html delete mode 100644 docs/classes/server_command_command.RobotCommand.html delete mode 100644 docs/classes/server_command_command.SequentialCommandGroup.html delete mode 100644 docs/classes/server_command_executor.CommandExecutor.html delete mode 100644 docs/classes/server_command_move_command.AbsoluteMoveCommand.html delete mode 100644 docs/classes/server_command_move_command.AbsoluteRotateCommand.html delete mode 100644 docs/classes/server_command_move_command.MoveCommand.html delete mode 100644 docs/classes/server_command_move_command.RelativeMoveCommand.html delete mode 100644 docs/classes/server_command_move_command.RelativeRotateCommand.html delete mode 100644 docs/classes/server_command_move_command.RotateCommand.html delete mode 100644 docs/classes/server_command_move_command.RotateToStartCommand.html delete mode 100644 docs/classes/server_command_move_piece.MovePiece.html delete mode 100644 docs/classes/server_robot_pair.Indices.html delete mode 100644 docs/classes/server_robot_pair.Position.html delete mode 100644 docs/classes/server_robot_piece.Piece.html delete mode 100644 docs/classes/server_robot_piece_manager.PieceManager.html delete mode 100644 docs/classes/server_robot_robot.Robot.html delete mode 100644 docs/classes/server_robot_robot_socket.RobotSocket.html delete mode 100644 docs/classes/server_robot_square.Square.html delete mode 100644 docs/enums/server_api_tcp_interface.PacketType.html delete mode 100644 docs/enums/server_robot_types.PieceType.html delete mode 100644 docs/enums/server_robot_types.Side.html delete mode 100644 docs/functions/client_api.post.html delete mode 100644 docs/functions/client_app.App.html delete mode 100644 docs/functions/client_body.Body.html delete mode 100644 docs/functions/client_chessboard_wrapper.ChessboardWrapper.html delete mode 100644 docs/functions/client_navbar_menu.NavbarMenu.html delete mode 100644 docs/functions/client_pages_debug.Debug.html delete mode 100644 docs/functions/server_api_api.websocketHandler.html delete mode 100644 docs/functions/server_robot_types.getStartHeading.html delete mode 100644 docs/functions/server_utils_units.clampHeading.html delete mode 100644 docs/hierarchy.html delete mode 100644 docs/index.html delete mode 100644 docs/interfaces/server_command_command.Command.html delete mode 100644 docs/interfaces/server_command_command.Reversible.html delete mode 100644 docs/modules/client_api.html delete mode 100644 docs/modules/client_app.html delete mode 100644 docs/modules/client_body.html delete mode 100644 docs/modules/client_chessboard_wrapper.html delete mode 100644 docs/modules/client_main.html delete mode 100644 docs/modules/client_navbar_menu.html delete mode 100644 docs/modules/client_pages_debug.html delete mode 100644 docs/modules/client_vite_env.html delete mode 100644 docs/modules/server_api_api.html delete mode 100644 docs/modules/server_api_tcp_interface.html delete mode 100644 docs/modules/server_command_command.html delete mode 100644 docs/modules/server_command_executor.html delete mode 100644 docs/modules/server_command_move_command.html delete mode 100644 docs/modules/server_command_move_piece.html delete mode 100644 docs/modules/server_main.html delete mode 100644 docs/modules/server_robot___tests___robot_test.html delete mode 100644 docs/modules/server_robot_pair.html delete mode 100644 docs/modules/server_robot_piece.html delete mode 100644 docs/modules/server_robot_piece_manager.html delete mode 100644 docs/modules/server_robot_robot.html delete mode 100644 docs/modules/server_robot_robot_socket.html delete mode 100644 docs/modules/server_robot_square.html delete mode 100644 docs/modules/server_robot_types.html delete mode 100644 docs/modules/server_utils_units.html delete mode 100644 docs/variables/server_robot_pair.ZERO_INDICES.html delete mode 100644 docs/variables/server_robot_pair.ZERO_POSITION.html delete mode 100644 docs/variables/server_utils_units.DEGREE.html delete mode 100644 docs/variables/server_utils_units.FULL_ROTATION.html delete mode 100644 docs/variables/server_utils_units.RADIAN.html diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..2b49cec3 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,46 @@ +name: Build Documentation +on: + push: + branches: + - main + pull_request: + branches: + - main +jobs: + typedoc: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + cache: yarn + - name: Install modules + run: yarn --frozen-lockfile + - name: Run typedoc + run: yarn typedoc + - uses: actions/upload-pages-artifact@v3 + with: + path: docs + + # Deploy job + deploy: + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + # Add a dependency to the build job + needs: typedoc + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + # Specify runner + deployment step + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore index 0285dd6e..5b57f6b6 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,4 @@ dist-ssr *.sw? .vs/* *.wsuo +docs/ diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac6616..00000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index e003deda..00000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -chessbots.cometrobotics.org \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css deleted file mode 100644 index 1f820083..00000000 --- a/docs/assets/highlight.css +++ /dev/null @@ -1,29 +0,0 @@ -:root { - --light-code-background: #ffffff; - --dark-code-background: #1e1e1e; -} - -@media (prefers-color-scheme: light) { - :root { - --code-background: var(--light-code-background); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --code-background: var(--dark-code-background); - } -} - -:root[data-theme="light"] { - --code-background: var(--light-code-background); -} - -:root[data-theme="dark"] { - --code-background: var(--dark-code-background); -} - -pre, -code { - background: var(--code-background); -} diff --git a/docs/assets/main.js b/docs/assets/main.js deleted file mode 100644 index c986a86d..00000000 --- a/docs/assets/main.js +++ /dev/null @@ -1,2343 +0,0 @@ -"use strict"; -"use strict"; -(() => { - var Pe = Object.create; - var ne = Object.defineProperty; - var Ie = Object.getOwnPropertyDescriptor; - var Oe = Object.getOwnPropertyNames; - var _e = Object.getPrototypeOf, - Re = Object.prototype.hasOwnProperty; - var Me = (t, e) => () => ( - e || t((e = { exports: {} }).exports, e), e.exports - ); - var Fe = (t, e, n, r) => { - if ((e && typeof e == "object") || typeof e == "function") - for (let i of Oe(e)) - !Re.call(t, i) && - i !== n && - ne(t, i, { - get: () => e[i], - enumerable: !(r = Ie(e, i)) || r.enumerable, - }); - return t; - }; - var De = (t, e, n) => ( - (n = t != null ? Pe(_e(t)) : {}), - Fe( - e || !t || !t.__esModule ? - ne(n, "default", { value: t, enumerable: !0 }) - : n, - t, - ) - ); - var ae = Me((se, oe) => { - (function () { - var t = function (e) { - var n = new t.Builder(); - return ( - n.pipeline.add(t.trimmer, t.stopWordFilter, t.stemmer), - n.searchPipeline.add(t.stemmer), - e.call(n, n), - n.build() - ); - }; - t.version = "2.3.9"; - (t.utils = {}), - (t.utils.warn = (function (e) { - return function (n) { - e.console && console.warn && console.warn(n); - }; - })(this)), - (t.utils.asString = function (e) { - return e == null ? "" : e.toString(); - }), - (t.utils.clone = function (e) { - if (e == null) return e; - for ( - var n = Object.create(null), r = Object.keys(e), i = 0; - i < r.length; - i++ - ) { - var s = r[i], - o = e[s]; - if (Array.isArray(o)) { - n[s] = o.slice(); - continue; - } - if ( - typeof o == "string" || - typeof o == "number" || - typeof o == "boolean" - ) { - n[s] = o; - continue; - } - throw new TypeError( - "clone is not deep and does not support nested objects", - ); - } - return n; - }), - (t.FieldRef = function (e, n, r) { - (this.docRef = e), - (this.fieldName = n), - (this._stringValue = r); - }), - (t.FieldRef.joiner = "/"), - (t.FieldRef.fromString = function (e) { - var n = e.indexOf(t.FieldRef.joiner); - if (n === -1) throw "malformed field ref string"; - var r = e.slice(0, n), - i = e.slice(n + 1); - return new t.FieldRef(i, r, e); - }), - (t.FieldRef.prototype.toString = function () { - return ( - this._stringValue == null && - (this._stringValue = - this.fieldName + - t.FieldRef.joiner + - this.docRef), - this._stringValue - ); - }); - (t.Set = function (e) { - if (((this.elements = Object.create(null)), e)) { - this.length = e.length; - for (var n = 0; n < this.length; n++) - this.elements[e[n]] = !0; - } else this.length = 0; - }), - (t.Set.complete = { - intersect: function (e) { - return e; - }, - union: function () { - return this; - }, - contains: function () { - return !0; - }, - }), - (t.Set.empty = { - intersect: function () { - return this; - }, - union: function (e) { - return e; - }, - contains: function () { - return !1; - }, - }), - (t.Set.prototype.contains = function (e) { - return !!this.elements[e]; - }), - (t.Set.prototype.intersect = function (e) { - var n, - r, - i, - s = []; - if (e === t.Set.complete) return this; - if (e === t.Set.empty) return e; - this.length < e.length ? - ((n = this), (r = e)) - : ((n = e), (r = this)), - (i = Object.keys(n.elements)); - for (var o = 0; o < i.length; o++) { - var a = i[o]; - a in r.elements && s.push(a); - } - return new t.Set(s); - }), - (t.Set.prototype.union = function (e) { - return ( - e === t.Set.complete ? t.Set.complete - : e === t.Set.empty ? this - : new t.Set( - Object.keys(this.elements).concat( - Object.keys(e.elements), - ), - ) - ); - }), - (t.idf = function (e, n) { - var r = 0; - for (var i in e) - i != "_index" && (r += Object.keys(e[i]).length); - var s = (n - r + 0.5) / (r + 0.5); - return Math.log(1 + Math.abs(s)); - }), - (t.Token = function (e, n) { - (this.str = e || ""), (this.metadata = n || {}); - }), - (t.Token.prototype.toString = function () { - return this.str; - }), - (t.Token.prototype.update = function (e) { - return (this.str = e(this.str, this.metadata)), this; - }), - (t.Token.prototype.clone = function (e) { - return ( - (e = - e || - function (n) { - return n; - }), - new t.Token(e(this.str, this.metadata), this.metadata) - ); - }); - (t.tokenizer = function (e, n) { - if (e == null || e == null) return []; - if (Array.isArray(e)) - return e.map(function (v) { - return new t.Token( - t.utils.asString(v).toLowerCase(), - t.utils.clone(n), - ); - }); - for ( - var r = e.toString().toLowerCase(), - i = r.length, - s = [], - o = 0, - a = 0; - o <= i; - o++ - ) { - var l = r.charAt(o), - u = o - a; - if (l.match(t.tokenizer.separator) || o == i) { - if (u > 0) { - var d = t.utils.clone(n) || {}; - (d.position = [a, u]), - (d.index = s.length), - s.push(new t.Token(r.slice(a, o), d)); - } - a = o + 1; - } - } - return s; - }), - (t.tokenizer.separator = /[\s\-]+/); - (t.Pipeline = function () { - this._stack = []; - }), - (t.Pipeline.registeredFunctions = Object.create(null)), - (t.Pipeline.registerFunction = function (e, n) { - n in this.registeredFunctions && - t.utils.warn( - "Overwriting existing registered function: " + n, - ), - (e.label = n), - (t.Pipeline.registeredFunctions[e.label] = e); - }), - (t.Pipeline.warnIfFunctionNotRegistered = function (e) { - var n = e.label && e.label in this.registeredFunctions; - n || - t.utils.warn( - `Function is not registered with pipeline. This may cause problems when serialising the index. -`, - e, - ); - }), - (t.Pipeline.load = function (e) { - var n = new t.Pipeline(); - return ( - e.forEach(function (r) { - var i = t.Pipeline.registeredFunctions[r]; - if (i) n.add(i); - else - throw new Error( - "Cannot load unregistered function: " + r, - ); - }), - n - ); - }), - (t.Pipeline.prototype.add = function () { - var e = Array.prototype.slice.call(arguments); - e.forEach(function (n) { - t.Pipeline.warnIfFunctionNotRegistered(n), - this._stack.push(n); - }, this); - }), - (t.Pipeline.prototype.after = function (e, n) { - t.Pipeline.warnIfFunctionNotRegistered(n); - var r = this._stack.indexOf(e); - if (r == -1) throw new Error("Cannot find existingFn"); - (r = r + 1), this._stack.splice(r, 0, n); - }), - (t.Pipeline.prototype.before = function (e, n) { - t.Pipeline.warnIfFunctionNotRegistered(n); - var r = this._stack.indexOf(e); - if (r == -1) throw new Error("Cannot find existingFn"); - this._stack.splice(r, 0, n); - }), - (t.Pipeline.prototype.remove = function (e) { - var n = this._stack.indexOf(e); - n != -1 && this._stack.splice(n, 1); - }), - (t.Pipeline.prototype.run = function (e) { - for (var n = this._stack.length, r = 0; r < n; r++) { - for ( - var i = this._stack[r], s = [], o = 0; - o < e.length; - o++ - ) { - var a = i(e[o], o, e); - if (!(a == null || a === "")) - if (Array.isArray(a)) - for (var l = 0; l < a.length; l++) - s.push(a[l]); - else s.push(a); - } - e = s; - } - return e; - }), - (t.Pipeline.prototype.runString = function (e, n) { - var r = new t.Token(e, n); - return this.run([r]).map(function (i) { - return i.toString(); - }); - }), - (t.Pipeline.prototype.reset = function () { - this._stack = []; - }), - (t.Pipeline.prototype.toJSON = function () { - return this._stack.map(function (e) { - return ( - t.Pipeline.warnIfFunctionNotRegistered(e), e.label - ); - }); - }); - (t.Vector = function (e) { - (this._magnitude = 0), (this.elements = e || []); - }), - (t.Vector.prototype.positionForIndex = function (e) { - if (this.elements.length == 0) return 0; - for ( - var n = 0, - r = this.elements.length / 2, - i = r - n, - s = Math.floor(i / 2), - o = this.elements[s * 2]; - i > 1 && (o < e && (n = s), o > e && (r = s), o != e); - - ) - (i = r - n), - (s = n + Math.floor(i / 2)), - (o = this.elements[s * 2]); - if (o == e || o > e) return s * 2; - if (o < e) return (s + 1) * 2; - }), - (t.Vector.prototype.insert = function (e, n) { - this.upsert(e, n, function () { - throw "duplicate index"; - }); - }), - (t.Vector.prototype.upsert = function (e, n, r) { - this._magnitude = 0; - var i = this.positionForIndex(e); - this.elements[i] == e ? - (this.elements[i + 1] = r(this.elements[i + 1], n)) - : this.elements.splice(i, 0, e, n); - }), - (t.Vector.prototype.magnitude = function () { - if (this._magnitude) return this._magnitude; - for ( - var e = 0, n = this.elements.length, r = 1; - r < n; - r += 2 - ) { - var i = this.elements[r]; - e += i * i; - } - return (this._magnitude = Math.sqrt(e)); - }), - (t.Vector.prototype.dot = function (e) { - for ( - var n = 0, - r = this.elements, - i = e.elements, - s = r.length, - o = i.length, - a = 0, - l = 0, - u = 0, - d = 0; - u < s && d < o; - - ) - (a = r[u]), - (l = i[d]), - a < l ? (u += 2) - : a > l ? (d += 2) - : a == l && - ((n += r[u + 1] * i[d + 1]), - (u += 2), - (d += 2)); - return n; - }), - (t.Vector.prototype.similarity = function (e) { - return this.dot(e) / this.magnitude() || 0; - }), - (t.Vector.prototype.toArray = function () { - for ( - var e = new Array(this.elements.length / 2), - n = 1, - r = 0; - n < this.elements.length; - n += 2, r++ - ) - e[r] = this.elements[n]; - return e; - }), - (t.Vector.prototype.toJSON = function () { - return this.elements; - }); - (t.stemmer = (function () { - var e = { - ational: "ate", - tional: "tion", - enci: "ence", - anci: "ance", - izer: "ize", - bli: "ble", - alli: "al", - entli: "ent", - eli: "e", - ousli: "ous", - ization: "ize", - ation: "ate", - ator: "ate", - alism: "al", - iveness: "ive", - fulness: "ful", - ousness: "ous", - aliti: "al", - iviti: "ive", - biliti: "ble", - logi: "log", - }, - n = { - icate: "ic", - ative: "", - alize: "al", - iciti: "ic", - ical: "ic", - ful: "", - ness: "", - }, - r = "[^aeiou]", - i = "[aeiouy]", - s = r + "[^aeiouy]*", - o = i + "[aeiou]*", - a = "^(" + s + ")?" + o + s, - l = "^(" + s + ")?" + o + s + "(" + o + ")?$", - u = "^(" + s + ")?" + o + s + o + s, - d = "^(" + s + ")?" + i, - v = new RegExp(a), - f = new RegExp(u), - b = new RegExp(l), - g = new RegExp(d), - L = /^(.+?)(ss|i)es$/, - p = /^(.+?)([^s])s$/, - m = /^(.+?)eed$/, - S = /^(.+?)(ed|ing)$/, - w = /.$/, - k = /(at|bl|iz)$/, - _ = new RegExp("([^aeiouylsz])\\1$"), - H = new RegExp("^" + s + i + "[^aeiouwxy]$"), - A = /^(.+?[^aeiou])y$/, - j = - /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/, - $ = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/, - N = - /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/, - q = /^(.+?)(s|t)(ion)$/, - P = /^(.+?)e$/, - z = /ll$/, - W = new RegExp("^" + s + i + "[^aeiouwxy]$"), - V = function (c) { - var y, I, T, h, x, O, M; - if (c.length < 3) return c; - if ( - ((T = c.substr(0, 1)), - T == "y" && (c = T.toUpperCase() + c.substr(1)), - (h = L), - (x = p), - h.test(c) ? - (c = c.replace(h, "$1$2")) - : x.test(c) && (c = c.replace(x, "$1$2")), - (h = m), - (x = S), - h.test(c)) - ) { - var E = h.exec(c); - (h = v), - h.test(E[1]) && - ((h = w), (c = c.replace(h, ""))); - } else if (x.test(c)) { - var E = x.exec(c); - (y = E[1]), - (x = g), - x.test(y) && - ((c = y), - (x = k), - (O = _), - (M = H), - x.test(c) ? (c = c + "e") - : O.test(c) ? - ((h = w), (c = c.replace(h, ""))) - : M.test(c) && (c = c + "e")); - } - if (((h = A), h.test(c))) { - var E = h.exec(c); - (y = E[1]), (c = y + "i"); - } - if (((h = j), h.test(c))) { - var E = h.exec(c); - (y = E[1]), - (I = E[2]), - (h = v), - h.test(y) && (c = y + e[I]); - } - if (((h = $), h.test(c))) { - var E = h.exec(c); - (y = E[1]), - (I = E[2]), - (h = v), - h.test(y) && (c = y + n[I]); - } - if (((h = N), (x = q), h.test(c))) { - var E = h.exec(c); - (y = E[1]), (h = f), h.test(y) && (c = y); - } else if (x.test(c)) { - var E = x.exec(c); - (y = E[1] + E[2]), (x = f), x.test(y) && (c = y); - } - if (((h = P), h.test(c))) { - var E = h.exec(c); - (y = E[1]), - (h = f), - (x = b), - (O = W), - (h.test(y) || (x.test(y) && !O.test(y))) && - (c = y); - } - return ( - (h = z), - (x = f), - h.test(c) && - x.test(c) && - ((h = w), (c = c.replace(h, ""))), - T == "y" && (c = T.toLowerCase() + c.substr(1)), - c - ); - }; - return function (R) { - return R.update(V); - }; - })()), - t.Pipeline.registerFunction(t.stemmer, "stemmer"); - (t.generateStopWordFilter = function (e) { - var n = e.reduce(function (r, i) { - return (r[i] = i), r; - }, {}); - return function (r) { - if (r && n[r.toString()] !== r.toString()) return r; - }; - }), - (t.stopWordFilter = t.generateStopWordFilter([ - "a", - "able", - "about", - "across", - "after", - "all", - "almost", - "also", - "am", - "among", - "an", - "and", - "any", - "are", - "as", - "at", - "be", - "because", - "been", - "but", - "by", - "can", - "cannot", - "could", - "dear", - "did", - "do", - "does", - "either", - "else", - "ever", - "every", - "for", - "from", - "get", - "got", - "had", - "has", - "have", - "he", - "her", - "hers", - "him", - "his", - "how", - "however", - "i", - "if", - "in", - "into", - "is", - "it", - "its", - "just", - "least", - "let", - "like", - "likely", - "may", - "me", - "might", - "most", - "must", - "my", - "neither", - "no", - "nor", - "not", - "of", - "off", - "often", - "on", - "only", - "or", - "other", - "our", - "own", - "rather", - "said", - "say", - "says", - "she", - "should", - "since", - "so", - "some", - "than", - "that", - "the", - "their", - "them", - "then", - "there", - "these", - "they", - "this", - "tis", - "to", - "too", - "twas", - "us", - "wants", - "was", - "we", - "were", - "what", - "when", - "where", - "which", - "while", - "who", - "whom", - "why", - "will", - "with", - "would", - "yet", - "you", - "your", - ])), - t.Pipeline.registerFunction(t.stopWordFilter, "stopWordFilter"); - (t.trimmer = function (e) { - return e.update(function (n) { - return n.replace(/^\W+/, "").replace(/\W+$/, ""); - }); - }), - t.Pipeline.registerFunction(t.trimmer, "trimmer"); - (t.TokenSet = function () { - (this.final = !1), - (this.edges = {}), - (this.id = t.TokenSet._nextId), - (t.TokenSet._nextId += 1); - }), - (t.TokenSet._nextId = 1), - (t.TokenSet.fromArray = function (e) { - for ( - var n = new t.TokenSet.Builder(), r = 0, i = e.length; - r < i; - r++ - ) - n.insert(e[r]); - return n.finish(), n.root; - }), - (t.TokenSet.fromClause = function (e) { - return "editDistance" in e ? - t.TokenSet.fromFuzzyString(e.term, e.editDistance) - : t.TokenSet.fromString(e.term); - }), - (t.TokenSet.fromFuzzyString = function (e, n) { - for ( - var r = new t.TokenSet(), - i = [{ node: r, editsRemaining: n, str: e }]; - i.length; - - ) { - var s = i.pop(); - if (s.str.length > 0) { - var o = s.str.charAt(0), - a; - o in s.node.edges ? - (a = s.node.edges[o]) - : ((a = new t.TokenSet()), (s.node.edges[o] = a)), - s.str.length == 1 && (a.final = !0), - i.push({ - node: a, - editsRemaining: s.editsRemaining, - str: s.str.slice(1), - }); - } - if (s.editsRemaining != 0) { - if ("*" in s.node.edges) var l = s.node.edges["*"]; - else { - var l = new t.TokenSet(); - s.node.edges["*"] = l; - } - if ( - (s.str.length == 0 && (l.final = !0), - i.push({ - node: l, - editsRemaining: s.editsRemaining - 1, - str: s.str, - }), - s.str.length > 1 && - i.push({ - node: s.node, - editsRemaining: s.editsRemaining - 1, - str: s.str.slice(1), - }), - s.str.length == 1 && (s.node.final = !0), - s.str.length >= 1) - ) { - if ("*" in s.node.edges) - var u = s.node.edges["*"]; - else { - var u = new t.TokenSet(); - s.node.edges["*"] = u; - } - s.str.length == 1 && (u.final = !0), - i.push({ - node: u, - editsRemaining: s.editsRemaining - 1, - str: s.str.slice(1), - }); - } - if (s.str.length > 1) { - var d = s.str.charAt(0), - v = s.str.charAt(1), - f; - v in s.node.edges ? - (f = s.node.edges[v]) - : ((f = new t.TokenSet()), - (s.node.edges[v] = f)), - s.str.length == 1 && (f.final = !0), - i.push({ - node: f, - editsRemaining: s.editsRemaining - 1, - str: d + s.str.slice(2), - }); - } - } - } - return r; - }), - (t.TokenSet.fromString = function (e) { - for ( - var n = new t.TokenSet(), r = n, i = 0, s = e.length; - i < s; - i++ - ) { - var o = e[i], - a = i == s - 1; - if (o == "*") (n.edges[o] = n), (n.final = a); - else { - var l = new t.TokenSet(); - (l.final = a), (n.edges[o] = l), (n = l); - } - } - return r; - }), - (t.TokenSet.prototype.toArray = function () { - for ( - var e = [], n = [{ prefix: "", node: this }]; - n.length; - - ) { - var r = n.pop(), - i = Object.keys(r.node.edges), - s = i.length; - r.node.final && (r.prefix.charAt(0), e.push(r.prefix)); - for (var o = 0; o < s; o++) { - var a = i[o]; - n.push({ - prefix: r.prefix.concat(a), - node: r.node.edges[a], - }); - } - } - return e; - }), - (t.TokenSet.prototype.toString = function () { - if (this._str) return this._str; - for ( - var e = this.final ? "1" : "0", - n = Object.keys(this.edges).sort(), - r = n.length, - i = 0; - i < r; - i++ - ) { - var s = n[i], - o = this.edges[s]; - e = e + s + o.id; - } - return e; - }), - (t.TokenSet.prototype.intersect = function (e) { - for ( - var n = new t.TokenSet(), - r = void 0, - i = [{ qNode: e, output: n, node: this }]; - i.length; - - ) { - r = i.pop(); - for ( - var s = Object.keys(r.qNode.edges), - o = s.length, - a = Object.keys(r.node.edges), - l = a.length, - u = 0; - u < o; - u++ - ) - for (var d = s[u], v = 0; v < l; v++) { - var f = a[v]; - if (f == d || d == "*") { - var b = r.node.edges[f], - g = r.qNode.edges[d], - L = b.final && g.final, - p = void 0; - f in r.output.edges ? - ((p = r.output.edges[f]), - (p.final = p.final || L)) - : ((p = new t.TokenSet()), - (p.final = L), - (r.output.edges[f] = p)), - i.push({ - qNode: g, - output: p, - node: b, - }); - } - } - } - return n; - }), - (t.TokenSet.Builder = function () { - (this.previousWord = ""), - (this.root = new t.TokenSet()), - (this.uncheckedNodes = []), - (this.minimizedNodes = {}); - }), - (t.TokenSet.Builder.prototype.insert = function (e) { - var n, - r = 0; - if (e < this.previousWord) - throw new Error("Out of order word insertion"); - for ( - var i = 0; - i < e.length && - i < this.previousWord.length && - e[i] == this.previousWord[i]; - i++ - ) - r++; - this.minimize(r), - this.uncheckedNodes.length == 0 ? - (n = this.root) - : (n = - this.uncheckedNodes[ - this.uncheckedNodes.length - 1 - ].child); - for (var i = r; i < e.length; i++) { - var s = new t.TokenSet(), - o = e[i]; - (n.edges[o] = s), - this.uncheckedNodes.push({ - parent: n, - char: o, - child: s, - }), - (n = s); - } - (n.final = !0), (this.previousWord = e); - }), - (t.TokenSet.Builder.prototype.finish = function () { - this.minimize(0); - }), - (t.TokenSet.Builder.prototype.minimize = function (e) { - for (var n = this.uncheckedNodes.length - 1; n >= e; n--) { - var r = this.uncheckedNodes[n], - i = r.child.toString(); - i in this.minimizedNodes ? - (r.parent.edges[r.char] = this.minimizedNodes[i]) - : ((r.child._str = i), - (this.minimizedNodes[i] = r.child)), - this.uncheckedNodes.pop(); - } - }); - (t.Index = function (e) { - (this.invertedIndex = e.invertedIndex), - (this.fieldVectors = e.fieldVectors), - (this.tokenSet = e.tokenSet), - (this.fields = e.fields), - (this.pipeline = e.pipeline); - }), - (t.Index.prototype.search = function (e) { - return this.query(function (n) { - var r = new t.QueryParser(e, n); - r.parse(); - }); - }), - (t.Index.prototype.query = function (e) { - for ( - var n = new t.Query(this.fields), - r = Object.create(null), - i = Object.create(null), - s = Object.create(null), - o = Object.create(null), - a = Object.create(null), - l = 0; - l < this.fields.length; - l++ - ) - i[this.fields[l]] = new t.Vector(); - e.call(n, n); - for (var l = 0; l < n.clauses.length; l++) { - var u = n.clauses[l], - d = null, - v = t.Set.empty; - u.usePipeline ? - (d = this.pipeline.runString(u.term, { - fields: u.fields, - })) - : (d = [u.term]); - for (var f = 0; f < d.length; f++) { - var b = d[f]; - u.term = b; - var g = t.TokenSet.fromClause(u), - L = this.tokenSet.intersect(g).toArray(); - if ( - L.length === 0 && - u.presence === t.Query.presence.REQUIRED - ) { - for (var p = 0; p < u.fields.length; p++) { - var m = u.fields[p]; - o[m] = t.Set.empty; - } - break; - } - for (var S = 0; S < L.length; S++) - for ( - var w = L[S], - k = this.invertedIndex[w], - _ = k._index, - p = 0; - p < u.fields.length; - p++ - ) { - var m = u.fields[p], - H = k[m], - A = Object.keys(H), - j = w + "/" + m, - $ = new t.Set(A); - if ( - (u.presence == - t.Query.presence.REQUIRED && - ((v = v.union($)), - o[m] === void 0 && - (o[m] = t.Set.complete)), - u.presence == - t.Query.presence.PROHIBITED) - ) { - a[m] === void 0 && (a[m] = t.Set.empty), - (a[m] = a[m].union($)); - continue; - } - if ( - (i[m].upsert( - _, - u.boost, - function (Qe, Ce) { - return Qe + Ce; - }, - ), - !s[j]) - ) { - for (var N = 0; N < A.length; N++) { - var q = A[N], - P = new t.FieldRef(q, m), - z = H[q], - W; - (W = r[P]) === void 0 ? - (r[P] = new t.MatchData( - w, - m, - z, - )) - : W.add(w, m, z); - } - s[j] = !0; - } - } - } - if (u.presence === t.Query.presence.REQUIRED) - for (var p = 0; p < u.fields.length; p++) { - var m = u.fields[p]; - o[m] = o[m].intersect(v); - } - } - for ( - var V = t.Set.complete, R = t.Set.empty, l = 0; - l < this.fields.length; - l++ - ) { - var m = this.fields[l]; - o[m] && (V = V.intersect(o[m])), - a[m] && (R = R.union(a[m])); - } - var c = Object.keys(r), - y = [], - I = Object.create(null); - if (n.isNegated()) { - c = Object.keys(this.fieldVectors); - for (var l = 0; l < c.length; l++) { - var P = c[l], - T = t.FieldRef.fromString(P); - r[P] = new t.MatchData(); - } - } - for (var l = 0; l < c.length; l++) { - var T = t.FieldRef.fromString(c[l]), - h = T.docRef; - if (V.contains(h) && !R.contains(h)) { - var x = this.fieldVectors[T], - O = i[T.fieldName].similarity(x), - M; - if ((M = I[h]) !== void 0) - (M.score += O), M.matchData.combine(r[T]); - else { - var E = { ref: h, score: O, matchData: r[T] }; - (I[h] = E), y.push(E); - } - } - } - return y.sort(function (Te, ke) { - return ke.score - Te.score; - }); - }), - (t.Index.prototype.toJSON = function () { - var e = Object.keys(this.invertedIndex) - .sort() - .map(function (r) { - return [r, this.invertedIndex[r]]; - }, this), - n = Object.keys(this.fieldVectors).map(function (r) { - return [r, this.fieldVectors[r].toJSON()]; - }, this); - return { - version: t.version, - fields: this.fields, - fieldVectors: n, - invertedIndex: e, - pipeline: this.pipeline.toJSON(), - }; - }), - (t.Index.load = function (e) { - var n = {}, - r = {}, - i = e.fieldVectors, - s = Object.create(null), - o = e.invertedIndex, - a = new t.TokenSet.Builder(), - l = t.Pipeline.load(e.pipeline); - e.version != t.version && - t.utils.warn( - "Version mismatch when loading serialised index. Current version of lunr '" + - t.version + - "' does not match serialized index '" + - e.version + - "'", - ); - for (var u = 0; u < i.length; u++) { - var d = i[u], - v = d[0], - f = d[1]; - r[v] = new t.Vector(f); - } - for (var u = 0; u < o.length; u++) { - var d = o[u], - b = d[0], - g = d[1]; - a.insert(b), (s[b] = g); - } - return ( - a.finish(), - (n.fields = e.fields), - (n.fieldVectors = r), - (n.invertedIndex = s), - (n.tokenSet = a.root), - (n.pipeline = l), - new t.Index(n) - ); - }); - (t.Builder = function () { - (this._ref = "id"), - (this._fields = Object.create(null)), - (this._documents = Object.create(null)), - (this.invertedIndex = Object.create(null)), - (this.fieldTermFrequencies = {}), - (this.fieldLengths = {}), - (this.tokenizer = t.tokenizer), - (this.pipeline = new t.Pipeline()), - (this.searchPipeline = new t.Pipeline()), - (this.documentCount = 0), - (this._b = 0.75), - (this._k1 = 1.2), - (this.termIndex = 0), - (this.metadataWhitelist = []); - }), - (t.Builder.prototype.ref = function (e) { - this._ref = e; - }), - (t.Builder.prototype.field = function (e, n) { - if (/\//.test(e)) - throw new RangeError( - "Field '" + e + "' contains illegal character '/'", - ); - this._fields[e] = n || {}; - }), - (t.Builder.prototype.b = function (e) { - e < 0 ? (this._b = 0) - : e > 1 ? (this._b = 1) - : (this._b = e); - }), - (t.Builder.prototype.k1 = function (e) { - this._k1 = e; - }), - (t.Builder.prototype.add = function (e, n) { - var r = e[this._ref], - i = Object.keys(this._fields); - (this._documents[r] = n || {}), (this.documentCount += 1); - for (var s = 0; s < i.length; s++) { - var o = i[s], - a = this._fields[o].extractor, - l = a ? a(e) : e[o], - u = this.tokenizer(l, { fields: [o] }), - d = this.pipeline.run(u), - v = new t.FieldRef(r, o), - f = Object.create(null); - (this.fieldTermFrequencies[v] = f), - (this.fieldLengths[v] = 0), - (this.fieldLengths[v] += d.length); - for (var b = 0; b < d.length; b++) { - var g = d[b]; - if ( - (f[g] == null && (f[g] = 0), - (f[g] += 1), - this.invertedIndex[g] == null) - ) { - var L = Object.create(null); - (L._index = this.termIndex), - (this.termIndex += 1); - for (var p = 0; p < i.length; p++) - L[i[p]] = Object.create(null); - this.invertedIndex[g] = L; - } - this.invertedIndex[g][o][r] == null && - (this.invertedIndex[g][o][r] = - Object.create(null)); - for ( - var m = 0; - m < this.metadataWhitelist.length; - m++ - ) { - var S = this.metadataWhitelist[m], - w = g.metadata[S]; - this.invertedIndex[g][o][r][S] == null && - (this.invertedIndex[g][o][r][S] = []), - this.invertedIndex[g][o][r][S].push(w); - } - } - } - }), - (t.Builder.prototype.calculateAverageFieldLengths = - function () { - for ( - var e = Object.keys(this.fieldLengths), - n = e.length, - r = {}, - i = {}, - s = 0; - s < n; - s++ - ) { - var o = t.FieldRef.fromString(e[s]), - a = o.fieldName; - i[a] || (i[a] = 0), - (i[a] += 1), - r[a] || (r[a] = 0), - (r[a] += this.fieldLengths[o]); - } - for ( - var l = Object.keys(this._fields), s = 0; - s < l.length; - s++ - ) { - var u = l[s]; - r[u] = r[u] / i[u]; - } - this.averageFieldLength = r; - }), - (t.Builder.prototype.createFieldVectors = function () { - for ( - var e = {}, - n = Object.keys(this.fieldTermFrequencies), - r = n.length, - i = Object.create(null), - s = 0; - s < r; - s++ - ) { - for ( - var o = t.FieldRef.fromString(n[s]), - a = o.fieldName, - l = this.fieldLengths[o], - u = new t.Vector(), - d = this.fieldTermFrequencies[o], - v = Object.keys(d), - f = v.length, - b = this._fields[a].boost || 1, - g = this._documents[o.docRef].boost || 1, - L = 0; - L < f; - L++ - ) { - var p = v[L], - m = d[p], - S = this.invertedIndex[p]._index, - w, - k, - _; - i[p] === void 0 ? - ((w = t.idf( - this.invertedIndex[p], - this.documentCount, - )), - (i[p] = w)) - : (w = i[p]), - (k = - (w * ((this._k1 + 1) * m)) / - (this._k1 * - (1 - - this._b + - this._b * - (l / - this.averageFieldLength[ - a - ])) + - m)), - (k *= b), - (k *= g), - (_ = Math.round(k * 1e3) / 1e3), - u.insert(S, _); - } - e[o] = u; - } - this.fieldVectors = e; - }), - (t.Builder.prototype.createTokenSet = function () { - this.tokenSet = t.TokenSet.fromArray( - Object.keys(this.invertedIndex).sort(), - ); - }), - (t.Builder.prototype.build = function () { - return ( - this.calculateAverageFieldLengths(), - this.createFieldVectors(), - this.createTokenSet(), - new t.Index({ - invertedIndex: this.invertedIndex, - fieldVectors: this.fieldVectors, - tokenSet: this.tokenSet, - fields: Object.keys(this._fields), - pipeline: this.searchPipeline, - }) - ); - }), - (t.Builder.prototype.use = function (e) { - var n = Array.prototype.slice.call(arguments, 1); - n.unshift(this), e.apply(this, n); - }), - (t.MatchData = function (e, n, r) { - for ( - var i = Object.create(null), - s = Object.keys(r || {}), - o = 0; - o < s.length; - o++ - ) { - var a = s[o]; - i[a] = r[a].slice(); - } - (this.metadata = Object.create(null)), - e !== void 0 && - ((this.metadata[e] = Object.create(null)), - (this.metadata[e][n] = i)); - }), - (t.MatchData.prototype.combine = function (e) { - for ( - var n = Object.keys(e.metadata), r = 0; - r < n.length; - r++ - ) { - var i = n[r], - s = Object.keys(e.metadata[i]); - this.metadata[i] == null && - (this.metadata[i] = Object.create(null)); - for (var o = 0; o < s.length; o++) { - var a = s[o], - l = Object.keys(e.metadata[i][a]); - this.metadata[i][a] == null && - (this.metadata[i][a] = Object.create(null)); - for (var u = 0; u < l.length; u++) { - var d = l[u]; - this.metadata[i][a][d] == null ? - (this.metadata[i][a][d] = - e.metadata[i][a][d]) - : (this.metadata[i][a][d] = this.metadata[i][ - a - ][d].concat(e.metadata[i][a][d])); - } - } - } - }), - (t.MatchData.prototype.add = function (e, n, r) { - if (!(e in this.metadata)) { - (this.metadata[e] = Object.create(null)), - (this.metadata[e][n] = r); - return; - } - if (!(n in this.metadata[e])) { - this.metadata[e][n] = r; - return; - } - for (var i = Object.keys(r), s = 0; s < i.length; s++) { - var o = i[s]; - o in this.metadata[e][n] ? - (this.metadata[e][n][o] = this.metadata[e][n][ - o - ].concat(r[o])) - : (this.metadata[e][n][o] = r[o]); - } - }), - (t.Query = function (e) { - (this.clauses = []), (this.allFields = e); - }), - (t.Query.wildcard = new String("*")), - (t.Query.wildcard.NONE = 0), - (t.Query.wildcard.LEADING = 1), - (t.Query.wildcard.TRAILING = 2), - (t.Query.presence = { - OPTIONAL: 1, - REQUIRED: 2, - PROHIBITED: 3, - }), - (t.Query.prototype.clause = function (e) { - return ( - "fields" in e || (e.fields = this.allFields), - "boost" in e || (e.boost = 1), - "usePipeline" in e || (e.usePipeline = !0), - "wildcard" in e || (e.wildcard = t.Query.wildcard.NONE), - e.wildcard & t.Query.wildcard.LEADING && - e.term.charAt(0) != t.Query.wildcard && - (e.term = "*" + e.term), - e.wildcard & t.Query.wildcard.TRAILING && - e.term.slice(-1) != t.Query.wildcard && - (e.term = "" + e.term + "*"), - "presence" in e || - (e.presence = t.Query.presence.OPTIONAL), - this.clauses.push(e), - this - ); - }), - (t.Query.prototype.isNegated = function () { - for (var e = 0; e < this.clauses.length; e++) - if ( - this.clauses[e].presence != - t.Query.presence.PROHIBITED - ) - return !1; - return !0; - }), - (t.Query.prototype.term = function (e, n) { - if (Array.isArray(e)) - return ( - e.forEach(function (i) { - this.term(i, t.utils.clone(n)); - }, this), - this - ); - var r = n || {}; - return (r.term = e.toString()), this.clause(r), this; - }), - (t.QueryParseError = function (e, n, r) { - (this.name = "QueryParseError"), - (this.message = e), - (this.start = n), - (this.end = r); - }), - (t.QueryParseError.prototype = new Error()), - (t.QueryLexer = function (e) { - (this.lexemes = []), - (this.str = e), - (this.length = e.length), - (this.pos = 0), - (this.start = 0), - (this.escapeCharPositions = []); - }), - (t.QueryLexer.prototype.run = function () { - for (var e = t.QueryLexer.lexText; e; ) e = e(this); - }), - (t.QueryLexer.prototype.sliceString = function () { - for ( - var e = [], n = this.start, r = this.pos, i = 0; - i < this.escapeCharPositions.length; - i++ - ) - (r = this.escapeCharPositions[i]), - e.push(this.str.slice(n, r)), - (n = r + 1); - return ( - e.push(this.str.slice(n, this.pos)), - (this.escapeCharPositions.length = 0), - e.join("") - ); - }), - (t.QueryLexer.prototype.emit = function (e) { - this.lexemes.push({ - type: e, - str: this.sliceString(), - start: this.start, - end: this.pos, - }), - (this.start = this.pos); - }), - (t.QueryLexer.prototype.escapeCharacter = function () { - this.escapeCharPositions.push(this.pos - 1), - (this.pos += 1); - }), - (t.QueryLexer.prototype.next = function () { - if (this.pos >= this.length) return t.QueryLexer.EOS; - var e = this.str.charAt(this.pos); - return (this.pos += 1), e; - }), - (t.QueryLexer.prototype.width = function () { - return this.pos - this.start; - }), - (t.QueryLexer.prototype.ignore = function () { - this.start == this.pos && (this.pos += 1), - (this.start = this.pos); - }), - (t.QueryLexer.prototype.backup = function () { - this.pos -= 1; - }), - (t.QueryLexer.prototype.acceptDigitRun = function () { - var e, n; - do (e = this.next()), (n = e.charCodeAt(0)); - while (n > 47 && n < 58); - e != t.QueryLexer.EOS && this.backup(); - }), - (t.QueryLexer.prototype.more = function () { - return this.pos < this.length; - }), - (t.QueryLexer.EOS = "EOS"), - (t.QueryLexer.FIELD = "FIELD"), - (t.QueryLexer.TERM = "TERM"), - (t.QueryLexer.EDIT_DISTANCE = "EDIT_DISTANCE"), - (t.QueryLexer.BOOST = "BOOST"), - (t.QueryLexer.PRESENCE = "PRESENCE"), - (t.QueryLexer.lexField = function (e) { - return ( - e.backup(), - e.emit(t.QueryLexer.FIELD), - e.ignore(), - t.QueryLexer.lexText - ); - }), - (t.QueryLexer.lexTerm = function (e) { - if ( - (e.width() > 1 && - (e.backup(), e.emit(t.QueryLexer.TERM)), - e.ignore(), - e.more()) - ) - return t.QueryLexer.lexText; - }), - (t.QueryLexer.lexEditDistance = function (e) { - return ( - e.ignore(), - e.acceptDigitRun(), - e.emit(t.QueryLexer.EDIT_DISTANCE), - t.QueryLexer.lexText - ); - }), - (t.QueryLexer.lexBoost = function (e) { - return ( - e.ignore(), - e.acceptDigitRun(), - e.emit(t.QueryLexer.BOOST), - t.QueryLexer.lexText - ); - }), - (t.QueryLexer.lexEOS = function (e) { - e.width() > 0 && e.emit(t.QueryLexer.TERM); - }), - (t.QueryLexer.termSeparator = t.tokenizer.separator), - (t.QueryLexer.lexText = function (e) { - for (;;) { - var n = e.next(); - if (n == t.QueryLexer.EOS) return t.QueryLexer.lexEOS; - if (n.charCodeAt(0) == 92) { - e.escapeCharacter(); - continue; - } - if (n == ":") return t.QueryLexer.lexField; - if (n == "~") - return ( - e.backup(), - e.width() > 0 && e.emit(t.QueryLexer.TERM), - t.QueryLexer.lexEditDistance - ); - if (n == "^") - return ( - e.backup(), - e.width() > 0 && e.emit(t.QueryLexer.TERM), - t.QueryLexer.lexBoost - ); - if ( - (n == "+" && e.width() === 1) || - (n == "-" && e.width() === 1) - ) - return ( - e.emit(t.QueryLexer.PRESENCE), - t.QueryLexer.lexText - ); - if (n.match(t.QueryLexer.termSeparator)) - return t.QueryLexer.lexTerm; - } - }), - (t.QueryParser = function (e, n) { - (this.lexer = new t.QueryLexer(e)), - (this.query = n), - (this.currentClause = {}), - (this.lexemeIdx = 0); - }), - (t.QueryParser.prototype.parse = function () { - this.lexer.run(), (this.lexemes = this.lexer.lexemes); - for (var e = t.QueryParser.parseClause; e; ) e = e(this); - return this.query; - }), - (t.QueryParser.prototype.peekLexeme = function () { - return this.lexemes[this.lexemeIdx]; - }), - (t.QueryParser.prototype.consumeLexeme = function () { - var e = this.peekLexeme(); - return (this.lexemeIdx += 1), e; - }), - (t.QueryParser.prototype.nextClause = function () { - var e = this.currentClause; - this.query.clause(e), (this.currentClause = {}); - }), - (t.QueryParser.parseClause = function (e) { - var n = e.peekLexeme(); - if (n != null) - switch (n.type) { - case t.QueryLexer.PRESENCE: - return t.QueryParser.parsePresence; - case t.QueryLexer.FIELD: - return t.QueryParser.parseField; - case t.QueryLexer.TERM: - return t.QueryParser.parseTerm; - default: - var r = - "expected either a field or a term, found " + - n.type; - throw ( - (n.str.length >= 1 && - (r += " with value '" + n.str + "'"), - new t.QueryParseError(r, n.start, n.end)) - ); - } - }), - (t.QueryParser.parsePresence = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - switch (n.str) { - case "-": - e.currentClause.presence = - t.Query.presence.PROHIBITED; - break; - case "+": - e.currentClause.presence = - t.Query.presence.REQUIRED; - break; - default: - var r = - "unrecognised presence operator'" + - n.str + - "'"; - throw new t.QueryParseError(r, n.start, n.end); - } - var i = e.peekLexeme(); - if (i == null) { - var r = "expecting term or field, found nothing"; - throw new t.QueryParseError(r, n.start, n.end); - } - switch (i.type) { - case t.QueryLexer.FIELD: - return t.QueryParser.parseField; - case t.QueryLexer.TERM: - return t.QueryParser.parseTerm; - default: - var r = - "expecting term or field, found '" + - i.type + - "'"; - throw new t.QueryParseError(r, i.start, i.end); - } - } - }), - (t.QueryParser.parseField = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - if (e.query.allFields.indexOf(n.str) == -1) { - var r = e.query.allFields - .map(function (o) { - return "'" + o + "'"; - }) - .join(", "), - i = - "unrecognised field '" + - n.str + - "', possible fields: " + - r; - throw new t.QueryParseError(i, n.start, n.end); - } - e.currentClause.fields = [n.str]; - var s = e.peekLexeme(); - if (s == null) { - var i = "expecting term, found nothing"; - throw new t.QueryParseError(i, n.start, n.end); - } - switch (s.type) { - case t.QueryLexer.TERM: - return t.QueryParser.parseTerm; - default: - var i = - "expecting term, found '" + s.type + "'"; - throw new t.QueryParseError(i, s.start, s.end); - } - } - }), - (t.QueryParser.parseTerm = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - (e.currentClause.term = n.str.toLowerCase()), - n.str.indexOf("*") != -1 && - (e.currentClause.usePipeline = !1); - var r = e.peekLexeme(); - if (r == null) { - e.nextClause(); - return; - } - switch (r.type) { - case t.QueryLexer.TERM: - return e.nextClause(), t.QueryParser.parseTerm; - case t.QueryLexer.FIELD: - return e.nextClause(), t.QueryParser.parseField; - case t.QueryLexer.EDIT_DISTANCE: - return t.QueryParser.parseEditDistance; - case t.QueryLexer.BOOST: - return t.QueryParser.parseBoost; - case t.QueryLexer.PRESENCE: - return ( - e.nextClause(), t.QueryParser.parsePresence - ); - default: - var i = - "Unexpected lexeme type '" + r.type + "'"; - throw new t.QueryParseError(i, r.start, r.end); - } - } - }), - (t.QueryParser.parseEditDistance = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - var r = parseInt(n.str, 10); - if (isNaN(r)) { - var i = "edit distance must be numeric"; - throw new t.QueryParseError(i, n.start, n.end); - } - e.currentClause.editDistance = r; - var s = e.peekLexeme(); - if (s == null) { - e.nextClause(); - return; - } - switch (s.type) { - case t.QueryLexer.TERM: - return e.nextClause(), t.QueryParser.parseTerm; - case t.QueryLexer.FIELD: - return e.nextClause(), t.QueryParser.parseField; - case t.QueryLexer.EDIT_DISTANCE: - return t.QueryParser.parseEditDistance; - case t.QueryLexer.BOOST: - return t.QueryParser.parseBoost; - case t.QueryLexer.PRESENCE: - return ( - e.nextClause(), t.QueryParser.parsePresence - ); - default: - var i = - "Unexpected lexeme type '" + s.type + "'"; - throw new t.QueryParseError(i, s.start, s.end); - } - } - }), - (t.QueryParser.parseBoost = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - var r = parseInt(n.str, 10); - if (isNaN(r)) { - var i = "boost must be numeric"; - throw new t.QueryParseError(i, n.start, n.end); - } - e.currentClause.boost = r; - var s = e.peekLexeme(); - if (s == null) { - e.nextClause(); - return; - } - switch (s.type) { - case t.QueryLexer.TERM: - return e.nextClause(), t.QueryParser.parseTerm; - case t.QueryLexer.FIELD: - return e.nextClause(), t.QueryParser.parseField; - case t.QueryLexer.EDIT_DISTANCE: - return t.QueryParser.parseEditDistance; - case t.QueryLexer.BOOST: - return t.QueryParser.parseBoost; - case t.QueryLexer.PRESENCE: - return ( - e.nextClause(), t.QueryParser.parsePresence - ); - default: - var i = - "Unexpected lexeme type '" + s.type + "'"; - throw new t.QueryParseError(i, s.start, s.end); - } - } - }), - (function (e, n) { - typeof define == "function" && define.amd ? define(n) - : typeof se == "object" ? (oe.exports = n()) - : (e.lunr = n()); - })(this, function () { - return t; - }); - })(); - }); - var re = []; - function G(t, e) { - re.push({ selector: e, constructor: t }); - } - var U = class { - constructor() { - this.alwaysVisibleMember = null; - this.createComponents(document.body), - this.ensureActivePageVisible(), - this.ensureFocusedElementVisible(), - this.listenForCodeCopies(), - window.addEventListener("hashchange", () => - this.ensureFocusedElementVisible(), - ); - } - createComponents(e) { - re.forEach((n) => { - e.querySelectorAll(n.selector).forEach((r) => { - r.dataset.hasInstance || - (new n.constructor({ el: r, app: this }), - (r.dataset.hasInstance = String(!0))); - }); - }); - } - filterChanged() { - this.ensureFocusedElementVisible(); - } - ensureActivePageVisible() { - let e = document.querySelector(".tsd-navigation .current"), - n = e?.parentElement; - for (; n && !n.classList.contains(".tsd-navigation"); ) - n instanceof HTMLDetailsElement && (n.open = !0), - (n = n.parentElement); - if (e) { - let r = - e.getBoundingClientRect().top - - document.documentElement.clientHeight / 4; - document.querySelector(".site-menu").scrollTop = r; - } - } - ensureFocusedElementVisible() { - if ( - (this.alwaysVisibleMember && - (this.alwaysVisibleMember.classList.remove( - "always-visible", - ), - this.alwaysVisibleMember.firstElementChild.remove(), - (this.alwaysVisibleMember = null)), - !location.hash) - ) - return; - let e = document.getElementById(location.hash.substring(1)); - if (!e) return; - let n = e.parentElement; - for (; n && n.tagName !== "SECTION"; ) n = n.parentElement; - if (n && n.offsetParent == null) { - (this.alwaysVisibleMember = n), - n.classList.add("always-visible"); - let r = document.createElement("p"); - r.classList.add("warning"), - (r.textContent = - "This member is normally hidden due to your filter settings."), - n.prepend(r); - } - } - listenForCodeCopies() { - document.querySelectorAll("pre > button").forEach((e) => { - let n; - e.addEventListener("click", () => { - e.previousElementSibling instanceof HTMLElement && - navigator.clipboard.writeText( - e.previousElementSibling.innerText.trim(), - ), - (e.textContent = "Copied!"), - e.classList.add("visible"), - clearTimeout(n), - (n = setTimeout(() => { - e.classList.remove("visible"), - (n = setTimeout(() => { - e.textContent = "Copy"; - }, 100)); - }, 1e3)); - }); - }); - } - }; - var ie = (t, e = 100) => { - let n; - return () => { - clearTimeout(n), (n = setTimeout(() => t(), e)); - }; - }; - var de = De(ae()); - async function le(t, e) { - if (!window.searchData) return; - let n = await fetch(window.searchData), - r = new Blob([await n.arrayBuffer()]) - .stream() - .pipeThrough(new DecompressionStream("gzip")), - i = await new Response(r).json(); - (t.data = i), - (t.index = de.Index.load(i.index)), - e.classList.remove("loading"), - e.classList.add("ready"); - } - function he() { - let t = document.getElementById("tsd-search"); - if (!t) return; - let e = { base: t.dataset.base + "/" }, - n = document.getElementById("tsd-search-script"); - t.classList.add("loading"), - n && - (n.addEventListener("error", () => { - t.classList.remove("loading"), t.classList.add("failure"); - }), - n.addEventListener("load", () => { - le(e, t); - }), - le(e, t)); - let r = document.querySelector("#tsd-search input"), - i = document.querySelector("#tsd-search .results"); - if (!r || !i) - throw new Error( - "The input field or the result list wrapper was not found", - ); - let s = !1; - i.addEventListener("mousedown", () => (s = !0)), - i.addEventListener("mouseup", () => { - (s = !1), t.classList.remove("has-focus"); - }), - r.addEventListener("focus", () => t.classList.add("has-focus")), - r.addEventListener("blur", () => { - s || ((s = !1), t.classList.remove("has-focus")); - }), - Ae(t, i, r, e); - } - function Ae(t, e, n, r) { - n.addEventListener( - "input", - ie(() => { - Ne(t, e, n, r); - }, 200), - ); - let i = !1; - n.addEventListener("keydown", (s) => { - (i = !0), - s.key == "Enter" ? Ve(e, n) - : s.key == "Escape" ? n.blur() - : s.key == "ArrowUp" ? ue(e, -1) - : s.key === "ArrowDown" ? ue(e, 1) - : (i = !1); - }), - n.addEventListener("keypress", (s) => { - i && s.preventDefault(); - }), - document.body.addEventListener("keydown", (s) => { - s.altKey || - s.ctrlKey || - s.metaKey || - (!n.matches(":focus") && - s.key === "/" && - (n.focus(), s.preventDefault())); - }); - } - function Ne(t, e, n, r) { - if (!r.index || !r.data) return; - e.textContent = ""; - let i = n.value.trim(), - s; - if (i) { - let o = i - .split(" ") - .map((a) => (a.length ? `*${a}*` : "")) - .join(" "); - s = r.index.search(o); - } else s = []; - for (let o = 0; o < s.length; o++) { - let a = s[o], - l = r.data.rows[Number(a.ref)], - u = 1; - l.name.toLowerCase().startsWith(i.toLowerCase()) && - (u *= 1 + 1 / (1 + Math.abs(l.name.length - i.length))), - (a.score *= u); - } - if (s.length === 0) { - let o = document.createElement("li"); - o.classList.add("no-results"); - let a = document.createElement("span"); - (a.textContent = "No results found"), - o.appendChild(a), - e.appendChild(o); - } - s.sort((o, a) => a.score - o.score); - for (let o = 0, a = Math.min(10, s.length); o < a; o++) { - let l = r.data.rows[Number(s[o].ref)], - u = ``, - d = ce(l.name, i); - globalThis.DEBUG_SEARCH_WEIGHTS && - (d += ` (score: ${s[o].score.toFixed(2)})`), - l.parent && - (d = ` - ${ce(l.parent, i)}.${d}`); - let v = document.createElement("li"); - v.classList.value = l.classes ?? ""; - let f = document.createElement("a"); - (f.href = r.base + l.url), - (f.innerHTML = u + d), - v.append(f), - e.appendChild(v); - } - } - function ue(t, e) { - let n = t.querySelector(".current"); - if (!n) - (n = t.querySelector(e == 1 ? "li:first-child" : "li:last-child")), - n && n.classList.add("current"); - else { - let r = n; - if (e === 1) - do r = r.nextElementSibling ?? void 0; - while (r instanceof HTMLElement && r.offsetParent == null); - else - do r = r.previousElementSibling ?? void 0; - while (r instanceof HTMLElement && r.offsetParent == null); - r && (n.classList.remove("current"), r.classList.add("current")); - } - } - function Ve(t, e) { - let n = t.querySelector(".current"); - if ((n || (n = t.querySelector("li:first-child")), n)) { - let r = n.querySelector("a"); - r && (window.location.href = r.href), e.blur(); - } - } - function ce(t, e) { - if (e === "") return t; - let n = t.toLocaleLowerCase(), - r = e.toLocaleLowerCase(), - i = [], - s = 0, - o = n.indexOf(r); - for (; o != -1; ) - i.push( - K(t.substring(s, o)), - `${K(t.substring(o, o + r.length))}`, - ), - (s = o + r.length), - (o = n.indexOf(r, s)); - return i.push(K(t.substring(s))), i.join(""); - } - var Be = { - "&": "&", - "<": "<", - ">": ">", - "'": "'", - '"': """, - }; - function K(t) { - return t.replace(/[&<>"'"]/g, (e) => Be[e]); - } - var C = class { - constructor(e) { - (this.el = e.el), (this.app = e.app); - } - }; - var F = "mousedown", - pe = "mousemove", - B = "mouseup", - J = { x: 0, y: 0 }, - fe = !1, - ee = !1, - He = !1, - D = !1, - me = - /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( - navigator.userAgent, - ); - document.documentElement.classList.add(me ? "is-mobile" : "not-mobile"); - me && - "ontouchstart" in document.documentElement && - ((He = !0), (F = "touchstart"), (pe = "touchmove"), (B = "touchend")); - document.addEventListener(F, (t) => { - (ee = !0), (D = !1); - let e = F == "touchstart" ? t.targetTouches[0] : t; - (J.y = e.pageY || 0), (J.x = e.pageX || 0); - }); - document.addEventListener(pe, (t) => { - if (ee && !D) { - let e = F == "touchstart" ? t.targetTouches[0] : t, - n = J.x - (e.pageX || 0), - r = J.y - (e.pageY || 0); - D = Math.sqrt(n * n + r * r) > 10; - } - }); - document.addEventListener(B, () => { - ee = !1; - }); - document.addEventListener("click", (t) => { - fe && (t.preventDefault(), t.stopImmediatePropagation(), (fe = !1)); - }); - var X = class extends C { - constructor(e) { - super(e), - (this.className = this.el.dataset.toggle || ""), - this.el.addEventListener(B, (n) => this.onPointerUp(n)), - this.el.addEventListener("click", (n) => n.preventDefault()), - document.addEventListener(F, (n) => - this.onDocumentPointerDown(n), - ), - document.addEventListener(B, (n) => - this.onDocumentPointerUp(n), - ); - } - setActive(e) { - if (this.active == e) return; - (this.active = e), - document.documentElement.classList.toggle( - "has-" + this.className, - e, - ), - this.el.classList.toggle("active", e); - let n = (this.active ? "to-has-" : "from-has-") + this.className; - document.documentElement.classList.add(n), - setTimeout( - () => document.documentElement.classList.remove(n), - 500, - ); - } - onPointerUp(e) { - D || (this.setActive(!0), e.preventDefault()); - } - onDocumentPointerDown(e) { - if (this.active) { - if (e.target.closest(".col-sidebar, .tsd-filter-group")) return; - this.setActive(!1); - } - } - onDocumentPointerUp(e) { - if (!D && this.active && e.target.closest(".col-sidebar")) { - let n = e.target.closest("a"); - if (n) { - let r = window.location.href; - r.indexOf("#") != -1 && - (r = r.substring(0, r.indexOf("#"))), - n.href.substring(0, r.length) == r && - setTimeout(() => this.setActive(!1), 250); - } - } - } - }; - var te; - try { - te = localStorage; - } catch { - te = { - getItem() { - return null; - }, - setItem() {}, - }; - } - var Q = te; - var ve = document.head.appendChild(document.createElement("style")); - ve.dataset.for = "filters"; - var Y = class extends C { - constructor(e) { - super(e), - (this.key = `filter-${this.el.name}`), - (this.value = this.el.checked), - this.el.addEventListener("change", () => { - this.setLocalStorage(this.el.checked); - }), - this.setLocalStorage(this.fromLocalStorage()), - (ve.innerHTML += `html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`), - this.handleValueChange(); - } - fromLocalStorage() { - let e = Q.getItem(this.key); - return e ? e === "true" : this.el.checked; - } - setLocalStorage(e) { - Q.setItem(this.key, e.toString()), - (this.value = e), - this.handleValueChange(); - } - handleValueChange() { - (this.el.checked = this.value), - document.documentElement.classList.toggle(this.key, this.value), - this.app.filterChanged(), - document.querySelectorAll(".tsd-index-section").forEach((e) => { - e.style.display = "block"; - let n = Array.from( - e.querySelectorAll(".tsd-index-link"), - ).every((r) => r.offsetParent == null); - e.style.display = n ? "none" : "block"; - }); - } - }; - var Z = class extends C { - constructor(e) { - super(e), - (this.summary = this.el.querySelector( - ".tsd-accordion-summary", - )), - (this.icon = this.summary.querySelector("svg")), - (this.key = `tsd-accordion-${this.summary.dataset.key ?? this.summary.textContent.trim().replace(/\s+/g, "-").toLowerCase()}`); - let n = Q.getItem(this.key); - (this.el.open = n ? n === "true" : this.el.open), - this.el.addEventListener("toggle", () => this.update()); - let r = this.summary.querySelector("a"); - r && - r.addEventListener("click", () => { - location.assign(r.href); - }), - this.update(); - } - update() { - (this.icon.style.transform = `rotate(${this.el.open ? 0 : -90}deg)`), - Q.setItem(this.key, this.el.open.toString()); - } - }; - function ge(t) { - let e = Q.getItem("tsd-theme") || "os"; - (t.value = e), - ye(e), - t.addEventListener("change", () => { - Q.setItem("tsd-theme", t.value), ye(t.value); - }); - } - function ye(t) { - document.documentElement.dataset.theme = t; - } - var Le; - function be() { - let t = document.getElementById("tsd-nav-script"); - t && (t.addEventListener("load", xe), xe()); - } - async function xe() { - let t = document.getElementById("tsd-nav-container"); - if (!t || !window.navigationData) return; - let n = await (await fetch(window.navigationData)).arrayBuffer(), - r = new Blob([n]) - .stream() - .pipeThrough(new DecompressionStream("gzip")), - i = await new Response(r).json(); - (Le = t.dataset.base + "/"), (t.innerHTML = ""); - for (let s of i) we(s, t, []); - window.app.createComponents(t), window.app.ensureActivePageVisible(); - } - function we(t, e, n) { - let r = e.appendChild(document.createElement("li")); - if (t.children) { - let i = [...n, t.text], - s = r.appendChild(document.createElement("details")); - (s.className = - t.class ? - `${t.class} tsd-index-accordion` - : "tsd-index-accordion"), - (s.dataset.key = i.join("$")); - let o = s.appendChild(document.createElement("summary")); - (o.className = "tsd-accordion-summary"), - (o.innerHTML = - ''), - Ee(t, o); - let a = s.appendChild(document.createElement("div")); - a.className = "tsd-accordion-details"; - let l = a.appendChild(document.createElement("ul")); - l.className = "tsd-nested-navigation"; - for (let u of t.children) we(u, l, i); - } else Ee(t, r, t.class); - } - function Ee(t, e, n) { - if (t.path) { - let r = e.appendChild(document.createElement("a")); - (r.href = Le + t.path), - n && (r.className = n), - location.href === r.href && r.classList.add("current"), - t.kind && - (r.innerHTML = ``), - (r.appendChild(document.createElement("span")).textContent = - t.text); - } else - e.appendChild(document.createElement("span")).textContent = t.text; - } - G(X, "a[data-toggle]"); - G(Z, ".tsd-index-accordion"); - G(Y, ".tsd-filter-item input[type=checkbox]"); - var Se = document.getElementById("tsd-theme"); - Se && ge(Se); - var je = new U(); - Object.defineProperty(window, "app", { value: je }); - he(); - be(); -})(); -/*! Bundled license information: - -lunr/lunr.js: - (** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - *) - (*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - *) - (*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - *) -*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js deleted file mode 100644 index fc6162ed..00000000 --- a/docs/assets/navigation.js +++ /dev/null @@ -1,2 +0,0 @@ -window.navigationData = - "data:application/octet-stream;base64,H4sIAAAAAAAAE6WYXU/bMBSG/0uvKWhsQxN3pe2gEtAq6TRpCFlOYqhF4oTEKaBp/312Pm3HdtxyVUV+z3Ne28cncR/+Tih6p5PLSRhjROjkZBLucBzliEwuH7pBmGE2kkG6Yw9JGpUxKs7qCMDGTnc0iZngBZNocnmuZ2RpQXvIU0lCilMiYbhEZl18+/f470TwkVl8ZE4+ZiJDYyM7nakkxUWQRh9GG3zQyceVRBkYqThXA5hiJdyhoghSmEfTt5x5R7nRWC8FjdTJ5rwL+60mGHjWpBiEW6eTQEyME+CDimUhlMB9APNpgkhpJNQawDVOc7+v9HcScjBpEdoHWKeZwWdmKkJB+Wz0WmlApXHyupBpA5sibzGkKg73mKIpInujPS4ATKBuiAgpUL6v6sXcUpybTc3iXcK54byhoEjDF0RvIIlifeEqWDXEukY0zKaYUJQ/wRBZHTMl6JRO3jeQu9h+ZAKYVVViwfYhcoYfguWrlG5LQlDcU8MYFoXNbhcjY7+ci+DtfOO3u+0K7mKG4Ee5yaVJwvbDUC79qH4DmvH2163p1dorWCDjhFSuEGNbqUZ2nadldii7CrLBNzCHcYzio5Logm3JvDRI6Vxd/ZEkYpAN7qPXkvUZDI+biz7cYV/6DF2hju2KUlHfL8Q1QiywwEGMDgH3UUO2eDDQOwpLmmre+Qq4FR5S/MsB3LDmHVwJ1B1r4VWf7tHU9exy8UEHeMb6eFxSdMcCXUtUSqIB2KqnlXsphfRzGSWELefRc3Ock4diSPH++DXUAFzyfWINtQh7Dzs+12E5tqlPYe7cLzWpZILD6cowsnyYSJkqqdPJ4pu5kcG2KdTgLmjsVa+/ADRg+wUg528WwzcCABQVtADgrFKd8idjmkoCupDmmT+Zk2cQm7twDeASpxVekQizl4NxfQVcI7V+EqQF5t+6LrhWa+P9WXprsLpfrOZLv2fuYY5hoJ+zGCGTv56r4M3aX21X6/sDyG3IAC3duKxHoUE6nwF7/Ys0Y9Er1qbsxLAL2mgNcS1otO5W71S42XEHFwPtE2gPns14fexcDHsyTeu0pnlDptbatL7SuTgEtdTdqK+gzXZbtBBm9168ljAfq9la5OTXV3haqw3P12BVf5TdNIsRe5XGvU4t912R12nNF10fRy4kLjNDnhGt3rg3CEaYaP9c0TCVKM1fCOIqlhTHxVlJMDWvZaUBlcbtr6DltbdcWlqoCKzFlr7889ftLfDW29lIXxahUoyF7c0Wq5krtBZbaKyik2x8s0SmGKLdqcf/aCO7niIXAAA="; diff --git a/docs/assets/search.js b/docs/assets/search.js deleted file mode 100644 index 0c39e3ee..00000000 --- a/docs/assets/search.js +++ /dev/null @@ -1,2 +0,0 @@ -window.searchData = - "data:application/octet-stream;base64,H4sIAAAAAAAAE81dXXMbN7L9K7fkV1khMN95U2QlVq1jeyUlW3tdKRYljiSuKZJLDu34pvLf7wAzQ3b3dA/nA7T9kkgmuucAB+huHEDDv07Wy8+bkx8//HXycbaYnvyoT08Wk+f05MeT+/ksXWQ/TFazk9OT7Xqe/9Pzcrqdp5sfio/G+UdnT9nzPP/8fj7ZbNLc0cnJ36eVr9DfOVstN9nOzcN2cZ/NlgvkyLRgvJ2erCbrvA0GtH8Gg3cl4121xXsOvDBwV2fnrC8O7aoJ7d1y+kWCaz5ri/cn6KcG2Hr6iXdXh2wxNWC+f0o3m7vlZD19+Xmd9y9dSz3YtxyXLdv252Jn+S/yiFrnmIfUrFv1m+lXwyg8T2YLqd/ms8ae1rwtJp/uJuuXz+liKzktmoxNk7aj+Naa/Aqd1oYPut23bzVgEHRD31aTx7wX0/Ru+yj1zTYZ2yZt+/YK+at1C3p8Jfit9whCbejRp1mWvkwXn6TumM/H+ect58AmXX9K1yawsdG2+NgEyS4R93N6t1nef0yz15PFdM4uIOKYWjSPGAF9oF/Z/erlbJGl64fJfdrUw7zheNewsa/x7jnvJwb17ZfV3nM+JZ8b/O4tWncS92APQ4X75fbu9vXV2196gnixN+8GBjjicV28ubp8ezt+ffnmzbu+4IgPxwhvLq9/v7wehpD4cIzwfc7M+Oby7au+8KCDY2C7vrx5/+7tzeUgfMCJY4z//O3y+t/j38+v++KDDo6CbegA1rw4Rnn19ud3178OGULkwfkKvh0CbW/uGNftb9dvxz/9e3z+9pc3vamlThxjfHV99fvl+PbqzeVNX4TYhWN85xe3V+/ejm9+u7i4vOkNseblOCh/Pr96MxBi6eI4LJ+//cdAkgsPjtFd3ty+e98XWGXsBJOOwa42u90uFul8B6x8ggxtZzK4sAsUqPvzcjlbb++z5bovlBfYR8eh2o8EGKmR9iHCRXqfpdMh+HYeXKObTrLJT9uHh7T/8CEXrvFNptN1vvnvDW5v7xrZrD+hs2MwWewQe2Pame9xZZvpy9nm5Wo9+zTJUjcolwuzh908TT6mvaFiH87xhkHg7cPveJzB7esArGc7V32pP4M9B/v6kb+PzLPN+X02+9QfMXDgYIoibI9pdjXNncweZgPiDfXiGuVy8SqPaAMYL83d47pcrwekub29e2QX8+VmyCKp7F0je7KC2SA+kYvj4PvnNt32Hz3s4zgIi4JwIMSdE9cYN+mifzIujY+B6XryeRCswt5FoQBK99uL9zfWtj20ncm3L90xlGGl+34kpJJq0Di92JkPKlEOoiy3B+bgYMg4Ah/O8Q4rqWSsvUuqvUvY88YQeLFr2Bs548j5UNOCq4gFP6+Xz1cdYiQBXvfjYKlRpBfVNvdq2n8i1/24QEoPzu6Xz885l9X/d2jJsVn5cfX/5kPHABwLEbc7dKLnC/EJ9T5T8EJYWaf/3c7W6XNuu+mJ5AXx0QVW5UiaMOmf6f02S/si25u7BJU9pYu+iErboXDANLpOc5vN7G7eZZT2RgMnExqYtfU6AMeLvYdOIwTGgC+HyiH8aSLvXwTajMnAMepYDh0C0qUcEqaSHQchIozZkNAVI/XCZMBlVsmd/VA3BoqueIdFiiZkKFp0hTUgXFBMoVb+gbjfFZ2DwN80cpPp9NoFzLqfI8xGGG2ul3fLjKb3A6ihzbeNNzUkQwIOGgqpBjFt+qOrzJ3j6hUJ6/jah8L/Kf9htnhK17N2s1HoyJDgWO8CFx2PhLVLuKwDrcVLhyiHB1Bm7h6YGq5Ht2dIrQPvElMdTmumpvtlvdyuOuYGa/NdVHV7JA7KumIoRAHJtumaRhHAnQfn6IZUnQDicWOt0BEHhSjogqNY2wZrj9IUAHURayWUzopVgNdlrG0zusPKVwD82LFWWp8aXvFeT+bzdN4n5nK23zb2iojEGNxjVNkhcxM0ZPw9t7EHsA7KI02DzeQT9yM9PM/IXThuvukyhbrEcrk/LmL6IdTDY7uM32WM7zL6PWO93JFjx/xDawbE/psch7mIM+kV/Xnrbxv/GzC5zADCwLnJAU196JkFDuIdlAeaB91NJujWg165oKkbx80G3aZTl3zQ1CcXGeEw8uE5oakPLrNCNxZ65oWmzhw7MxzuoHROXoSdZf3P0Ukvq3aNJ+WM0nNJ/QujuPNP7DolnV1nBmedRjh9VB/JoaivbxeL2eLxomXAbsZbd9bhckuHHqBldP+U3n/sspAOjDnj7iv0omWGb8beMbd3xfiYZtcupwvrzxlyKRI9Lz+lL6uy8UA0Mm1b3d3BJ3xZPjcuyBOEEUJPQJadIhLq1OCodABUn7gEAWKXUmR6SifTfGoMxbp3cyScrU4oD6Gsn1N2yM7dMXeqbg9hP05l26pTfULooe4M1Ni7425TjR8CPaQSb4e4fxV+cO47qMC7j3rH6vtQJ45Vebdb2zD7pPOJ+eOtAVmI8/DdZCMRnAt1Bo82O5Iug4/cl46VXH/c9FrmQNwd72h2wj28OpBxc1XCsebN0OqhYfTdVRFd+jCgmpD78jWqii4LpXuWlvvmLlsf6oGrrN204l1n7y6sDMricqe+TjY/tMZAVj+/2yzneULon9VZD99LVpfBOc/q/Eg6zOoNfRmS1Q/hHpwdG3C7zI6d+tE9Ozb0wl127NSH/tmxoS9fITt2Wiids2ND35xlx4M9cJQdm+ac6+zYiZUh2bGhU18lOx5cYzXF9XZ5k03Wbf+2gtnQYwffS24Usbnf8HLD6Fxs43oyaLvbjNqJVsthdi3ZtuvBUOWW68lXE3DbTa2eeijXM8eyqIzfqTrKzrbjiKTtGBmulXJd+oqSqby2QBb5NbfrkzyA3feSMyikwSd2cGyEyLRabmZN78ZoBxR4kWeDQ9TdM0INsrtE0AJv//hfw/0Vwj7focGFRK0rLs/sWmDunKFqgJ0lJgGto3xUn+uu01CL0R6SfWod+CpJR1jHzCld35zD2H8vuUeCdrTzuSMFGbEfLs7mWmAecjLHrNvh53LHqgFE0K1qgcHy+1GKBJkI50d0Ry0axH58xeO5YyRksV/Oj+aOm6AbFvyRjuWOnLDFDn3VI7nDCbySJ/smcMb+e0ngErSjHcUdKYGL/XBxDHesZCiCPm4y7NCt/mdyR0yGHfAPP4/7Fsmww1rpfRZ3vGR4AL3jc7jjJ8MObLg4g/s2yfBAJxv/vmI1S+XvEkR9tS1b/22FwfIe+W4ax8L3zqZ7gi264Sa9cmB667LEmfz66my7Mq3azTsWIvLhHKH5OlbTqD8+4MEFut5lBwuuT6nRcuS65zEW4RFzV8tBbp2vWPyDc1QDyoF5icXrLBe1HN0++YcFftSc09AZmmfYL3cue9Hhy51Lb7YE/WE8ztJNthmPi9/PzG/SM2yL8c6i/N381ufJq8lM/JvowrNp0To/vj+w5wAuq6atsiIA2zsbSs/ukgT3OHY+pPj4Z2ccfzp8+pfOT/8y7On4b6LX6UROWzIRlZmrUciX/rPqDKOyGhZfOsLUvWDqI8PEiXJ5u13Nu9O6t+uUbTogW6TiXWMRVWFzLER5tuqMqLA5FqLN9q4zosLmWIiet+KXd4qICptjIZrOPnVGVNg4RATz6dViOruXd08AVNnyW2RT+OieybTqpxQgu6KYuXv2f7o++z+Dnt0vj2IKuqbRQ6PfMotiBlwn0RYg2+TQGkinKfQAn+0zKII5PIEewNUufyJMw9LnATztsifCMyx5HsDTLnciPMNS5wE87TInwjMscR7A0y5vIjzD0mYdj7fPXv97ef1u/P7dzZX5xvYdrk+T9Wxyx29vkUX/FEoxXL19dXVxedMeQmnQH4G0yzeixsvnyWLymB7a7pum47Jp+32/sfqV+OdnAvIP7br0GvVnaA3TjKhHRQPRIYfiUa1pc6jKOwBz58MVQvrurcZzj3YYgRdnKBtmfIuZ3m2Gt+j9WfujHojUxRwGj+45ac+aT3Nm044j8KI0cfN82+S24Ys7BRDQzg2SxjsIAopWXwXUnov/bnPTrmxURr0xCKvN/vflZom+oplddMV/i5Yd3miXG90sm74AmvEOrDosR9SVgauyEU73JQqhQXfSHMmKL2EeAHHngdkgSW+gbI0V74y268X5Yvoqd3tgVh9CjPy4GVVc6w6FOD0eNtP7oaPnDllDrGgRJLpFhxa9LmB2DQVOYgB4dM9lX3gQz+IPvHBDgDJueLFGqwXejGrTNmJDTDujoyAyf4X5utdYEVNHvB26oykR13wbs884kcsGPYGxuIYh6Te1W752tREHUqTQ6yA6gqkZu8G0Ri9w6oipZuwWU9OdqgOI2lymasTD5x1SMbOJp2jTOvPctCjCS5c3kmepbyVcIXD8fPXmcvzm3bt//Pa+6+NfYNvWUEofoiQ5+dh5JF6URq4wPKyXzzfZ+mC0YJAgU5d42t2IERC97xROJUy96hYGUefKRQKED27aHHEyaPZ2rujKlj0nDzB0h6X3xEGmQ/DwcTT7sgJssWHUNmmMouGe/8c0u+HKsoft4t50gvVNjDrE1QL+HglR+JC8lC62z+zjd00HPFiF+yef/+tt14e+KI3aPnlvzmP46erm9bv3nVHszFzh+Mfbq19e33bGsTNzheM6T5CdUZRGrjD887fLy+4To7JyxsjV21+681EYDcIACi2oPIsQTCs3C/Jfr69uLzs88EVl0Lq/tkf8QnxzftFi5u2fXRn0fXYtzm+z2Xzzw3Yxy8Q4b5uMbZO2cT7//Hl1MMhDx9CiFa8QOHsq++ryl+vLPbG181j49KKtm+den7+6Om84iobPLdq6ee7Pv715M75+d3vefBIOH49MuqP449QUdOmfJz/+dZJ/uDFVyI8n+sw7S3LTh1k6n+ZuPhQAT+0X9Rlnf5Sf/Z6a6tK0KJr8MDo5/TA6DfRZrOM//jj9UFnYD+w/2GYq/01xzRRqpvPfNNdMo2Ze/pvHNfNQMz//zeea+ahZkP8WcM0C1CzMfwtPvegsjILTqPwBtQ9R+yj/LebcRqhZnP+WcM1i1CwxAziqHq8U9/wED7lhQLGjqQg5lh12QBXmRxkeFDumClOkDBUq2AEOOcAK86UMLypivWPKlKFGsaOrMGvKkKKSCocesTgwc8owpPnpislThiTNjzHmTxlyND/GmDdtyNHsGGvMmzbkaHbqarKu7MIK2ZaYN20o0SwHGrOlDSWa5UBjtrShRLOTXGO2tCHCY+OJxhxpQ4THcqQxR9oQ4fFRBXOkDREey5HGHHmGCI/lyMMceYYIj+XIwxx5hgiP5cgj4c/GP5YjD3PkGSK8+FT7Z0ni4ZaYI88Q4bEceZgjzxDhsxx5mCPPEOGzHHmYI88Q4bMceZgjzxDhe6e+f6aDCLfEHPmGCJ+P/5gj3xDhB6d+HhlChVtijnxDhM9y5GOOfEOEz3Lkkyxl0xS7jnzMkW+I8FmOfMyRb4gIWI58zJFviAhYjnzMkW+ICFiOfMyRb4gI2HXkY44CQ0TAchRgjgJDRMCnacxRYIgIWI4CzFHgiasjwBwFhoiAZTMgxYStJlg2A8xREIqzLsAcBZYjlvcAcxQYIkKW9wBzFBgiQpb3AHMUGiJClvcQcxQaIkKP61GIOQoNEfneQydncUR8Yo5CQ0QYmJZ6hDkKMUehISIMWZ+Yo9AQEbJshqTms0VfzEWbEHMUGiJClqMQcxTG4qwLMUehISLKK5bRWTgi44k5ikbiKEWYo0iJoxRhjiKZowhzFBkiIsXhjDBHkSEiYudShDmKAnGUIsxRZIiIvFPPO1M+aUkq8kgczwhzFMXyeGKOokQeT8xRPBLHM8YcxUoczxhzFBsiIjZ+xpijWI51MeYothwF3JyPMUdxII5njDmKQ3E8Y8xRHInjGZONUyyPJ+YoTuTxxBwlhoiIzR0J5ihR4ngmmKNEi31PMEeJJ458gjlKfHHkE8xREojjmWCOklAczwRzlETieCaYo8QQEbGRNiH720QeT7qvlYNd8Rlsq8QhLT6DbbU4qMVnsK0nDmvxGWzriwNbfAbbBuLQFp/Btjbw8ZvgEdnRjixlbHoqPoNt5QRVfAbbGm5ituAoPgNtreoQ89vqmiKhZI6pJmGVh5jfhFNVwioOoU0WSZycxtVPxIowaNWHmJc9qDKh5MSlqDZhdYc4n53qLFI+aUsYtMoDn+YUVSWs9iDMZKpLWPVBGmnCoNUfhFlPtAllFQhh1muqKml51hN9QlkVImZDtCIKhdLy9lcRjUJZJUIYB6JSKC2XhYroFMqqEQLHRKlQVo8QOCZahdJycaiIWqG8Bt6IXqG8Bt6IYqG8Bt48qgda3nhxj6gWqkG2UES3UF4Db0S5UF7DeiPahfIa1htRL5TXsN6IfqE8uWBURMFQvlwyKqJhKF8uGhVRMZTVKmI+cxAdQ/ly4ah8qt/6MhdEy1BWsRDGl6gZymoWwvgSPUP5cgGpiKKhfLmEVETTUL5cRCqiaiirXcR8tiW6hgrkQlIRZUNZ/SLJxyE5C2Myf4m2oayCIYwvUTdUIJeTKqDKe8N6IwqHsjqGwAXROJRVMgQuiMqhrJYhcEF0DmXVjISvOojSoayeIXBBtA4VNlQoRO1QhdzB5wuidyiraggcE8VDWV1D4JhoHiqUN2sqpGcmDbwR3UOFDbwR5UOFDbwR7UNZhSPhqzqifqiogTeif6iogTeigKioYb0RDURFDeuNqCAqalhvRAdRkbyBU0QJUZG8hVMRPeOSN3GKqCHKah67Wvk04atmoowoq38kfNVMtBEVNzBI1BFlNZCElYIV0UeUVUESvlokComKZalREY1ExQ0MEpVExQ0MEp1ExQ0MEqVExQ0MEq1EWUUk4asvopYoq4kkfHVA9BJlVZGEz3REMVFWFxFWE9FMlFVGhPlAVBNltZF858+DIMRZeSTf+vONCXNWIcn3/pyirYh8oqxIkm/++caEO6uT5Lt/vjEhz0ol+fafb0zPmYubAiHfmB412zsCo4hrrImWoq1eokYx35gcOFvBRI0SvjE5c7aKiVIjvjE5draSiVKKb0xOnkfyblwTPUVbzUTxNyY0EVS0FU0Uf2lCE0VFj2J5HmkiqehRIs8jTTQVXVzy4OeRJqKKLu558PNIE1VFF1c9+Hmkiayii9sewjwiaoournkI84jIKbq46SHMI6Kn6OKyhzCPiKCiVcEgf9GCKCraqiZKCXctCINWNlHmykuRL5VirwtpevHDSiiKv9ai6d0PLe8bdO32h+VS8Tcw6AUQK6IozV/CoHdAtF92lRtxeg3EyigJP7HpRZDiJojQPcKklVGU5iMCvQ1idRSl+bVIL4QUIgtb1GkismivuG/Fd4+oLNoqKX7uWJ0FoT5V2udKKk0EF21FFSVc+SGKi/bknbsmiou2qooSbggRyUVbWUVJl4QIkVZXUcI9ISK6aK9gkp+oRHXRXsEkH/uI7KK9BiaJ7KJ9uRjVRHbRfnF3jl8tRHfRxfUR9vKKJrqLttqKEm44EeFFW3FFCZeciPKirbrC12GaKC/alxUzTZQXbdUVJdyfItKLtvKK4q9QaaK9aKuvKP4WlSbii7YCi+IvUmmivmirsEiLlsgv2kosir94pYn+ooOCP37eEwFGBwV/whU5epvOLj/+BpYmEowOGuIokWB0EDVUVkSD0VZnUfztLk1EGG2FFsVf8NJEhdFWackXKX8LkBBopRbFX/PSRIfRoW6I/USI0VZsUT4/6YgSo63aovibYZpIMTosCOTnEdFitNVbFH8/TBMxRlvBRfFXxDRRY7RVXBR/S0wTOUZbyUXKsUSP0VZzUfytMk0EGW1FF8VfLNNEkdFWdVH83TJNJBkdFXeQ+blBNBltdRfF3zDTRJTRVnhR/CUzTVQZbZUXxd8e06UsY6/lf0rXWTq9Kq7nf/hwMrZ/SnJy+tfJuLyzn89G69Tc3s+Ty49//X16kq/i/P9/7+/qm9/MM/Zvj9g7MJlq50EXLjjT/XsCoK2Gtr5ki7/BYG8fgUfnM8aCj6Li/3FQ/D/xi/+bA/fih7y4Ln7QpYk5USl+8MPyh6CyCks3RkUrfoglmNXf/JuvFzCf2S9o24NNQF9VgbbBybr8I304WB4crKiVAwZHHAEcedUmuLF/pDN+mMzm0Njz98Z5Bdpou9ne36cbRBjqgjgEU4TXbAL3RqNRQYPZA4rm4nxRe0+RV86TctLH5WRIomq+VMzrauJ41Q/VQjHHNOV8qWZQWP1QzUMjnDUAxePjA4CeaLdaoTEFJoLF3WzztERGJrHsBzWUpvTdfHL/EdkFcMVG0mq/W06/QDMQZALRJKvePQX6BqgXp+r9U3r/UaI8BiNq7oSILjabu+VkPf28zofXvNESuACTRrI3f7fGBcfAh8Ml9mA+M6F7sppBYxDcRNyVISIXUtRsSHkCaKUpUVruRwzag0kl5ZDSvvhOFRAd95Zxs+Vi8ulussYRYm8sBZXSeDV5TDc/TNO7LUlicJY0u/g0I3E5gPG00TbPn/P5ElEFHyxirwfxENiFVTSSn144uJtsEPIQDHooTu3CtvhaqSUa9wjYmztfjQ4e18stmqURmGyxOE8LYxzFwYDHZVZOvCpqi+wt8+Byb18zDOIL6IEnRabS0vzNKoppIC4EDbb7F2iA5wJbr+xCUHahyiBRmX/i8t+TkuakyjmjKtWoXaaqapTKp7lPUSaoapKEoypBVT/E1Q9Jmd90lfqM7Ff+UBZG2isdGtmi+EGsFquX0sOFCmugpHrKSFrx00k2uds+POB47IPl7kkPry9xMN2UNN2m6eM6Jas7gBFcior23dbACoYkc95Q1iwi2uIFgcCBBjNEy700duNsskBJ2gOQPWk9lKazeYorNJg8JF7SBe5t2CICppsMlyAesPIkQnbfZgeiFuhdWI5sNZejcknE5XStZrSqykaldsGyWka6Wj1e9YNfrZ6g+pddiI2qH2Kpnw/5iI7ny+VHHO0ULGWMtCNYr5fP7E4JTnothhtjvilfTAOfnUBjaQ4/bOfzsd020IcHEHskTcbHNNsF2RkO2SGowgIpzeX2s2n+D7OHGVnw4PG+NO65dfkGaLiK4KjpBtN1Xnrmo8almxjGLDFy5D7s+wK5ItCHRWAoLcjcQ1EAGxJnONuDbgTSonzKgc/TfbJCuQpMgEBK1IUDE3ORKaBO3HQWpqtJ8SJHYAzKFF/ivTD+7zbdIvLgTsMXO10f7hjWY6ra0OtqO+ZVmcyX5vEMR3IYEEeiDeLLBzaeBH33Niv4MAUf5lcZVhr22eJhuX4ef8LlsEarXTTN0vXDBK8XuFzEXDXbmP09TldwN+lLS6T8fhhYDqDqtyJmJE2U8rtboAOY1Kuduxa3ef/Bgw3FCLF8/Vjb0sGYEkrsflzMHp8yHAZgFA0lYszG6HmJhzeBCVaslYtX68GwD2uIQIp+u++IgEMDoYr7kvyXLTY7vA8TxLEYbiUCiT9jXAvyCZwDkfjc7RzPHLhIKmlQK4mVYtNZ6zBMDRJo+7U58MmQzKqY12JiWSyzJzIFNXysNAGXi/v5Eu/34MwVo99yQTOAD6aRqNEuF+l6jTc5PhhiXxrY5cKE/80TmbswZfrSyBb5hiraGio+0qpeTdaT+Tydi5tTQFIiP/8zKdLgXiGUFlx9BsMwWJWwWgzd1p5dtXC9axF1+a0h0BAuBi3NRGtIR1vByah1BT6UnSwex+t0s8o3xpg2KEg2Wm9SHDs0HHWpuuKK6gSmu6DaKlR7CnMft/ih2nlrcRbn3nGsB44Fk7zeScnsgSyIekxut/7CjyCkX1qnhTmtGGC4l6btOq+0JmRfADmLpMGp3vJLs5qC+1QtlofQnDtWgWMt7i0qJ9yxCqzOxUITO+AyGAzr8iAKMnUIQITlvKvmX6XPxOXiqgolVRWIqpJplLc7mKj2u34lEgVVARxWP0SVn1jKBevUvNAL777BJAt3xXX1g7jsC0+zuzl2BuadWBCV3x4AYjMIl7s+qKpXVQhSXvUvfrWLrxQ2FVYDVx0C6eoo0NzcaYDB8B6B+CfKQ9a4es89DJ5wBYgiyHq5xIcwMCPrUGRPnKqwYlIyZmOeLe22lvMCQCix6G/aWMPwKxb9NNrDExWxUDRG68lnZAfPoKSgvDHb0EU2m8iFAZiyiRQsitfkoacDM1GAKd+uN1nN6FEQrMdFwoB5do/FJ1hdS9OlNC87/gPDeAimeigPPXLDnhvAmSNuqYkjmj1idGSzy9nNlNSPneDAxgeMizdqjsdZusk243H5MnrzG3IJexfL05p+pR90AfkSy0/u289gUQeTc6V2arEw4L6xBUYqmCWrNKNFcYN9Dz9MuhBcwzKuv4UahkG4gT80IdErTmENA51EUhgrX5tZP7+DwyIjyGjFhS7NyCsg267MvEeIE6hvxWIks+/PhQRCaalSw7R4D6WerOBoe7t0uSuNxZGrkw8PPbW3O0cSuyLpqh7skigM269lhftvmDxHFX4xquahlAnnYPqKWn6OGcWaEJ6OlxVIdZ4QlQMal8RUZ2OqOjtSuqrovN0P1QmGX1U6wa4Oq36oDhFVLJVX2ZI/b4DbOrGsNtVB7bQBXmLRolydLbPiG44hNXBqJ9VeUjyQr98XUWgX6Ymc2i+9gmZw6yVevDFm47sv48niEQNHE7HJOk9kzFEf2n1JPH1O74o1WcjleOcPU47o4Kl2cQHBlqIXcyMGlu2C1Z+YWFjqJdJK/YJt4MYukaj8v3xHNmaldKQKSLPQmrMLAJ4Xa15H+uP0ZDVbpfPZIm/14Y+///5/UuSIb0AFAQA="; diff --git a/docs/assets/style.css b/docs/assets/style.css deleted file mode 100644 index 98a43779..00000000 --- a/docs/assets/style.css +++ /dev/null @@ -1,1414 +0,0 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} - -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} - -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} - -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} - -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} - -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} - -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} - -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} - -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} - -.uppercase { - text-transform: uppercase; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1700px; - padding: 0 2rem; -} - -/* Footer */ -.tsd-generator { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; -} - -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} - -pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} - -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} - -.tsd-theme-toggle { - padding-top: 0.75rem; -} -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; -} - -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); -} -.tsd-full-hierarchy, -.tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; -} -.tsd-full-hierarchy ul { - padding-left: 1.5rem; -} -.tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} - -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} - -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} - -.tsd-anchor { - position: relative; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} - -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 4rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} - -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} - -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} - -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} - -.deprecated { - text-decoration: line-through !important; -} - -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} - -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} - -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} - -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} - -*::-webkit-scrollbar { - width: 0.75rem; -} - -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} - -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} - -/* mobile */ -@media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } -} - -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } -} diff --git a/docs/classes/server_api_tcp_interface.BotTunnel.html b/docs/classes/server_api_tcp_interface.BotTunnel.html deleted file mode 100644 index 8b1d2974..00000000 --- a/docs/classes/server_api_tcp_interface.BotTunnel.html +++ /dev/null @@ -1,2566 +0,0 @@ - - - - - - BotTunnel | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class BotTunnel

-
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - address - - connected - - dataBuffer - - id - - onHandshake - - socket -
-
-
-

Methods

-
- - getIdentifier - - handleData - - handlePacket - - handleQueue - - isActive - - onClose - - onData - - onError - - send - - sendRaw -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

-
    -
  • - new BotTunnel(socket, - onHandshake): BotTunnel - -
    • -
  • -
    -

    - Parameters -

    -
      -
    • -
      - socket: - Socket -
      -
      • -
    • -
      - onHandshake: - ((packetContent) - => void) -
      -
        -
      • -
          -
        • - (packetContent): void -
          • -
        • -
          -

          - Parameters -

          -
            -
          • -
            - packetContent: - string -
            -
            • -
          -
          -

          - Returns - void -

          -
          • -
        -
        • -
      -
      • -
    -
    -

    - Returns - BotTunnel -

    - -
    • -
-
-
-
-

Properties

-
- -

- address - -

-
- address: - undefined | string -
- -
-
- -

- connected - -

-
- connected: - boolean = false -
- -
-
- -

- dataBuffer - -

-
- dataBuffer: - undefined | Buffer -
- -
-
- -

- id - -

-
- id: - undefined | number -
- -
-
- -

- Private - onHandshake - -

-
- onHandshake: - ((packetContent) => void) -
-
-

Type declaration

-
    -
  • -
      -
    • - (packetContent): void -
      • -
    • -
      -

      - Parameters -

      -
        -
      • -
        - packetContent: - string -
        -
        • -
      -
      -

      - Returns - void -

      -
      • -
    -
    • -
-
- -
-
- -

- Private - socket - -

-
- socket: - Socket -
- -
-
-
-

Methods

-
- -

- getIdentifier - -

- -
-
- -

- handleData - -

- -
-
- -

- handlePacket - -

- -
-
- -

- handleQueue - -

- -
-
- -

- isActive - -

- -
-
- -

- onClose - -

- -
-
- -

- onData - -

- -
-
- -

- onError - -

- -
-
- -

- send - -

- -
-
- -

- sendRaw - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_api_tcp_interface.TCPServer.html b/docs/classes/server_api_tcp_interface.TCPServer.html deleted file mode 100644 index 2a6b57ed..00000000 --- a/docs/classes/server_api_tcp_interface.TCPServer.html +++ /dev/null @@ -1,1703 +0,0 @@ - - - - - - TCPServer | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class TCPServer

-
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - connections - - server -
-
-
-

Methods

-
- - getConnectedIds - - getTunnelFromId - - handleConnection -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Private - connections - -

-
- connections: - {
    [id: - string]: BotTunnel;
} = {} -
-
-

Type declaration

- -
- -
-
- -

- Private - server - -

-
- server: - Server -
- -
-
-
-

Methods

-
- -

- getConnectedIds - -

- -
-
- -

- getTunnelFromId - -

- -
-
- -

- Private - handleConnection - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_command.CommandBase.html b/docs/classes/server_command_command.CommandBase.html deleted file mode 100644 index a14f4b01..00000000 --- a/docs/classes/server_command_command.CommandBase.html +++ /dev/null @@ -1,1756 +0,0 @@ - - - - - - CommandBase | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Class CommandBaseAbstract -

-
-
-
-

- A command base class. Used to circumvent TypeScript - abstract/interface weirdness by providing a version - of Command which can be extended with attributes and - constructors. -

-
-
-
-
-

- Hierarchy (view full) -

- -
-
-

Implements

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

-
    -
  • - addRequirements(reqs): void - -
    • -
  • -
    -

    - A utility method for adding multiple - requirements at once. -

    -
    -
    -

    - Parameters -

    -
      -
    • -
      - reqs: - Object[] -
      -
      • -
    -
    -

    - Returns - void -

    -
    - -
    • -
-
-
- -

- Abstract - execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_command.CommandGroup.html b/docs/classes/server_command_command.CommandGroup.html deleted file mode 100644 index eb6e46e9..00000000 --- a/docs/classes/server_command_command.CommandGroup.html +++ /dev/null @@ -1,1867 +0,0 @@ - - - - - - CommandGroup | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Class CommandGroupAbstract -

-
-
-
-

- A type of command which groups other commands and - runs them together. -

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - commands -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- Readonly - commands - -

-
- commands: - Command[] -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- Abstract - execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_command.ParallelCommandGroup.html b/docs/classes/server_command_command.ParallelCommandGroup.html deleted file mode 100644 index 18e28a83..00000000 --- a/docs/classes/server_command_command.ParallelCommandGroup.html +++ /dev/null @@ -1,1857 +0,0 @@ - - - - - - ParallelCommandGroup | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class ParallelCommandGroup

-
-
-
-

Executes one or more commands in parallel.

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - commands -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- Readonly - commands - -

-
- commands: - Command[] -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_command.RobotCommand.html b/docs/classes/server_command_command.RobotCommand.html deleted file mode 100644 index 4f24b79b..00000000 --- a/docs/classes/server_command_command.RobotCommand.html +++ /dev/null @@ -1,1872 +0,0 @@ - - - - - - RobotCommand | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Class RobotCommandAbstract -

-
-
-
-

- A command which operates on an individual Robot. - Note this class redirects the execute implementation - to executeRobot. -

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - robot -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- Readonly - robot - -

-
- robot: - Robot -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- Abstract - execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_command.SequentialCommandGroup.html b/docs/classes/server_command_command.SequentialCommandGroup.html deleted file mode 100644 index 4a304a8c..00000000 --- a/docs/classes/server_command_command.SequentialCommandGroup.html +++ /dev/null @@ -1,1860 +0,0 @@ - - - - - - SequentialCommandGroup | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class SequentialCommandGroup

-
-
-
-

- Executes one or more commands in sequence, one after - another. -

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - commands -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- Readonly - commands - -

-
- commands: - Command[] -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_executor.CommandExecutor.html b/docs/classes/server_command_executor.CommandExecutor.html deleted file mode 100644 index d7d2369c..00000000 --- a/docs/classes/server_command_executor.CommandExecutor.html +++ /dev/null @@ -1,1579 +0,0 @@ - - - - - - CommandExecutor | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class CommandExecutor

-
-
-
-

- The executor for commands. Handles requirements - checking for commands to ensure commands do not use - the same requirement concurrently. -

-
-
-
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - runningCommands -
-
-
-

Methods

-
- - checkRequirements - - execute - - getRunningCommands -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Private - runningCommands - -

-
- runningCommands: - Command[] = [] -
- -
-
-
-

Methods

-
- -

- Private - checkRequirements - -

- -
-
- -

- execute - -

-
    -
  • - execute(command): void - -
    • -
  • -
    -

    - Executes a command after checking the - requirements. -

    -
    -
    -

    - Parameters -

    -
      -
    • -
      - command: - Command -
      -
      -

      The command to execute.

      -
      -
      -
      • -
    -
    -

    - Returns - void -

    -
    - -
    • -
-
-
- -

- getRunningCommands - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_move_command.AbsoluteMoveCommand.html b/docs/classes/server_command_move_command.AbsoluteMoveCommand.html deleted file mode 100644 index d3b30b0b..00000000 --- a/docs/classes/server_command_move_command.AbsoluteMoveCommand.html +++ /dev/null @@ -1,1940 +0,0 @@ - - - - - - AbsoluteMoveCommand | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class AbsoluteMoveCommand

-
-
-
-

Moves a robot to a global location.

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - position - - robot -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- Protected - position - -

-
- position: - Position -
- -
-
- -

- Readonly - robot - -

-
- robot: - Robot -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_move_command.AbsoluteRotateCommand.html b/docs/classes/server_command_move_command.AbsoluteRotateCommand.html deleted file mode 100644 index be9cdb78..00000000 --- a/docs/classes/server_command_move_command.AbsoluteRotateCommand.html +++ /dev/null @@ -1,1928 +0,0 @@ - - - - - - AbsoluteRotateCommand | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class AbsoluteRotateCommand

-
-
-
-

Rotates a robot to a given heading.

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - heading - - robot -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- heading - -

-
- heading: - number -
- -
-
- -

- Readonly - robot - -

-
- robot: - Robot -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_move_command.MoveCommand.html b/docs/classes/server_command_move_command.MoveCommand.html deleted file mode 100644 index 6671a206..00000000 --- a/docs/classes/server_command_move_command.MoveCommand.html +++ /dev/null @@ -1,1948 +0,0 @@ - - - - - - MoveCommand | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Class MoveCommandAbstract -

-
-
-
-

Represents a robot translation in x and y.

-

- Note this may involve the robot turning first. The - orientation after the move is unspecified. -

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - position - - robot -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- Protected - position - -

-
- position: - Position -
- -
-
- -

- Readonly - robot - -

-
- robot: - Robot -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- Abstract - execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_move_command.RelativeMoveCommand.html b/docs/classes/server_command_move_command.RelativeMoveCommand.html deleted file mode 100644 index b882acbb..00000000 --- a/docs/classes/server_command_move_command.RelativeMoveCommand.html +++ /dev/null @@ -1,2047 +0,0 @@ - - - - - - RelativeMoveCommand | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class RelativeMoveCommand

-
-
-
-

- Shifts a robot a relative amount. The heading of the - robot after the move is arbitrary. -

-
-
-
-
-

- Hierarchy (view full) -

- -
-
-

Implements

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - position - - robot -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - reverse - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- Protected - position - -

-
- position: - Position -
- -
-
- -

- Readonly - robot - -

-
- robot: - Robot -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- execute - -

- -
-
- -

- reverse - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_move_command.RelativeRotateCommand.html b/docs/classes/server_command_move_command.RelativeRotateCommand.html deleted file mode 100644 index 03d6b379..00000000 --- a/docs/classes/server_command_move_command.RelativeRotateCommand.html +++ /dev/null @@ -1,2032 +0,0 @@ - - - - - - RelativeRotateCommand | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class RelativeRotateCommand

-
-
-
-

Rotates a robot a relative amount.

-
-
-
-
-

- Hierarchy (view full) -

- -
-
-

Implements

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - heading - - robot -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - reverse - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- heading - -

-
- heading: - number -
- -
-
- -

- Readonly - robot - -

-
- robot: - Robot -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- execute - -

- -
-
- -

- reverse - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_move_command.RotateCommand.html b/docs/classes/server_command_move_command.RotateCommand.html deleted file mode 100644 index 60918803..00000000 --- a/docs/classes/server_command_move_command.RotateCommand.html +++ /dev/null @@ -1,1935 +0,0 @@ - - - - - - RotateCommand | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Class RotateCommandAbstract -

-
-
-
-

Represents a rotation.

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - heading - - robot -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- heading - -

-
- heading: - number -
- -
-
- -

- Readonly - robot - -

-
- robot: - Robot -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- Abstract - execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_move_command.RotateToStartCommand.html b/docs/classes/server_command_move_command.RotateToStartCommand.html deleted file mode 100644 index bedf4a07..00000000 --- a/docs/classes/server_command_move_command.RotateToStartCommand.html +++ /dev/null @@ -1,1855 +0,0 @@ - - - - - - RotateToStartCommand | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class RotateToStartCommand

-
-
-
-

Resets a robot to its starting heading.

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - robot -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- Readonly - robot - -

-
- robot: - Robot -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_command_move_piece.MovePiece.html b/docs/classes/server_command_move_piece.MovePiece.html deleted file mode 100644 index b945fa2e..00000000 --- a/docs/classes/server_command_move_piece.MovePiece.html +++ /dev/null @@ -1,1908 +0,0 @@ - - - - - - MovePiece | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class MovePiece

-
-
-
-

- Executes a set of setupMoves in parallel, followed - by a mainMove. The setupMoves are automatically - undone afterwards. -

-
-
-
-
-

- Hierarchy (view full) -

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _requirements - - mainMove - - setupMoves -
-
-
-

Accessors

-
- - requirements -
-
-
-

Methods

-
- - addRequirements - - execute - - then -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Protected - _requirements - -

-
- _requirements: - Set<Object> = ... -
- -
-
- -

- mainMove - -

-
- mainMove: - Command -
- -
-
- -

- setupMoves - -

-
- setupMoves: - ReversibleRobotCommand[] -
- -
-
-
-

Accessors

-
- -

- requirements - -

-
    -
  • - get - requirements(): Set<Object> -
    • -
  • -
    -

    - The set of objects that this command - requires to execute. Used to place - mutexes on common resources to ensure - they don't receive multiple inputs - at once. -

    -
    -

    - Returns - Set<Object> -

    -
    - -
    • -
-
-
-
-

Methods

-
- -

- Protected - addRequirements - -

- -
-
- -

- execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_robot_pair.Indices.html b/docs/classes/server_robot_pair.Indices.html deleted file mode 100644 index 0120c180..00000000 --- a/docs/classes/server_robot_pair.Indices.html +++ /dev/null @@ -1,2137 +0,0 @@ - - - - - - Indices | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class Indices

-
-
-

Hierarchy

-
    -
  • - Pair<Indices> -
      -
    • Indices
      • -
    -
    • -
-
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - i - - item1 - - item2 - - j -
-
-
-

Methods

-
- - add - - create - - div - - mul - - neg - - sub - - toTuple -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

-
    -
  • - new Indices(i, - j): Indices - -
    • -
  • -
    -

    - Parameters -

    -
      -
    • -
      - i: - number -
      -
      • -
    • -
      - j: - number -
      -
      • -
    -
    -

    - Returns - Indices -

    - -
    • -
-
-
-
-

Properties

-
- -

- Readonly - i - -

-
- i: - number -
- -
-
- -

- Protected - item1 - -

-
- item1: - number -
- -
-
- -

- Protected - item2 - -

-
- item2: - number -
- -
-
- -

- Readonly - j - -

-
- j: - number -
- -
-
-
-

Methods

-
- -

- add - -

- -
-
- -

- create - -

- -
-
- -

- div - -

- -
-
- -

- mul - -

- -
-
- -

- neg - -

- -
-
- -

- sub - -

- -
-
- -

- toTuple - -

-
    -
  • - toTuple(): [number, number] - -
    • -
  • -

    - Returns - [number, number] -

    - -
    • -
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_robot_pair.Position.html b/docs/classes/server_robot_pair.Position.html deleted file mode 100644 index b0dfbfe5..00000000 --- a/docs/classes/server_robot_pair.Position.html +++ /dev/null @@ -1,2139 +0,0 @@ - - - - - - Position | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class Position

-
-
-

Hierarchy

- -
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - item1 - - item2 - - x - - y -
-
-
-

Methods

-
- - add - - create - - div - - mul - - neg - - sub - - toTuple -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

-
    -
  • - new Position(x, - y): Position - -
    • -
  • -
    -

    - Parameters -

    -
      -
    • -
      - x: - number -
      -
      • -
    • -
      - y: - number -
      -
      • -
    -
    -

    - Returns - Position -

    - -
    • -
-
-
-
-

Properties

-
- -

- Protected - item1 - -

-
- item1: - number -
- -
-
- -

- Protected - item2 - -

-
- item2: - number -
- -
-
- -

- Readonly - x - -

-
- x: - number -
- -
-
- -

- Readonly - y - -

-
- y: - number -
- -
-
-
-

Methods

-
- -

- add - -

- -
-
- -

- create - -

- -
-
- -

- div - -

- -
-
- -

- mul - -

- -
-
- -

- neg - -

- -
-
- -

- sub - -

- -
-
- -

- toTuple - -

-
    -
  • - toTuple(): [number, number] - -
    • -
  • -

    - Returns - [number, number] -

    - -
    • -
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_robot_piece.Piece.html b/docs/classes/server_robot_piece.Piece.html deleted file mode 100644 index 16aba580..00000000 --- a/docs/classes/server_robot_piece.Piece.html +++ /dev/null @@ -1,1490 +0,0 @@ - - - - - - Piece | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class Piece

-
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - pieceType - - robot - - side - - square -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Readonly - pieceType - -

-
- pieceType: - PieceType -
- -
-
- -

- Readonly - robot - -

-
- robot: - Robot -
- -
-
- -

- Readonly - side - -

-
- side: - Side -
- -
-
- -

- square - -

-
- square: - Square -
- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_robot_piece_manager.PieceManager.html b/docs/classes/server_robot_piece_manager.PieceManager.html deleted file mode 100644 index d7c8f30c..00000000 --- a/docs/classes/server_robot_piece_manager.PieceManager.html +++ /dev/null @@ -1,1402 +0,0 @@ - - - - - - PieceManager | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class PieceManager

-
-
-
-

Stores the pieces used in the game of chess.

-
-
-
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - pieces -
-
-
-

Methods

-
- - getPiece -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- pieces - -

-
- pieces: - Piece[] -
- -
-
-
-

Methods

-
- -

- getPiece - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_robot_robot.Robot.html b/docs/classes/server_robot_robot.Robot.html deleted file mode 100644 index ba02c05e..00000000 --- a/docs/classes/server_robot_robot.Robot.html +++ /dev/null @@ -1,2083 +0,0 @@ - - - - - - Robot | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class Robot

-
-
-
-

- Represents a robot. Includes information about the - current location as well as tooling for - communication. -

-
-
-
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - _heading - - _position - - socket - - startHeading -
-
-
-

Accessors

-
- - heading - - position -
-
-
-

Methods

-
- - absoluteRotate - - relativeMove - - relativeRotate -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Private - _heading - -

-
- _heading: - number -
- -
-
- -

- Private - _position - -

-
- _position: - Position - = ZERO_POSITION -
- -
-
- -

- Private - Readonly - socket - -

-
- socket: - RobotSocket -
- -
-
- -

- Readonly - startHeading - -

-
- startHeading: - number = 0 -
- -
-
-
-

Accessors

-
- -

- heading - -

-
    -
  • - get - heading(): number -
    • -
  • -

    - Returns - number -

    - -
    • -
  • - set - heading(heading): void -
    • -
  • -
    -

    - Parameters -

    -
      -
    • -
      - heading: - number -
      -
      • -
    -
    -

    - Returns - void -

    - -
    • -
-
-
- -

- position - -

- -
-
-
-

Methods

-
- -

- absoluteRotate - -

-
    -
  • - absoluteRotate(heading): Promise<void> - -
    • -
  • -
    -

    - Parameters -

    -
      -
    • -
      - heading: - number -
      -
      -

      - An absolute heading to turn - to. -

      -
      -
      -
      • -
    -
    -

    - Returns - Promise<void> -

    -
    - -
    • -
-
-
- -

- relativeMove - -

-
    -
  • - relativeMove(deltaPosition): Promise<void> - -
    • -
  • -
    -

    - Turns and drives the robot to - this.position + deltaPosition. -

    -
    -
    -

    - Parameters -

    -
      -
    • -
      - deltaPosition: - Position -
      -
      -

      - The amount to offset the - current position by. -

      -
      -
      -
      • -
    -
    -

    - Returns - Promise<void> -

    -
    - -
    • -
-
-
- -

- relativeRotate - -

-
    -
  • - relativeRotate(deltaHeading): Promise<void> - -
    • -
  • -
    -

    - Parameters -

    -
      -
    • -
      - deltaHeading: - number -
      -
      -

      - A relative heading to turn - by. -

      -
      -
      -
      • -
    -
    -

    - Returns - Promise<void> -

    -
    - -
    • -
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_robot_robot_socket.RobotSocket.html b/docs/classes/server_robot_robot_socket.RobotSocket.html deleted file mode 100644 index e86ee48c..00000000 --- a/docs/classes/server_robot_robot_socket.RobotSocket.html +++ /dev/null @@ -1,1659 +0,0 @@ - - - - - - RobotSocket | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class RobotSocket

-
-
-
-

Represents a connection to a physical robot.

-
-
-
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - tunnel -
-
-
-

Methods

-
- - drive - - turn - - turnAndDrive -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Private - tunnel - -

-
- tunnel: - BotTunnel -
- -
-
-
-

Methods

-
- -

- drive - -

-
    -
  • - drive(distance): Promise<void> - -
    • -
  • -
    -

    - Send a packet to the robot indicating - distance to drive. Returns a promise - that finishes when the robot finishes - the action. -

    -
    -
    -

    - Parameters -

    -
      -
    • -
      - distance: - number -
      -
      -

      - The distance to drive - forward or backwards by. 1 - is defined as the length of - a tile. -

      -
      -
      -
      • -
    -
    -

    - Returns - Promise<void> -

    -
    - -
    • -
-
-
- -

- turn - -

-
    -
  • - turn(deltaHeading): Promise<void> - -
    • -
  • -
    -

    - Send a packet to the robot indicating - angle to turn. Returns a promise that - finishes when the robot finishes the - action. -

    -
    -
    -

    - Parameters -

    -
      -
    • -
      - deltaHeading: - number -
      -
      -

      - A relative heading to turn - by, in radians. May be - positive or negative. -

      -
      -
      -
      • -
    -
    -

    - Returns - Promise<void> -

    -
    - -
    • -
-
-
- -

- turnAndDrive - -

-
    -
  • - turnAndDrive(deltaHeading?, - distance?): Promise<void> - -
    • -
  • -
    -

    - Parameters -

    -
      -
    • -
      - deltaHeading: - number - = 0 -
      -
      • -
    • -
      - distance: - number - = 0 -
      -
      • -
    -
    -

    - Returns - Promise<void> -

    - -
    • -
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/classes/server_robot_square.Square.html b/docs/classes/server_robot_square.Square.html deleted file mode 100644 index ada2c912..00000000 --- a/docs/classes/server_robot_square.Square.html +++ /dev/null @@ -1,1808 +0,0 @@ - - - - - - Square | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Class Square

-
- -
-
-
- - - -
-
-

- Constructors -

-
- - constructor -
-
-
-

- Properties -

-
- - indices - - FILE_LOOKUP -
-
-
-

Methods

-
- - toPosition - - toString - - fromPosition - - fromString - - make -
-
-
-
-
-
-
-

Constructors

-
- -

- constructor - -

- -
-
-
-

Properties

-
- -

- Readonly - indices - -

-
- indices: - Indices -
- -
-
- -

- Static - Readonly - FILE_LOOKUP - -

-
- FILE_LOOKUP: - "abcdefgh" - = "abcdefgh" -
- -
-
-
-

Methods

-
- -

- toPosition - -

- -
-
- -

- toString - -

- -
-
- -

- Static - fromPosition - -

- -
-
- -

- Static - fromString - -

- -
-
- -

- Static - make - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/enums/server_api_tcp_interface.PacketType.html b/docs/enums/server_api_tcp_interface.PacketType.html deleted file mode 100644 index c9c209a5..00000000 --- a/docs/enums/server_api_tcp_interface.PacketType.html +++ /dev/null @@ -1,1870 +0,0 @@ - - - - - - PacketType | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Enumeration PacketType

-
- -
-
-
- - - -
-
-

- Enumeration Members -

-
- - ACTION_FAIL - - ACTION_SUCCESS - - CLIENT_HELLO - - DRIVE_TANK - - DRIVE_TILES - - ESTOP - - INFORM_VAR - - NOTHING - - PING_RESPONSE - - PING_SEND - - QUERY_RESPONSE - - QUERY_VAR - - SERVER_HELLO - - SET_VAR - - TURN_BY_ANGLE -
-
-
-
-
-
-
-

Enumeration Members

-
- -

- ACTION_FAIL - -

-
- ACTION_FAIL: - 12 -
- -
-
- -

- ACTION_SUCCESS - -

-
- ACTION_SUCCESS: - 11 -
- -
-
- -

- CLIENT_HELLO - -

-
- CLIENT_HELLO: - 1 -
- -
-
- -

- DRIVE_TANK - -

-
- DRIVE_TANK: - 13 -
- -
-
- -

- DRIVE_TILES - -

-
- DRIVE_TILES: - 10 -
- -
-
- -

- ESTOP - -

-
- ESTOP: - 14 -
- -
-
- -

- INFORM_VAR - -

-
- INFORM_VAR: - 7 -
- -
-
- -

- NOTHING - -

-
- NOTHING: - 0 -
- -
-
- -

- PING_RESPONSE - -

-
- PING_RESPONSE: - 4 -
- -
-
- -

- PING_SEND - -

-
- PING_SEND: - 3 -
- -
-
- -

- QUERY_RESPONSE - -

-
- QUERY_RESPONSE: - 6 -
- -
-
- -

- QUERY_VAR - -

-
- QUERY_VAR: - 5 -
- -
-
- -

- SERVER_HELLO - -

-
- SERVER_HELLO: - 2 -
- -
-
- -

- SET_VAR - -

-
- SET_VAR: - 8 -
- -
-
- -

- TURN_BY_ANGLE - -

-
- TURN_BY_ANGLE: - 9 -
- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/enums/server_robot_types.PieceType.html b/docs/enums/server_robot_types.PieceType.html deleted file mode 100644 index a9c519d9..00000000 --- a/docs/enums/server_robot_types.PieceType.html +++ /dev/null @@ -1,1416 +0,0 @@ - - - - - - PieceType | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Enumeration PieceType

-
- -
-
-
- - - -
-
-

- Enumeration Members -

-
- - BISHOP - - KING - - KNIGHT - - PAWN - - QUEEN - - ROOK -
-
-
-
-
-
-
-

Enumeration Members

-
- -

- BISHOP - -

-
- BISHOP: - "B" -
- -
-
- -

- KING - -

-
- KING: - "K" -
- -
-
- -

- KNIGHT - -

-
- KNIGHT: - "N" -
- -
-
- -

- PAWN - -

-
- PAWN: - "" -
- -
-
- -

- QUEEN - -

-
- QUEEN: - "Q" -
- -
-
- -

- ROOK - -

-
- ROOK: - "R" -
- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/enums/server_robot_types.Side.html b/docs/enums/server_robot_types.Side.html deleted file mode 100644 index 57d3b4b4..00000000 --- a/docs/enums/server_robot_types.Side.html +++ /dev/null @@ -1,1206 +0,0 @@ - - - - - - Side | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Enumeration Side

-
- -
-
-
- - - -
-
-

- Enumeration Members -

-
- - BLACK - - WHITE -
-
-
-
-
-
-
-

Enumeration Members

-
- -

- BLACK - -

-
- BLACK: - 1 -
- -
-
- -

- WHITE - -

-
- WHITE: - 0 -
- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/functions/client_api.post.html b/docs/functions/client_api.post.html deleted file mode 100644 index 19dc479a..00000000 --- a/docs/functions/client_api.post.html +++ /dev/null @@ -1,1133 +0,0 @@ - - - - - - post | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Function post

-
-
-
    -
  • - post(apiPath, - query?, - body?): Promise<any> - -
    • -
  • -
    -

    Makes a post request to the backend.

    -
    -
    -

    Parameters

    -
      -
    • -
      - apiPath: - string -
      -
      • -
    • -
      - query: - Record<string, string> - = {} -
      -
      • -
    • -
      - body: - object - = {} -
      -
      • -
    -
    -

    - Returns - Promise<any> -

    -
    - -
    • -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/functions/client_app.App.html b/docs/functions/client_app.App.html deleted file mode 100644 index 65ea7126..00000000 --- a/docs/functions/client_app.App.html +++ /dev/null @@ -1,1071 +0,0 @@ - - - - - - App | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Function App

-
-
- -
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/functions/client_body.Body.html b/docs/functions/client_body.Body.html deleted file mode 100644 index 763947f2..00000000 --- a/docs/functions/client_body.Body.html +++ /dev/null @@ -1,1073 +0,0 @@ - - - - - - Body | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Function Body

-
-
- -
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/functions/client_chessboard_wrapper.ChessboardWrapper.html b/docs/functions/client_chessboard_wrapper.ChessboardWrapper.html deleted file mode 100644 index c3884099..00000000 --- a/docs/functions/client_chessboard_wrapper.ChessboardWrapper.html +++ /dev/null @@ -1,1095 +0,0 @@ - - - - - - ChessboardWrapper | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Function ChessboardWrapper

-
-
-
    -
  • - ChessboardWrapper(props): JSX.Element - -
    • -
  • -
    -

    Parameters

    -
      -
    • -
      - props: - ChessboardWrapperProps -
      -
      • -
    -
    -

    - Returns - JSX.Element -

    - -
    • -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/functions/client_navbar_menu.NavbarMenu.html b/docs/functions/client_navbar_menu.NavbarMenu.html deleted file mode 100644 index 6c0f8198..00000000 --- a/docs/functions/client_navbar_menu.NavbarMenu.html +++ /dev/null @@ -1,1094 +0,0 @@ - - - - - - NavbarMenu | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Function NavbarMenu

-
-
-
    -
  • - NavbarMenu(props): JSX.Element - -
    • -
  • -
    -

    Parameters

    -
      -
    • -
      - props: - NavbarMenuProps -
      -
      • -
    -
    -

    - Returns - JSX.Element -

    - -
    • -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/functions/client_pages_debug.Debug.html b/docs/functions/client_pages_debug.Debug.html deleted file mode 100644 index 281c9659..00000000 --- a/docs/functions/client_pages_debug.Debug.html +++ /dev/null @@ -1,1075 +0,0 @@ - - - - - - Debug | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Function Debug

-
-
- -
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/functions/server_api_api.websocketHandler.html b/docs/functions/server_api_api.websocketHandler.html deleted file mode 100644 index 2f1e44e7..00000000 --- a/docs/functions/server_api_api.websocketHandler.html +++ /dev/null @@ -1,1157 +0,0 @@ - - - - - - websocketHandler | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Function websocketHandler

-
-
-
    -
  • - websocketHandler(ws, - req, - next): void - -
    • -
  • -
    -

    - An endpoint used to establish a websocket - connection with the server. -

    -

    - The websocket is used to stream moves to and - from the client. -

    -
    -
    -

    Parameters

    -
      -
    • -
      - ws: - WebSocket -
      -
      • -
    • -
      - req: - Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> -
      -
      • -
    • -
      - next: - NextFunction -
      -
      • -
    -
    -

    - Returns - void -

    -
    - -
    • -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/functions/server_robot_types.getStartHeading.html b/docs/functions/server_robot_types.getStartHeading.html deleted file mode 100644 index b94e1697..00000000 --- a/docs/functions/server_robot_types.getStartHeading.html +++ /dev/null @@ -1,1094 +0,0 @@ - - - - - - getStartHeading | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Function getStartHeading

-
-
- -
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/functions/server_utils_units.clampHeading.html b/docs/functions/server_utils_units.clampHeading.html deleted file mode 100644 index 0ea14f87..00000000 --- a/docs/functions/server_utils_units.clampHeading.html +++ /dev/null @@ -1,1092 +0,0 @@ - - - - - - clampHeading | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Function clampHeading

-
-
-
    -
  • - clampHeading(heading): number - -
    • -
  • -
    -

    Parameters

    -
      -
    • -
      - heading: - number -
      -
      • -
    -
    -

    - Returns - number -

    - -
    • -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/hierarchy.html b/docs/hierarchy.html deleted file mode 100644 index b2b63505..00000000 --- a/docs/hierarchy.html +++ /dev/null @@ -1,1319 +0,0 @@ - - - - - - utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-

utd-chess-bots

-

Class Hierarchy

- - -
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 232e7937..00000000 --- a/docs/index.html +++ /dev/null @@ -1,1137 +0,0 @@ - - - - - - utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-

utd-chess-bots

-
- -

- Welcome to chessBots! -

- -

Setup

-

To run the website on your local machine:

-
    -
  1. - Run either the VS Code - Install dependencies task or - yarn install to download necessary - packages. -
    2. -
  2. - Run either the VS Code - Development server task or - yarn dev to launch the dev server. This - will launch an express server which will - automatically build and serve the client to port - 3000. -
    3. -
  3. - Open - localhost:3000 in - your browser. -
    4. -
-

- Note vite will automatically watch both the server and - the client code for changes and push updates to the - browser automatically - no reloading required. -

- -

Tests

-

To run tests:

-
    -
  1. -

    - Install the VS Code jest testing extension. Make - sure to install the pre-release version, as the - current version doesn't properly display - test output. -

    -
    2. -
  2. -

    - Use the Testing pane in VS Code to trigger - tests. -

    -
    3. -
-

- Jest may also be run in watch mode, which will - automatically re-run tests in response to file changes. -

- -

Documentation

-

- Documentation can be found in the - ./docs folder. To generate documentation, - run npx typedoc in the root folder. -

-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/server_command_command.Command.html b/docs/interfaces/server_command_command.Command.html deleted file mode 100644 index e8387610..00000000 --- a/docs/interfaces/server_command_command.Command.html +++ /dev/null @@ -1,1446 +0,0 @@ - - - - - - Command | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Interface Command

-
-
-
-

An command which operates on one or more robots.

-
-
-
-
- interface Command - {
    requirements: Set<Object>;
    execute(): Promise<void>;
    then(next): SequentialCommandGroup;
} -
-
-

Implemented by

- -
- -
-
-
- - - -
-
-

- Properties -

-
- - requirements -
-
-
-

Methods

-
- - execute - - then -
-
-
-
-
-
-
-

Properties

-
- -

- requirements - -

-
- requirements: - Set<Object> -
-
-

- The set of objects that this command requires to - execute. Used to place mutexes on common - resources to ensure they don't receive - multiple inputs at once. -

-
-
- -
-
-
-

Methods

-
- -

- execute - -

- -
-
- -

- then - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/interfaces/server_command_command.Reversible.html b/docs/interfaces/server_command_command.Reversible.html deleted file mode 100644 index 1d0bce9c..00000000 --- a/docs/interfaces/server_command_command.Reversible.html +++ /dev/null @@ -1,1265 +0,0 @@ - - - - - - Reversible | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Interface Reversible<T>

-
-
-
-

- An interface for a command which can be reversed - (undone). -

-
-
-
-
- interface Reversible<T> - {
    reverse(): T;
} -
-
-

Type Parameters

- -
-
-

Implemented by

- -
- -
-
-
- - - -
-
-

Methods

-
- - reverse -
-
-
-
-
-
-
-

Methods

-
- -

- reverse - -

- -
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
- -

- - On This Page -

- -
- -
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/client_api.html b/docs/modules/client_api.html deleted file mode 100644 index ffc3ba26..00000000 --- a/docs/modules/client_api.html +++ /dev/null @@ -1,1057 +0,0 @@ - - - - - - client/api | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module client/api

-
- -
-
-

Index

-
-

Functions

-
- - post -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/client_app.html b/docs/modules/client_app.html deleted file mode 100644 index 5d08212c..00000000 --- a/docs/modules/client_app.html +++ /dev/null @@ -1,1057 +0,0 @@ - - - - - - client/app | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module client/app

-
- -
-
-

Index

-
-

Functions

-
- - App -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/client_body.html b/docs/modules/client_body.html deleted file mode 100644 index eba4eb8a..00000000 --- a/docs/modules/client_body.html +++ /dev/null @@ -1,1057 +0,0 @@ - - - - - - client/body | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module client/body

-
- -
-
-

Index

-
-

Functions

-
- - Body -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/client_chessboard_wrapper.html b/docs/modules/client_chessboard_wrapper.html deleted file mode 100644 index f04f1b9c..00000000 --- a/docs/modules/client_chessboard_wrapper.html +++ /dev/null @@ -1,1060 +0,0 @@ - - - - - - client/chessboard-wrapper | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module client/chessboard-wrapper

-
- -
-
-

Index

-
-

Functions

-
- - ChessboardWrapper -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/client_main.html b/docs/modules/client_main.html deleted file mode 100644 index 35565e24..00000000 --- a/docs/modules/client_main.html +++ /dev/null @@ -1,1037 +0,0 @@ - - - - - - client/main | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module client/main

-
- -
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/client_navbar_menu.html b/docs/modules/client_navbar_menu.html deleted file mode 100644 index 52412dce..00000000 --- a/docs/modules/client_navbar_menu.html +++ /dev/null @@ -1,1061 +0,0 @@ - - - - - - client/navbar-menu | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module client/navbar-menu

-
- -
-
-

Index

-
-

Functions

-
- - NavbarMenu -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/client_pages_debug.html b/docs/modules/client_pages_debug.html deleted file mode 100644 index 962b367f..00000000 --- a/docs/modules/client_pages_debug.html +++ /dev/null @@ -1,1061 +0,0 @@ - - - - - - client/pages/debug | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module client/pages/debug

-
- -
-
-

Index

-
-

Functions

-
- - Debug -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/client_vite_env.html b/docs/modules/client_vite_env.html deleted file mode 100644 index d1856e50..00000000 --- a/docs/modules/client_vite_env.html +++ /dev/null @@ -1,1028 +0,0 @@ - - - - - - client/vite-env | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module client/vite-env

-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_api_api.html b/docs/modules/server_api_api.html deleted file mode 100644 index 846450ba..00000000 --- a/docs/modules/server_api_api.html +++ /dev/null @@ -1,1058 +0,0 @@ - - - - - - server/api/api | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/api/api

-
- -
-
-

Index

-
-

Functions

-
- - websocketHandler -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_api_tcp_interface.html b/docs/modules/server_api_tcp_interface.html deleted file mode 100644 index 47cd4b53..00000000 --- a/docs/modules/server_api_tcp_interface.html +++ /dev/null @@ -1,1085 +0,0 @@ - - - - - - server/api/tcp-interface | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/api/tcp-interface

-
- -
-
-

Index

-
-

Enumerations

-
- - PacketType -
-
-
-

Classes

-
- - BotTunnel - - TCPServer -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_command_command.html b/docs/modules/server_command_command.html deleted file mode 100644 index 2b7b81bf..00000000 --- a/docs/modules/server_command_command.html +++ /dev/null @@ -1,1129 +0,0 @@ - - - - - - server/command/command | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/command/command

-
- -
-
-

Index

-
-

Classes

-
- - CommandBase - - CommandGroup - - ParallelCommandGroup - - RobotCommand - - SequentialCommandGroup -
-
-
-

Interfaces

-
- - Command - - Reversible -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_command_executor.html b/docs/modules/server_command_executor.html deleted file mode 100644 index 36f84533..00000000 --- a/docs/modules/server_command_executor.html +++ /dev/null @@ -1,1060 +0,0 @@ - - - - - - server/command/executor | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/command/executor

-
- -
-
-

Index

-
-

Classes

-
- - CommandExecutor -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_command_move_command.html b/docs/modules/server_command_move_command.html deleted file mode 100644 index 083d1cb2..00000000 --- a/docs/modules/server_command_move_command.html +++ /dev/null @@ -1,1130 +0,0 @@ - - - - - - server/command/move-command | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/command/move-command

-
- -
-
-

Index

-
-

Classes

-
- - AbsoluteMoveCommand - - AbsoluteRotateCommand - - MoveCommand - - RelativeMoveCommand - - RelativeRotateCommand - - RotateCommand - - RotateToStartCommand -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_command_move_piece.html b/docs/modules/server_command_move_piece.html deleted file mode 100644 index 87a98b88..00000000 --- a/docs/modules/server_command_move_piece.html +++ /dev/null @@ -1,1060 +0,0 @@ - - - - - - server/command/move-piece | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/command/move-piece

-
- -
-
-

Index

-
-

Classes

-
- - MovePiece -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_main.html b/docs/modules/server_main.html deleted file mode 100644 index 57501d51..00000000 --- a/docs/modules/server_main.html +++ /dev/null @@ -1,1037 +0,0 @@ - - - - - - server/main | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/main

-
- -
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_robot___tests___robot_test.html b/docs/modules/server_robot___tests___robot_test.html deleted file mode 100644 index 0ced2f68..00000000 --- a/docs/modules/server_robot___tests___robot_test.html +++ /dev/null @@ -1,1040 +0,0 @@ - - - - - - server/robot/__tests__/robot.test | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/robot/__tests__/robot.test

-
- -
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_robot_pair.html b/docs/modules/server_robot_pair.html deleted file mode 100644 index 2d27a5db..00000000 --- a/docs/modules/server_robot_pair.html +++ /dev/null @@ -1,1094 +0,0 @@ - - - - - - server/robot/pair | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/robot/pair

-
- -
-
-

Index

-
-

Classes

-
- - Indices - - Position -
-
-
-

Variables

-
- - ZERO_INDICES - - ZERO_POSITION -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_robot_piece.html b/docs/modules/server_robot_piece.html deleted file mode 100644 index 7fb1f07e..00000000 --- a/docs/modules/server_robot_piece.html +++ /dev/null @@ -1,1059 +0,0 @@ - - - - - - server/robot/piece | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/robot/piece

-
- -
-
-

Index

-
-

Classes

-
- - Piece -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_robot_piece_manager.html b/docs/modules/server_robot_piece_manager.html deleted file mode 100644 index 22f234ae..00000000 --- a/docs/modules/server_robot_piece_manager.html +++ /dev/null @@ -1,1059 +0,0 @@ - - - - - - server/robot/piece-manager | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/robot/piece-manager

-
- -
-
-

Index

-
-

Classes

-
- - PieceManager -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_robot_robot.html b/docs/modules/server_robot_robot.html deleted file mode 100644 index 6c112028..00000000 --- a/docs/modules/server_robot_robot.html +++ /dev/null @@ -1,1059 +0,0 @@ - - - - - - server/robot/robot | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/robot/robot

-
- -
-
-

Index

-
-

Classes

-
- - Robot -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_robot_robot_socket.html b/docs/modules/server_robot_robot_socket.html deleted file mode 100644 index f14f6bb6..00000000 --- a/docs/modules/server_robot_robot_socket.html +++ /dev/null @@ -1,1059 +0,0 @@ - - - - - - server/robot/robot-socket | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/robot/robot-socket

-
- -
-
-

Index

-
-

Classes

-
- - RobotSocket -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_robot_square.html b/docs/modules/server_robot_square.html deleted file mode 100644 index 0069128c..00000000 --- a/docs/modules/server_robot_square.html +++ /dev/null @@ -1,1059 +0,0 @@ - - - - - - server/robot/square | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/robot/square

-
- -
-
-

Index

-
-

Classes

-
- - Square -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_robot_types.html b/docs/modules/server_robot_types.html deleted file mode 100644 index 4505e68c..00000000 --- a/docs/modules/server_robot_types.html +++ /dev/null @@ -1,1086 +0,0 @@ - - - - - - server/robot/types | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/robot/types

-
- -
-
-

Index

-
-

Enumerations

-
- - PieceType - - Side -
-
-
-

Functions

-
- - getStartHeading -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/server_utils_units.html b/docs/modules/server_utils_units.html deleted file mode 100644 index 0f1ec629..00000000 --- a/docs/modules/server_utils_units.html +++ /dev/null @@ -1,1094 +0,0 @@ - - - - - - server/utils/units | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

Module server/utils/units

-
- -
-
-

Index

-
-

Variables

-
- - DEGREE - - FULL_ROTATION - - RADIAN -
-
-
-

Functions

-
- - clampHeading -
-
-
-
-
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/variables/server_robot_pair.ZERO_INDICES.html b/docs/variables/server_robot_pair.ZERO_INDICES.html deleted file mode 100644 index 3d98ca56..00000000 --- a/docs/variables/server_robot_pair.ZERO_INDICES.html +++ /dev/null @@ -1,1063 +0,0 @@ - - - - - - ZERO_INDICES | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Variable ZERO_INDICESConst -

-
-
- ZERO_INDICES: - Indices = ... -
- -
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/variables/server_robot_pair.ZERO_POSITION.html b/docs/variables/server_robot_pair.ZERO_POSITION.html deleted file mode 100644 index 5d476bf4..00000000 --- a/docs/variables/server_robot_pair.ZERO_POSITION.html +++ /dev/null @@ -1,1063 +0,0 @@ - - - - - - ZERO_POSITION | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Variable ZERO_POSITIONConst -

-
-
- ZERO_POSITION: - Position = ... -
- -
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/variables/server_utils_units.DEGREE.html b/docs/variables/server_utils_units.DEGREE.html deleted file mode 100644 index d607e3e0..00000000 --- a/docs/variables/server_utils_units.DEGREE.html +++ /dev/null @@ -1,1066 +0,0 @@ - - - - - - DEGREE | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Variable DEGREEConst -

-
-
- DEGREE: - number = ... -
-
-

- The value of a degree in radians. Usage: 90 * DEGREE - - Converts 90 degrees to radians (= 1.57) 1.57 / DEGREE - - Converts radians to degrees (= 90) -

-
-
- -
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/variables/server_utils_units.FULL_ROTATION.html b/docs/variables/server_utils_units.FULL_ROTATION.html deleted file mode 100644 index 8b507bb2..00000000 --- a/docs/variables/server_utils_units.FULL_ROTATION.html +++ /dev/null @@ -1,1060 +0,0 @@ - - - - - - FULL_ROTATION | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Variable FULL_ROTATIONConst -

-
-
- FULL_ROTATION: - number = ... -
- -
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/variables/server_utils_units.RADIAN.html b/docs/variables/server_utils_units.RADIAN.html deleted file mode 100644 index f3b9f61a..00000000 --- a/docs/variables/server_utils_units.RADIAN.html +++ /dev/null @@ -1,1062 +0,0 @@ - - - - - - RADIAN | utd-chess-bots - - - - - - - - - - -
-
- -
- - -
-
-
-
-
-
- -

- Variable RADIANConst -

-
-
- RADIAN: - 1 = 1 -
-
-

The value of a radian in radians.

-
-
- -
-
-
-
-
- -

- - Settings -

- -
-
-

Member Visibility

-
-
    -
  • - -
    • -
  • - -
    • -
  • - -
    • -
  • - -
    • -
-
-
-
-

Theme

- -
-
-
-
-
-
- -
-
-
-
-

- Generated using - TypeDoc -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/readme.md b/readme.md index caf81451..36baab6d 100644 --- a/readme.md +++ b/readme.md @@ -16,4 +16,4 @@ To run tests, use the `Run tests` VS Code task. ## Documentation -Documentation can be found in the `./docs` folder. To generate documentation, run `npx typedoc` in the root folder. +Documentation can be found at [chessbots.cometrobotics.org](https://chessbots.cometrobotics.org). Documentation is autogenerated by `typedoc` using GitHub Actions and deployed to GitHub Pages. From 336ffe377bab943a7c0677ae0e71202216596164 Mon Sep 17 00:00:00 2001 From: Mason Thomas Date: Tue, 6 Feb 2024 00:14:21 -0600 Subject: [PATCH 2/2] Create CNAME --- docs/CNAME | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/CNAME diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 00000000..e003deda --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +chessbots.cometrobotics.org \ No newline at end of file