diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..07f4fd4e --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.idea/ +target/ + +#macOS +.DS_STORE diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e10e1ae0 --- /dev/null +++ b/.nojekyll @@ -0,0 +1,2 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn +off this behavior by setting the `githubPages` option to false. diff --git a/2.2.0/.nojekyll b/2.2.0/.nojekyll new file mode 100644 index 00000000..e2ac6616 --- /dev/null +++ b/2.2.0/.nojekyll @@ -0,0 +1 @@ +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/2.2.0/assets/highlight.css b/2.2.0/assets/highlight.css new file mode 100644 index 00000000..a3badc9f --- /dev/null +++ b/2.2.0/assets/highlight.css @@ -0,0 +1,137 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #d4d4d4; + --light-hl-1: #0000ff; + --dark-hl-1: #569cd6; + --light-hl-2: #0070c1; + --dark-hl-2: #4fc1ff; + --light-hl-3: #795e26; + --dark-hl-3: #dcdcaa; + --light-hl-4: #001080; + --dark-hl-4: #9cdcfe; + --light-hl-5: #a31515; + --dark-hl-5: #ce9178; + --light-hl-6: #098658; + --dark-hl-6: #b5cea8; + --light-hl-7: #af00db; + --dark-hl-7: #c586c0; + --light-hl-8: #008000; + --dark-hl-8: #6a9955; + --light-hl-9: #000000ff; + --dark-hl-9: #d4d4d4; + --light-hl-10: #267f99; + --dark-hl-10: #4ec9b0; + --light-hl-11: #000000; + --dark-hl-11: #c8c8c8; + --light-code-background: #ffffff; + --dark-code-background: #1e1e1e; +} + +@media (prefers-color-scheme: light) { + :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --code-background: var(--light-code-background); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --code-background: var(--dark-code-background); + } +} + +:root[data-theme="light"] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --code-background: var(--light-code-background); +} + +:root[data-theme="dark"] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --code-background: var(--dark-code-background); +} + +.hl-0 { + color: var(--hl-0); +} +.hl-1 { + color: var(--hl-1); +} +.hl-2 { + color: var(--hl-2); +} +.hl-3 { + color: var(--hl-3); +} +.hl-4 { + color: var(--hl-4); +} +.hl-5 { + color: var(--hl-5); +} +.hl-6 { + color: var(--hl-6); +} +.hl-7 { + color: var(--hl-7); +} +.hl-8 { + color: var(--hl-8); +} +.hl-9 { + color: var(--hl-9); +} +.hl-10 { + color: var(--hl-10); +} +.hl-11 { + color: var(--hl-11); +} +pre, +code { + background: var(--code-background); +} diff --git a/2.2.0/assets/icons.js b/2.2.0/assets/icons.js new file mode 100644 index 00000000..c27b1d1c --- /dev/null +++ b/2.2.0/assets/icons.js @@ -0,0 +1,21 @@ +(function () { + addIcons(); + function addIcons() { + if (document.readyState === "loading") + return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild( + document.createElementNS("http://www.w3.org/2000/svg", "svg"), + ); + svg.innerHTML = `""`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach((el) => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})(); diff --git a/2.2.0/assets/icons.svg b/2.2.0/assets/icons.svg new file mode 100644 index 00000000..e371b8b5 --- /dev/null +++ b/2.2.0/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/2.2.0/assets/main.js b/2.2.0/assets/main.js new file mode 100644 index 00000000..5f0de445 --- /dev/null +++ b/2.2.0/assets/main.js @@ -0,0 +1,2211 @@ +"use strict"; +window.translations = { + copy: "Copy", + copied: "Copied!", + normally_hidden: + "This member is normally hidden due to your filter settings.", +}; +("use strict"); +(() => { + var Pe = Object.create; + var ie = Object.defineProperty; + var Oe = Object.getOwnPropertyDescriptor; + var _e = Object.getOwnPropertyNames; + var Re = Object.getPrototypeOf, + Me = Object.prototype.hasOwnProperty; + var Fe = (t, e) => () => ( + e || t((e = { exports: {} }).exports, e), e.exports + ); + var De = (t, e, n, r) => { + if ((e && typeof e == "object") || typeof e == "function") + for (let i of _e(e)) + !Me.call(t, i) && + i !== n && + ie(t, i, { + get: () => e[i], + enumerable: !(r = Oe(e, i)) || r.enumerable, + }); + return t; + }; + var Ae = (t, e, n) => ( + (n = t != null ? Pe(Re(t)) : {}), + De( + e || !t || !t.__esModule + ? ie(n, "default", { value: t, enumerable: !0 }) + : n, + t, + ) + ); + var ue = Fe((ae, le) => { + (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 (m) { + return new t.Token( + t.utils.asString(m).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, + m = new RegExp(a), + p = new RegExp(u), + b = new RegExp(l), + g = new RegExp(d), + L = /^(.+?)(ss|i)es$/, + f = /^(.+?)([^s])s$/, + y = /^(.+?)eed$/, + S = /^(.+?)(ed|ing)$/, + w = /.$/, + k = /(at|bl|iz)$/, + _ = new RegExp("([^aeiouylsz])\\1$"), + B = 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)$/, + q = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/, + V = + /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/, + $ = /^(.+?)(s|t)(ion)$/, + C = /^(.+?)e$/, + z = /ll$/, + W = new RegExp("^" + s + i + "[^aeiouwxy]$"), + H = function (c) { + var v, P, 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 = f), + h.test(c) + ? (c = c.replace(h, "$1$2")) + : x.test(c) && (c = c.replace(x, "$1$2")), + (h = y), + (x = S), + h.test(c)) + ) { + var E = h.exec(c); + (h = m), h.test(E[1]) && ((h = w), (c = c.replace(h, ""))); + } else if (x.test(c)) { + var E = x.exec(c); + (v = E[1]), + (x = g), + x.test(v) && + ((c = v), + (x = k), + (O = _), + (M = B), + 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); + (v = E[1]), (c = v + "i"); + } + if (((h = j), h.test(c))) { + var E = h.exec(c); + (v = E[1]), (P = E[2]), (h = m), h.test(v) && (c = v + e[P]); + } + if (((h = q), h.test(c))) { + var E = h.exec(c); + (v = E[1]), (P = E[2]), (h = m), h.test(v) && (c = v + n[P]); + } + if (((h = V), (x = $), h.test(c))) { + var E = h.exec(c); + (v = E[1]), (h = p), h.test(v) && (c = v); + } else if (x.test(c)) { + var E = x.exec(c); + (v = E[1] + E[2]), (x = p), x.test(v) && (c = v); + } + if (((h = C), h.test(c))) { + var E = h.exec(c); + (v = E[1]), + (h = p), + (x = b), + (O = W), + (h.test(v) || (x.test(v) && !O.test(v))) && (c = v); + } + return ( + (h = z), + (x = p), + 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(H); + }; + })()), + 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), + m = s.str.charAt(1), + p; + m in s.node.edges + ? (p = s.node.edges[m]) + : ((p = new t.TokenSet()), (s.node.edges[m] = p)), + s.str.length == 1 && (p.final = !0), + i.push({ + node: p, + 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], m = 0; m < l; m++) { + var p = a[m]; + if (p == d || d == "*") { + var b = r.node.edges[p], + g = r.qNode.edges[d], + L = b.final && g.final, + f = void 0; + p in r.output.edges + ? ((f = r.output.edges[p]), (f.final = f.final || L)) + : ((f = new t.TokenSet()), + (f.final = L), + (r.output.edges[p] = f)), + i.push({ qNode: g, output: f, 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, + m = t.Set.empty; + u.usePipeline + ? (d = this.pipeline.runString(u.term, { fields: u.fields })) + : (d = [u.term]); + for (var p = 0; p < d.length; p++) { + var b = d[p]; + 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 f = 0; f < u.fields.length; f++) { + var y = u.fields[f]; + o[y] = t.Set.empty; + } + break; + } + for (var S = 0; S < L.length; S++) + for ( + var w = L[S], k = this.invertedIndex[w], _ = k._index, f = 0; + f < u.fields.length; + f++ + ) { + var y = u.fields[f], + B = k[y], + A = Object.keys(B), + j = w + "/" + y, + q = new t.Set(A); + if ( + (u.presence == t.Query.presence.REQUIRED && + ((m = m.union(q)), + o[y] === void 0 && (o[y] = t.Set.complete)), + u.presence == t.Query.presence.PROHIBITED) + ) { + a[y] === void 0 && (a[y] = t.Set.empty), + (a[y] = a[y].union(q)); + continue; + } + if ( + (i[y].upsert(_, u.boost, function (Ie, Ce) { + return Ie + Ce; + }), + !s[j]) + ) { + for (var V = 0; V < A.length; V++) { + var $ = A[V], + C = new t.FieldRef($, y), + z = B[$], + W; + (W = r[C]) === void 0 + ? (r[C] = new t.MatchData(w, y, z)) + : W.add(w, y, z); + } + s[j] = !0; + } + } + } + if (u.presence === t.Query.presence.REQUIRED) + for (var f = 0; f < u.fields.length; f++) { + var y = u.fields[f]; + o[y] = o[y].intersect(m); + } + } + for ( + var H = t.Set.complete, R = t.Set.empty, l = 0; + l < this.fields.length; + l++ + ) { + var y = this.fields[l]; + o[y] && (H = H.intersect(o[y])), a[y] && (R = R.union(a[y])); + } + var c = Object.keys(r), + v = [], + P = Object.create(null); + if (n.isNegated()) { + c = Object.keys(this.fieldVectors); + for (var l = 0; l < c.length; l++) { + var C = c[l], + T = t.FieldRef.fromString(C); + r[C] = new t.MatchData(); + } + } + for (var l = 0; l < c.length; l++) { + var T = t.FieldRef.fromString(c[l]), + h = T.docRef; + if (H.contains(h) && !R.contains(h)) { + var x = this.fieldVectors[T], + O = i[T.fieldName].similarity(x), + M; + if ((M = P[h]) !== void 0) + (M.score += O), M.matchData.combine(r[T]); + else { + var E = { ref: h, score: O, matchData: r[T] }; + (P[h] = E), v.push(E); + } + } + } + return v.sort(function (ke, Qe) { + return Qe.score - ke.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], + m = d[0], + p = d[1]; + r[m] = new t.Vector(p); + } + 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), + m = new t.FieldRef(r, o), + p = Object.create(null); + (this.fieldTermFrequencies[m] = p), + (this.fieldLengths[m] = 0), + (this.fieldLengths[m] += d.length); + for (var b = 0; b < d.length; b++) { + var g = d[b]; + if ( + (p[g] == null && (p[g] = 0), + (p[g] += 1), + this.invertedIndex[g] == null) + ) { + var L = Object.create(null); + (L._index = this.termIndex), (this.termIndex += 1); + for (var f = 0; f < i.length; f++) + L[i[f]] = Object.create(null); + this.invertedIndex[g] = L; + } + this.invertedIndex[g][o][r] == null && + (this.invertedIndex[g][o][r] = Object.create(null)); + for (var y = 0; y < this.metadataWhitelist.length; y++) { + var S = this.metadataWhitelist[y], + 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], + m = Object.keys(d), + p = m.length, + b = this._fields[a].boost || 1, + g = this._documents[o.docRef].boost || 1, + L = 0; + L < p; + L++ + ) { + var f = m[L], + y = d[f], + S = this.invertedIndex[f]._index, + w, + k, + _; + i[f] === void 0 + ? ((w = t.idf(this.invertedIndex[f], this.documentCount)), + (i[f] = w)) + : (w = i[f]), + (k = + (w * ((this._k1 + 1) * y)) / + (this._k1 * + (1 - this._b + this._b * (l / this.averageFieldLength[a])) + + y)), + (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 ae == "object" + ? (le.exports = n()) + : (e.lunr = n()); + })(this, function () { + return t; + }); + })(); + }); + var se = []; + function G(t, e) { + se.push({ selector: e, constructor: t }); + } + var U = class { + constructor() { + this.alwaysVisibleMember = null; + this.createComponents(document.body), + this.ensureFocusedElementVisible(), + this.listenForCodeCopies(), + window.addEventListener("hashchange", () => + this.ensureFocusedElementVisible(), + ), + document.body.style.display || + (this.ensureFocusedElementVisible(), + this.updateIndexVisibility(), + this.scrollToHash()); + } + createComponents(e) { + se.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(); + } + showPage() { + document.body.style.display && + (document.body.style.removeProperty("display"), + this.ensureFocusedElementVisible(), + this.updateIndexVisibility(), + this.scrollToHash()); + } + scrollToHash() { + if (location.hash) { + let e = document.getElementById(location.hash.substring(1)); + if (!e) return; + e.scrollIntoView({ behavior: "instant", block: "start" }); + } + } + 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 && !Ve(e)) { + let r = + e.getBoundingClientRect().top - + document.documentElement.clientHeight / 4; + (document.querySelector(".site-menu").scrollTop = r), + (document.querySelector(".col-sidebar").scrollTop = r); + } + } + updateIndexVisibility() { + let e = document.querySelector(".tsd-index-content"), + n = e?.open; + e && (e.open = !0), + document.querySelectorAll(".tsd-index-section").forEach((r) => { + r.style.display = "block"; + let i = Array.from(r.querySelectorAll(".tsd-index-link")).every( + (s) => s.offsetParent == null, + ); + r.style.display = i ? "none" : "block"; + }), + e && (e.open = n); + } + 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) return; + let r = n.offsetParent == null, + i = n; + for (; i !== document.body; ) + i instanceof HTMLDetailsElement && (i.open = !0), (i = i.parentElement); + if (n.offsetParent == null) { + (this.alwaysVisibleMember = n), n.classList.add("always-visible"); + let s = document.createElement("p"); + s.classList.add("warning"), + (s.textContent = window.translations.normally_hidden), + n.prepend(s); + } + r && e.scrollIntoView(); + } + 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 = window.translations.copied), + e.classList.add("visible"), + clearTimeout(n), + (n = setTimeout(() => { + e.classList.remove("visible"), + (n = setTimeout(() => { + e.textContent = window.translations.copy; + }, 100)); + }, 1e3)); + }); + }); + } + }; + function Ve(t) { + let e = t.getBoundingClientRect(), + n = Math.max(document.documentElement.clientHeight, window.innerHeight); + return !(e.bottom < 0 || e.top - n >= 0); + } + var oe = (t, e = 100) => { + let n; + return () => { + clearTimeout(n), (n = setTimeout(() => t(), e)); + }; + }; + var pe = Ae(ue()); + async function ce(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 = pe.Index.load(i.index)), + e.classList.remove("loading"), + e.classList.add("ready"); + } + function fe() { + 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", () => { + ce(e, t); + }), + ce(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", + ); + i.addEventListener("mouseup", () => { + te(t); + }), + r.addEventListener("focus", () => t.classList.add("has-focus")), + He(t, i, r, e); + } + function He(t, e, n, r) { + n.addEventListener( + "input", + oe(() => { + Ne(t, e, n, r); + }, 200), + ), + n.addEventListener("keydown", (i) => { + i.key == "Enter" + ? Be(e, t) + : i.key == "ArrowUp" + ? (de(e, n, -1), i.preventDefault()) + : i.key === "ArrowDown" && (de(e, n, 1), i.preventDefault()); + }), + document.body.addEventListener("keypress", (i) => { + i.altKey || + i.ctrlKey || + i.metaKey || + (!n.matches(":focus") && + i.key === "/" && + (i.preventDefault(), n.focus())); + }), + document.body.addEventListener("keyup", (i) => { + t.classList.contains("has-focus") && + (i.key === "Escape" || + (!e.matches(":focus-within") && !n.matches(":focus"))) && + (n.blur(), te(t)); + }); + } + function te(t) { + t.classList.remove("has-focus"); + } + 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 = he(l.name, i); + globalThis.DEBUG_SEARCH_WEIGHTS && + (d += ` (score: ${s[o].score.toFixed(2)})`), + l.parent && + (d = ` + ${he(l.parent, i)}.${d}`); + let m = document.createElement("li"); + m.classList.value = l.classes ?? ""; + let p = document.createElement("a"); + (p.href = r.base + l.url), + (p.innerHTML = u + d), + m.append(p), + p.addEventListener("focus", () => { + e.querySelector(".current")?.classList.remove("current"), + m.classList.add("current"); + }), + e.appendChild(m); + } + } + function de(t, e, n) { + let r = t.querySelector(".current"); + if (!r) + (r = t.querySelector(n == 1 ? "li:first-child" : "li:last-child")), + r && r.classList.add("current"); + else { + let i = r; + if (n === 1) + do i = i.nextElementSibling ?? void 0; + while (i instanceof HTMLElement && i.offsetParent == null); + else + do i = i.previousElementSibling ?? void 0; + while (i instanceof HTMLElement && i.offsetParent == null); + i + ? (r.classList.remove("current"), i.classList.add("current")) + : n === -1 && (r.classList.remove("current"), e.focus()); + } + } + function Be(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), te(e); + } + } + function he(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( + ee(t.substring(s, o)), + `${ee(t.substring(o, o + r.length))}`, + ), + (s = o + r.length), + (o = n.indexOf(r, s)); + return i.push(ee(t.substring(s))), i.join(""); + } + var je = { + "&": "&", + "<": "<", + ">": ">", + "'": "'", + '"': """, + }; + function ee(t) { + return t.replace(/[&<>"'"]/g, (e) => je[e]); + } + var I = class { + constructor(e) { + (this.el = e.el), (this.app = e.app); + } + }; + var F = "mousedown", + ye = "mousemove", + N = "mouseup", + J = { x: 0, y: 0 }, + me = !1, + ne = !1, + qe = !1, + D = !1, + ve = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( + navigator.userAgent, + ); + document.documentElement.classList.add(ve ? "is-mobile" : "not-mobile"); + ve && + "ontouchstart" in document.documentElement && + ((qe = !0), (F = "touchstart"), (ye = "touchmove"), (N = "touchend")); + document.addEventListener(F, (t) => { + (ne = !0), (D = !1); + let e = F == "touchstart" ? t.targetTouches[0] : t; + (J.y = e.pageY || 0), (J.x = e.pageX || 0); + }); + document.addEventListener(ye, (t) => { + if (ne && !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(N, () => { + ne = !1; + }); + document.addEventListener("click", (t) => { + me && (t.preventDefault(), t.stopImmediatePropagation(), (me = !1)); + }); + var X = class extends I { + constructor(e) { + super(e), + (this.className = this.el.dataset.toggle || ""), + this.el.addEventListener(N, (n) => this.onPointerUp(n)), + this.el.addEventListener("click", (n) => n.preventDefault()), + document.addEventListener(F, (n) => this.onDocumentPointerDown(n)), + document.addEventListener(N, (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 re; + try { + re = localStorage; + } catch { + re = { + getItem() { + return null; + }, + setItem() {}, + }; + } + var Q = re; + var ge = document.head.appendChild(document.createElement("style")); + ge.dataset.for = "filters"; + var Y = class extends I { + 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()), + (ge.innerHTML += `html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`), + this.app.updateIndexVisibility(); + } + 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(), + this.app.updateIndexVisibility(); + } + }; + var Z = class extends I { + 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 Ee(t) { + let e = Q.getItem("tsd-theme") || "os"; + (t.value = e), + xe(e), + t.addEventListener("change", () => { + Q.setItem("tsd-theme", t.value), xe(t.value); + }); + } + function xe(t) { + document.documentElement.dataset.theme = t; + } + var K; + function we() { + let t = document.getElementById("tsd-nav-script"); + t && (t.addEventListener("load", Le), Le()); + } + async function Le() { + 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(); + (K = t.dataset.base), K.endsWith("/") || (K += "/"), (t.innerHTML = ""); + for (let s of i) Se(s, t, []); + window.app.createComponents(t), + window.app.showPage(), + window.app.ensureActivePageVisible(); + } + function Se(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-accordion` : "tsd-accordion"; + let o = s.appendChild(document.createElement("summary")); + (o.className = "tsd-accordion-summary"), + (o.dataset.key = i.join("$")), + (o.innerHTML = + ''), + be(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) Se(u, l, i); + } else be(t, r, t.class); + } + function be(t, e, n) { + if (t.path) { + let r = e.appendChild(document.createElement("a")); + (r.href = K + t.path), + n && (r.className = n), + location.pathname === r.pathname && 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-accordion"); + G(Y, ".tsd-filter-item input[type=checkbox]"); + var Te = document.getElementById("tsd-theme"); + Te && Ee(Te); + var $e = new U(); + Object.defineProperty(window, "app", { value: $e }); + fe(); + we(); +})(); +/*! 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/2.2.0/assets/navigation.js b/2.2.0/assets/navigation.js new file mode 100644 index 00000000..7221460c --- /dev/null +++ b/2.2.0/assets/navigation.js @@ -0,0 +1,2 @@ +window.navigationData = + "data:application/octet-stream;base64,H4sIAAAAAAAAE43XbW/TMBAH8O+S14Oxsg3Yu2pboRLrxhohJISQm1xSM8fO7PNgoH131PQhTmKf8zb/u18TXxKn3/8lCH8wuUimK6XxWmulk6OkZrhOLpJMMGPAHLfZ6zVWIjlKHrjMk4uTyfuXo1awuAaJPGPIlQxRw6KYqTT/GyO7NZR4KThIHCrb4/HOS6EM5IFTGZTEPVKKG0oa1IxLnDEurIYQ562LyAgyhzzVTBqWEQMIllL+FUNYol0NuX1CdqvMVt457pMx3fdQgAaZQZg5lFDedbWCPId8CZ4TckLKmDErWWCB24wUALN16PZ2QsqYyycmeH4PjxZM6N70FFHmjcqt8Czx9jjVuWAV5OFRd+LRDjF0fx0pA/5W+iGwUG5KKiqHT2l6NwlNr1dAWlYIYsmclFLuWOlZn81RsksrVJkSgeXoxJTzxYJ+HvY3h6N9l2vIQgPpFUSteyuRV6GX6qAk6qW8AmVDz9WghPKWoJ94Fjo1Nx2hzCWCliw0OF8VreIcQTP0Y4eQNFADq0IPhJvGlVQ9gAwhTUgZKStLyNPnGmZKV8xzNv0KUltrhSi4LAOL3SsgLV4F9tB9MuJ7RsmCl1Y3X08txDezLljWftS4dV12cnbuboYyrxWXaLzYIaWIzauuP3nHaOMY4r+JelT4XuqCzeN5W2+u339tbkEU2u2eYWhXQEHLmvlHtgnIxuaSpzmrEbRfcCsoar+bpC2Dz7XzBZX2ut98eHdyNukNarAaW8OJximmVtKAn9lmMadZ+6kuexvoFuqEo6Td57YX2mWjnLkslBfZBCMFBF0r0XvQO5RTMcpcInOfc8dqknGGzTIwAWWbjXK+MmH969wk443b1S/I/KN38pjnvlUC79gtHCyM/UJzMjPNSt+d2glj0ufbxcefN9NvLfLENGcrAeZ4n3WNt8P2+SLcPl8Q7TDcMNr+Q/jqhCCKR9E2F1Y2f0HNcfEouk3np05TCXgFBbMCfftNq/jqCJYb/6uoBbsVJOXfwFwqvHudn778+A/R+fOk4BEAAA=="; diff --git a/2.2.0/assets/search.js b/2.2.0/assets/search.js new file mode 100644 index 00000000..a3dce0ae --- /dev/null +++ b/2.2.0/assets/search.js @@ -0,0 +1,2 @@ +window.searchData = + "data:application/octet-stream;base64,H4sIAAAAAAAAE7VdXY/jxo79L57XTkekvuctSG52A+z92GRwsUAjMDS23O07bqsjy5NJgvz3hUqSzWKxJEp2nrphlUhW1SGL4qmS/ljV1a+n1funP1af9sft6j1g9rA6Fq/l6v3q28O+PDarh9W5PqzerzaH4nQqT193Pz++NK+H1cPw6+r9avXnwyAlBrxI2VTHU1OfN01Vj4l6Z7cjYh9Wb0XdGnKx6KoIE4Qouug6FKfmw5fjh9OoJtpqmZ6Nuf5tddztn8910eyr43jfxPZa3UGUEc3VqZzQ1bVYIv2teN4fi2ZcAWm0RMcv57L+bVTB0GKJ9FNTl8XrqPhLE6V86hI/mXs9jkEv3sU9HIEqJ7FsJN0IMLJhtNUoHBrO0sWmpKgVg/VuaLdck+wcnk7N1uSGmnXjBhpX27Xl8p49FaffjpsfmrIumqr+WaF1bd2xnqs9vCK0PG7fqv2R9PVzUe+Lj4fy9PXl2lcwiniME7asyMFzf2zKeldsLi5rNRtVwfDd3rxu9q9ldW7WH8+7XVmvX09zFL0bETIWOuyeeQwcBm6WQeSmmw3YVfVrMU/95Zablb80zRuuT+XptK+O6/32UM6dG5+EO5n2WnxZd+vEErPsu2+fqrLZvKw/leVbcdh/LufNmXPvzeacyk1dzkPO5ZablZvc4OKSM2dHuPlmgw77Y1nU+9/JaqoxxbrtdiOq4/O6+e1tHjboXTeb0GJ+Ux2b8ti2WtdlU+/LedPjFXEv1BTPi/DS3bbEiCSOw+vCt54/RVcLHtezp+qR2O8ZmKYuNmUvY45d9n03z0/bs81Lufk0zwhy113wWzRN+frWzEctufEuhnwsNp+q3W62Hdf7lphBk7S/OUkfseFyUZ+QbctdcT6IILOlvbu2lPtwtcwbDDfFQaFoaHeLmpfqpOkTbatXh0GeQoziw6ecPrceYT8M6PPn0VilEfxuIkL5zR9JxcQH7hnWPApCZpo3RF712jvHvOk1eKldYkCbY5oqsN1iHY9yc42binZLbWMJ7hyzJhLdxRY1RXM+rcvP5XHhZHIJt9tHqmLffKzq5m91LZSwrpfuUhFj4lT1MGKdZ3iLtsWkrqHVUi1dJGqnYVKV1fSqrzltv9qfvtofX8p635hHhxn6N9XWLY65A7ot76jTZKA/HHfVpGLa8n49btFR7I/NelfsD+e6nB56+Z5bLKKOcm5e2qebjXEqj8e4be7jOh65Oh8SDF8Ac58JS/Cut0gGvn845niA3ooRV/CZssAn5oyKwjnGMbPQS8ZtZO5S1fvfJ7zFbnI3ZxHEqn2FWb3MVSQDFnqKzh6vo8hDMdNPdDaMu4lkyDIv0Y6Izkn8WFnuI34LHY5e9g1y7Y5s/UxvoAaOdeFbQzSOdYS0uGN3uNQZnaIme7p2gcD3HQI8/ROb3aeTftG6nso9uMFdpi3yu8xyy0ZC7ZhBC8Lt3BETQu74EM0Iu/Ns8YfeMYPmh99pq2wXasrjttx+qIvjqdj4UwFvy3s50oh0rS95urIItGPmLMPtPOt80B0fpnnonWfRKIDHzFqE4bmjpQqN0xhbllCo7CVu931xPhayn10v3cWxmDiVJxHrZPN/OH4uDvvtj+Uv5/LkSY+ENnfpkE+uqmeS4fOjg9eEBXFhhkViRBgZjhmxYIYV/ijgNWW+/88alWnPn8DMMp+fsJG4yz/K5teq/iT7Cb14FwdxBKo8w7JR7sa/6qqpNtVB7od19S4dcSWqemKbOd+7BbUev1ZpJQP4v60ffNtS6vIQsut3GURJpmoYubHzB1JUvSBEKi0Rw6On+zNCo1K7PyyKJswPiepRmA6HI5hYFgpHbOPw//F8bHeIjTgAbXE/F3Ck6p3AMnmhG7jqlzqCxhq/K0jDMNcZNBZMuINrxkKH0I2G0iV8GLnBKXz2cbf40O2aHHEL2uJ+buFI1buFZfIIs+4ZbFfz0Hi+ztHNNRqtU9v/3Hs7YxdGA9eKpdFAMwn+aCDN/txooLFgIhq4ZiyMBrrRUEYDn2vcEA189tEjUGX9eb/xrI/04n2OQHGBuiNQ1Mb5LuAqVeTXGp0i0KUubkf2gyn0+OHsKpORPL9n06D1zaWu3u+zwoXmD+0+zGPheQyUGt0Tqq7gOZC1bV8MXcGIBQF8jk1j0BaHZEYYn2PHJPQFY+YH83kjo3YNL3aWhfQpK4nrfHipq6Y57I/Pstew63dxGEmmyle4sfPdRFS9wEOUlojO4en+DL9Qave7hGjCfG9Qj8K0I4xgYpkPjNjGH3HkLOt+jzIzH198Z4HLoz9fHs6JjmYQrnT7nIG5/k39fH51N91b18bPE5ADjL9cz2PszkdDPp2+3v1yGBVAjiD/zz//8V/rv3/zf8IJ5OHSPFE//MMr6od/jJ9qoUGzeH4utx9+eyu/t0/TXtDMGoyfkVZMsihwar4dM0d1mtXirTrIb7UYM4DfeZs123LGCFwaz9apXqxEvarVaqzDguf9uzicy39+/E+5EZ2PXL71PI8ob+oYj2OjpjtexRMeIcjr94xIEvtL82VaiyMR2P5+l0G+CFKNrjHHd1Tyy3HtnAERdTxemk6omjp8snkpX4v157I+uWfNZM3OLTdacH59Lcj6PKr60vY2ncKR4TG1iqPC6t5aJcnRvk7XI2V9HieQAr+lnzQYdzJyktTc+s83s+ZLRyXpdf150qJPQXQi39HmI6M1mOlR6n9nhqtx4mUZGnXjrxZwVSreKaBSO/YyAUHr5AlGjVL96wNcC2a+N0BjzvgLA1wTtO6vUzv6dguv8unXWmhMmHgjgKtd8yoAleKxdwAIaicP/2uU+t9l4mqcONvpUeeEwn47jldnf10fCu0Xqo2Jm3izmmXe4rhrKVTGXVepuEL95FsZzYW7JGpXSapM7acxkm1Tvb6dm3JdvU0YPazn9g1TaifSiLostnrVpPWNen9tSzB6xbT5jZqvcZCGzlHt/JYbLTg1VV08l+uPvzXlad2Oqc4M8b672mKGeYkxw403WjOytk+4xLx1XWOL560IHgsmX4EwplcOY+fNpjzJ6rtL6uT6p7dCfHle+7t+BTnVm1Eh77oGHuKqNcH/KFOLKx0RPf7WxxHh5VHMi6+iuwbzBQ8lynHppJVKBYeCKX98XxfPQpXVunbruuYKm1rabNM8o/RZqOt4VT0OrRUKx9818V3RlD81549OgW64oK+x7urKfVOsJeZd30S2+mLKiPzvpLfpujq+G3ufrqDHfreSuV7vj88TmqyGy/rUVIoeXRot1aHqDWmmHzeKpGpjMxwXNf2FuzA/ljBVvfhil+9ByWXNbCUja9Wk7OYwJbzxvzNLkM4mlpW1PSquzdR6VBvsZDWPwz9fwdQuu4sA515/3nOYHFGvHY/t3V/BAnMmMqC9++pntU377V9h0TSo/Ra1bx/+CyyadoURk5q/ZN4UaOqb6MjxqXAwiZP99iZdQjT+sdyVdXnc+L330uKu8dmWOitQX01eMm2O4sN0gJ3UODJxTN/enyOPaiNT97fXj+V2W25/Kt3ITq7dZbq4PNVEUQN9z4S7plRoG5rN0kOG6u/V9nxwod39fJcBIqJUY9Nb5BkW82dMRd9AK5ueOSxey603B7Ou3ufUoSNRd+zQMlO/egnqRvIylZZt0RQaPX27eZp0iZrUq6lszadRlbKNKJyRt9lSbkveZlk0lcFNGDaRDojeOc++VsRfZp/SLRZmdrfZpnWmEetaEX+ZfVrszcr3VGFGiyon9C/S7FsR/Hmg3Oz+a8SCjNDTg8VTPCc3nKd7epKZ7tGFflo3nebz4eBf98nF+0wpF6ibSGqjl2DbKbR1rZZr2RRn4ZtGQq/6dvM00ZcnFM+unvbHu0zDRZDuDQmtLXMC91X8aPIzJld+ArgKHk/9uWTrVFIzfIZJOPdxuTavbi1vWOfi3tGmHpaCWDeir+1fu0tap5K0nqNVf9KK6dQdsJru6KEl+9xNz24fLw0X6zqWX4SPonFFfavFWuqyOdeKDl3aLdbUvNTVr9OKhmaL9Ux+CY1rVH8ITdTtfvzvQ/VJgsj12l3iJZc348t/nYG+lFxl/buh2Sw99GTE/lVm6YYLN7J0lphxlu5iylyWztUxymoJeuyS3MlHa9mKaLtlPfJwdLaaCY5uWoeqM5McnajHJsqHvOUDI5svv6vP63zffgzN8/FOcu0uDszl6d5rRwz0RnR7+6BX37XhYl2ej6k6qia+qKrQJH+50x3D0Q93ynrIObTnsvmu+7rQf3/48C8GhOvBNKnZ+CYM6uXtPT+Wp7fqSHp0FW430IsVP4RDxaq/Pms9i1XbsrUHPV7Bruuj9nPZzBD5jjb3PMEwS2e6h6h1ykWUOj1uIqqccBWlRtldRIXjLqPUtz99K38wWFRJWs/WSva2CT5KNmIpXXMUHH5xk9AgxqnmaETV+Ax5FNlLZBdS7M51iyS5cus+Mi5qahcZNcpX3LC/sOvs2vWofJTumzRiTkF4XP1ojUGv8aUstmWt7fO19a16X8vmpeI7k31qL40XaJVhypZGql6zKGqBSmTpkNrb5Rm0j9WWH0D06Xns204ruwEgglodQlSaT/ZrMyYUn8bfjDSul4d8MdFh4VOd64yt01Myp9Zqx1jPFm3T5Jtt8Ubri3RLMW2g37RtnS4YFfdu9ECBbZ83UHsWM0Hb+HrmU6f9VK5P4RQFbN/X2fjnzw+r/XFbflm9/2M1HFZ+v8LH8DFfPax2+/KwPa3ePw1syaZ67UmL7VBL/7lv9u+yfbBrG3etvw5WD0/BQ4yPGcQ///zwNNxsLpgfBhnXX8yNsHp4ggfExyBOrRvBuRGsG3H18ISSRnRuROvGcPXwFD5E6WMa2BpD58bQujFaPTxFD2H2CDFaN0bOjZF1Y7x6eIolU2Pnxti6MVk9PCUPUfQYRrbGxLkxsW5MVw9P6UMEjxnm1o2pc2Nq3ZitHp4yydTMuTGzbsx985g7N+Y2AFo85JJKcLEDDDwGPYE0mSDgxwYQoG8+wYUQ2BiCFhkAotUujMDGEbToABStdqEENpagRQiI+AUXTmDjCRIf9sFFFNiQghYoEIlddlEFNqygBQuIPgAussCGFhhsJaLZLrrAhhe2iIFUDBQuvtDGFxp8if6ALr6QBagWMiAiG4UYZQMMW8hgIPk+ugBDG2DYQgZBGjB0AYY2wLCFDIroRBdgaAMMW8xgKJrtIgxthGGLGYxEzS7C0EYYtpjBWNTsIgxthGGLGUweQnhMgN3sIgxthIUtZjAVVxQXYaGNsLDFDGbizS7CQhthoVkDc/FmF2EhWwbNOijGzlBYCW2EhZE3CoUuwkIbYWGLmVAMnqGLsNBGWGhCmLjwhy7CQhthYYuZMBRvdhEW2ggLW8yEYgAMXYSFNsJCP8JCF2GhjbCoxUwYS6MduQiLbIRF4HXJyEVYZCMs8iMschEW2QiL/AiLXIRFLNmKvAEwEvItG2GRQVgiTVXkIiyyERYZhIkrRuQiLLIRFqW+PChyARbZAIsMwMTVJnIBFtkAi1rIhPlDGDxmUWjf7AIssgEWt5CJAgmdsQuw2AZY3EImAklz7AIstgEWmyQMRc0uwGIbYHELmUh059gFWGwDLI58MxW7+IpZQh97BzsWcnobX3HiH2wXX7GNrzj1D7YLsNgGWJz5B9sFWGwDLG4hE4nhL3YBFtsASwLfYCcuvhIbXwl4Bztx8ZXY+ErQO9iJi6/ExlcSegc7cfGV2PhKIu9gJy7AEhtgSQuZSMyXExdgCXtqTLyDLTw32vhKDL7EyJm4+EpsfCWZV7ELr8SGV2LgJUbdxIVXYsMr9cIrdeGV2vBKwTtPqQuv1IZXil5spi68UhteaejFZurCK7XhlUZebKYuvFIbXqmBl7jSpC68UhteqRdeqQuvlNUlUv94CaUJG15p5h8vF1+pja8094+Xi6/UxlcWeDGSuQDLbIBlBmDic2DmAiyzAZahb7AzF1+Zja+sRUwsVuUyF1+Zja/MuzxmLrwyG16Zf3nMXHhlNrwy//KYufjKbHxl/uUxc/GVsdqXf3nMhPKXja+sRUwsPtRkLr4yG1+5N37lLrxyG155C5hYfCDKXXjlNrxyL7xyF165Da889M5y7sIrt+GVt4iJxdQtd/GV2/jKY6/VLrxyG1554rfahVduwytPvdjMXXjlNrzyzIvN3IVXzsqruRebuVBh5SXWFjKxXLsLpCorK7MG/ip9INRZA1ZoDfyrZHeN38+KrYF/oeyu8ftZvTXwr5XdNX4/K7kGsXfwu2v8flZ1DVoUxXL1MxAKrwGrvAbeh8ruEr+d1V6DFkqxXD8NhOprwMqvgb920V3j9zP0maK9Z/qlGr9T5Af/9Itlfga/rtAvT79U6ue1flO+90y/VO3n5X5TwY/F1Bakgj+v+IM33IFU8uc1f/BHPJDK/rzuD/6gB1Lln5f+wR/3QCr+8+o/+EMfSPV/RgCAqenHYrILAgUAjAMA9Ac/gQQAxgIAjgQ/gQcARgQAjgQ/gQoAxgUAjgQ/gQ0ARgcAjgQ/gRAAxgiAKfLHMsEncALASAFAf/ATWAFgtACYSr9v+AX0MWYATLHfN/wC+hg5AKbe7xl+gR4Axg9A6H88BYEhAEYRgKn6ixwyCBwBMJIATN1fHn2BJQBGE4Cp/CcyQSsQBcCYAjDF/8TDswrgY2QBmPp/IibHINAFwPgCMBRAIqapIDAGwCgDMCxAIideAmkAjDUAQwQkcuYg8AbAiAMwXIBn/AXqABh3AIYOSMRyEAjsATD6AAwjkMhLn0AgAGMQIPLDT6AQgHEIYGiBRA79AosAjEYAwwx4Mh+BSADGJIAhBxI59glcAjAyAQxBkIpP8CDwCcAIBYhGll6BUgDGKUA0kvkJrAIwWgEMU5DK7isQC8CYBTBkQSq7r8AtACMXwPAFqey+Ar0AjF8AQxnIpDIIDAMwigEMbeDJvAWWARjNAIY5SOXwIRANwJgGMORBKocPgWsARjaA4Q9Sj/0C/hjfAIZC8OzcEBgHYJQDGBZB3osAAukAjHUAwyTI3CcIxAMw5gEMmSDvSACBewBGPoDhEzz4EegHYPwDGEpB3sgBAgMBjIIAwyrIWxNAICGAsRBgiAV5dwIIPAQwIgIMuSCTuCBwEcDICDD8QiovHwIdAYyPAMMxyMmPwEgAoyTAsAwe+AukBDBWAgzTkMrLj0BMAGMmwJANnvArcBPAyAkwfEMqLz8CPQGMnwBDOWTy8iMwFMAoCjCsQyaHf4GkAMZSgCEeMjn8CzwFMKICDPmQyeFf4CqAkRVg+IfMs+VN2vPG4GcoiEwOvwJjAYyyAMNCZHL2JZAWwFgLMEREJruPwFsAIy7AcBGZjF+BugDGXYDhIzIZfwJ9AYy/AENJeLZ3CgwGMAoDDC2Ry/gVWAxgNAYYZiKX8SsQGcCYDDDkRC7jV+AygJEZYPgJj/8LdAYwPgMMRZHL+BcYDWCUBhiWIpfxL5AawFgNMExFLu5bAoHYAMZsgCErcs/GTwF/jNwAQ1jkMv4FfgMYwQGGs8jl5U+gOIBxHGBoi1zcPQUCywGM5oCO5whkAAtUBzCuA3IvVQsC2QGM7QBDYEAA0kZyEAgPYIwHGBIDAjmBE0gPYKwHGCIDAnnLskB8AGM+0DAZnp2dAvOBjPnAjvkIxG3iKHAfyLgPNFwGBPLGVIH8QEZ+YBD6JwEF9gMZ+4GGzfBMAgr0BzL6A4N4bAyEPcGM/0DDZ3jHQNgXzAgQ7AiQQFwJUaBAkFEgGHh3pqDAgCBjQDDIx0ZA2CHMKBA0lIZvBAQOBBkHgv1JB3kfu0CCICNBELxMLwocCDIOBLsDD4EYC1EgQZCRINgdegjk7fACC4KMBUE/C4ICC4KMBUHDakCbTAhuJNAgyGgQ7M4/yGc+UOBBkPEgCH4MCjQIMhoEu1MQnjgg8CDID0J0JyHacyeCAOksBD8M0REhcjBG6TyEcyAC/cFYPBLBQIjhiBtKxyL4uQjDbfhAIB2N4GcjMB6ZBOl4BD8fgcnYJAgw5GckOjrENwYCDPk5CUNweMdAACI/K2EYDgAxrUTpuASjRDD07nZBgRFBxohgOLYkC5QIMkoEDcfhGwGBFEFGimBHishnoVCgRZDRIhh6N1ehwIogY0XQsBwgH6dCgRZBRotg2KFQXk8FXgQZL4JhFwzl5UggRpARIxj6g6HAiyDjRTDMR9xIIEaQESMYBSPrmcCMIGNG0DAd4DkbJlAjyKgRjDoUyguiwI0g40aw40ZQfDpAgR1Bxo5g5EehQI4gI0fQkB2A8oIosCPI2BE0bAegfIhXoEeQ0SPYHbZAORIJ/AgyfgQN3wEoO7JAkCAjSNAQHvJRThQIEmQECRrCA1D2ZIEhQcaQYOzdnIACQYKMIEFDeADKgUBgSJAxJBh3IJQDgUCRIKNI0FAeco0ABYoEGUWChvKQawQoUCTIKBKMOxDKfixwJMg4EjSch1wkQIEjQcaRoOE85CIBChwJMo4E4w6CchwRSBJkJAl2ZzNCOY4ILAkylgQTPwYFkgQZSYKG9IAQ5EOjAgYZS4KG9RBPu6NAkiAjSTDxnutHgSNBxpFg0h3IlqOYQJIgI0mwO64hn0pEgSVBxpKgYT1APpmIAk2CjCbB7txGKEchgShBRpSgIT5APnCHAlOCjCnB7gCHBwMCVYKMKkFDfcgYEJgSZEwJpt53AaBAlCAjStAQHyCfGUSBKUHGlGDanaeVo5BAlSCjSjCNxwZQQCHjStBwH54REDDIqBJMOwzKUUjgSpBxJWi4D8+zocCVIONK0HAfEMlRTCBLkJElmI09HgtsCTK2BA37AZF87F6gS5DRJdid9YjkSCLwJcj4Euz4EvlAJAqECTLCBA0B4pkEgTBBRpigIUBAPiSIAmOCjDFBw4B4x1DAIaNMMOveUiGHMoEzQcaZoOFA5LPWKHAmyDgTNByIHIgEygQZZYLdSRD5AB4KnAkyzgTzDoVyKBJIE2SkCeb+UChwJsg4EzQciO9VCgIE+9/Mq4k+l3VTbn/oXlH09HR5LdIfq3X/3iK8vDPpjxXmq/d//PmwCvu/7b7z7p8oHv4Zfkmh/ydLu3/aQn/3D2L/T5r1/2RR/08etv/8eX0Tkvl5sN1caztTfKzab/perQyzq5VRppdR1nX7tlwiKCWCEp2g7r39VxntQ+51zCDs+xYFOnHXL9pfRaZkFto9P93QJrlOYvt+8v3lCwHEUCRShymIlEIvX62+ysuolalSzrl5ab+/vSna98w68xGFV5GxEhzn5qWq9797BEZEoM7E7m17ZNiojDagaoT0n88gUoB6VqjD2qZ/a91VTHAVosMXe7Xlx/NuV9bmDZe0h3Qil4jl8oiZqERGJ9G8SG3rTiMZvGSOhZvquNs/n+ui+7Q28fyrwHDwrxlyXQtjYqESI92L7YgMEox6m4bYmQz+ml6iaTIEUdRr21J1OZl1JZiqrW0wmee4j/dxb1fSG5r2wztE/6y/ng9hLRjGH4Y1BIZLOFxCJYbMB41oaKauG8CwNMXDP/mwRg1RG4flKwSlxte3c1Ouqzc7gNOxTZUTZF7oXuyPzXpX7A/nurRERiR6x/3Yxv2YDugYVuGsn4usv55fVvBh4YbLoA+XcLik7vlgbm+t6xJkcVWuXdZL7ck8ktHse9T9ifrpivsBSPqOJwMI+wFI+98Hp8n6ARwykby/nve/58NgDJhpz/z1AzZcwuHSgJn2cEafFg3/5IOTBkPuc/HoQU7LQ/aQGzKmcHD2cLgUDb/EA4YT9Sw15XFbbpu6OJ6KjbxIkgQmVcYuI7eVtq7Lpt7bWM1iCn9dgta9BJkumATwLVXaO+gwokNWipkudrUfqz/1H48gMZBgFJSRtJPUfoyEyKFLaKYD+7bk8TSh1kRKa7pPC1hrG/GXUDeflx+s6BnQwZknqL5+b49KpElQoFvIhx9s25BEWFRmdmX/Pd1TyfqZ0gRe51jl0Zk8OlqDC4PyMaATZ95L+1YdnGwloal2pLXQXu2peV3c04h4q/YMFdS3da49iLGTRJKBDbEw1Jm1K87Hwo1iBBGZboh27Rc+1p/K8q047D/bUKX40nmikeam7G3l/yoq0eHh8kUwCnni1hjp3HFX1a+FbQ6F0rD4x7qJ3P1ipVcJfaBUPtJ031YisKRwGpZhjJVAqKvXrfnsEBFo9W9YLmPlcNXV69vlY3N07OkcRron01bYL93H8uiyRoGljPHDd1msftKkSPlU+lw2Ej5pUFYmas9l0y88L03zJgmlq7fygejywnn6KElBnw3TmenA1tqG69fiy7p797ot2irbzJB3Kk/tm73X++2h5E++dCXRebpv/Kh1qc4dWlGXD41QWRRyqW7V7WQN31agExLSCdF5QitseKk/SVOIWUMhMe5XgqSf6eFxN+1z7Ky/nvcZ9pBgt6806fPzYPhnuDQUINuj53prW7y48xKScBUN0SrTyd1v7awjplgZHguCIb9VPpLvj5+Lw37bT7uzKMYkbikna39ySwVAC6WYagV5QRRSECU6Z96fKjd/Jx+favNArSTf9LYkLzFM5yqH4tSsWXJDg7NutFopzReWJNEgqpOyP5ZFvf/dnj6kcobnV2XSfKg2hbXq08iuXPSNjJfKDksUA6FypKvjcxvOrSSE5pGz5OztFJs+wYU6jzZyHArFwnZ3ZzTUCpTpX7tkSSV3+tQT9iFDmUO0Ij8Wm0/VbmfNAgkQQ/1Cmd+0EsfrAEi96UJj6Nba4UNBdOmhMM6U3a62Z5bLBXQ5BN3SatpbDk4TwmGpabcz9/9cijo6M1tRW/EhnIYSVFbnLWnykzh9/EJlefVYNr9W9Sd3kSEmKmsf3YeIaRync6uk4o7VtjQpmRTI6eqa6Nz5eD4c5DmgOA513vFmvn9OhdAlVBmo3orn/ZE94JCO6dLqt7pqqk11cOeNjHmu80rneYYSM72DD4EJlMNuZK6b4tmOHXQCs2HNunA1OrfqRe9feaKe0UdXZc3zKsylvOxn88FIHVKM3IEHtsbWyiJmGLl5KTeCmxKXz3Vhz0jr6/sWv0GLSZEOy0bW/rirrKIN6eJQ2x4I72RgjgZ2o39GGLYY5AMqgmHA4fIQMFy6zMVQXAflfoHeWk89LqXJgrK2YCRWb+b7qpYsWgFRZrBGlvCol9ICsjJ97WSdjy2wXczQjga65MUIbB/37G5m1OPmSDpvNuXJ9l7aTWX938jqndftJp2DYMYcfC4OZ7sKTJk/5Tp2lVR9/E+5sWMAHbZI57Xd99lo4kSXHmWkb4VwWjOjbq98CqzLnb0M0riuDGpiUYNG3OTCig/P5MqYXpfNuWZlVpoZKWPbafNSvhbr4ZtvFPZ0oYl1Q38qN7VNUVjlxyFLvywzOpSdyvrzfiO4OHUmZTrcyzLx8VgImQVFrbIQdiobcdeSVadTch+nt8KahYzaoyQHTvXGEkEdW/nwcWqKmlFNdKz7+VPWZZyIGtNKd3BJkZQz6JTjILIyLiXwjZh1+ZlvYaNFZSVXcWqqungu1x9/a8rTmgexjD7np0rIWxJ/rfd2Jp1Z+560He4+4kk8nJDnffAZMhdMLwVr3WNRJ70YPu5JJ8famKn0KE+ViziDLhmigvw7qshoKusnndym+sSZLorEWNnZ8+trYT+bpBbFqHPZpnh+LrdtTcelzhKaJYS6GW1e6qppDvvjsxskaURBHaJbcb/aY0WfTZXJbZsG8R0M7RkzMui6mNRUDv1GI+1QpcdY51wCEijstVNYuWlUe6qe2HXZ96VbChqh8pzT2csv+3OUE1AXm7L/lixd5skUXB5YEl1AZwXogD475pdN2cOEwGUEdLG5adjGOprWDA9iGChN/XJk9fKUWqt0+NZHzYOuNYIEfuGl6Krro5PL5xQzSpLHCNnVxTN/mM/piCn5S7NiOUk4HSsNM/jzw+pt/1a21MDq/dPPf/75/8F+OxCm/QAA"; diff --git a/2.2.0/assets/style.css b/2.2.0/assets/style.css new file mode 100644 index 00000000..7e5ec04d --- /dev/null +++ b/2.2.0/assets/style.css @@ -0,0 +1,1444 @@ +: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-focus-outline: #3584e4; + + --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-color-document: #000000; + + --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-focus-outline: #4c97f2; + + --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-color-document: #ffffff; + + --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-focus-outline: var(--light-color-focus-outline); + + --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); + --color-document: var(--light-color-document); + + --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-focus-outline: var(--dark-color-focus-outline); + + --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); + --color-document: var(--dark-color-document); + + --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-focus-outline: var(--light-color-focus-outline); + + --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); + --color-document: var(--light-color-document); + + --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-focus-outline: var(--dark-color-focus-outline); + + --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); + --color-document: var(--dark-color-document); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +*:focus-visible, +.tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +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; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +footer > p { + margin: 0 1em; +} + +.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: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + 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; +} +a.tsd-anchor-link { + color: var(--color-text); +} + +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: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + 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-visible + svg { + outline: 2px solid var(--color-focus-outline); +} +.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); +} + +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; +} + +.tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; +} + +.tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; +} + +.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-navigation .tsd-nav-link { + display: none; +} +.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-section { + margin-left: 10px; +} +.tsd-page-navigation-section > summary { + padding: 0.25rem; +} +.tsd-page-navigation-section > div { + margin-left: 20px; +} +.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 { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + 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-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; +} +.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: 2rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} +.tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; +} + +#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-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; +} +.tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; +} +.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%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } +} + +/* 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/2.2.0/classes/AbortError.html b/2.2.0/classes/AbortError.html new file mode 100644 index 00000000..f7cf3ad5 --- /dev/null +++ b/2.2.0/classes/AbortError.html @@ -0,0 +1,1185 @@ + + + + + + AbortError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class AbortError

+
+
+
+

An error due to calling the FQL abort function.

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + abort + + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+
    +
  • + new AbortError(failure, + httpStatus?): AbortError + +
    • +
  • +
    +

    Parameters

    +
      +
    • + failure: + QueryInfo & {
          error: {
              abort?: QueryValue;
              code: string;
              constraint_failures?: ConstraintFailure[];
              message: string;
          };
      } & {
          error: {
              abort: QueryValue;
          };
      }       +
      • +
    • + OptionalhttpStatus: + number +
      • +
    +
    +

    + Returns + AbortError +

    + +
    • +
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Readonlyabort + +

+
+ abort: + QueryValue +
+
+

+ The user provided value passed to the originating + abort() call. Present only when the query + encountered an abort() call, which is denoted by + the error code "abort" +

+
+
+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/AuthenticationError.html b/2.2.0/classes/AuthenticationError.html new file mode 100644 index 00000000..3ee71073 --- /dev/null +++ b/2.2.0/classes/AuthenticationError.html @@ -0,0 +1,1089 @@ + + + + + + AuthenticationError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class AuthenticationError

+
+
+
+

AuthenticationError indicates invalid credentials were used.

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/AuthorizationError.html b/2.2.0/classes/AuthorizationError.html new file mode 100644 index 00000000..0259839f --- /dev/null +++ b/2.2.0/classes/AuthorizationError.html @@ -0,0 +1,1092 @@ + + + + + + AuthorizationError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class AuthorizationError

+
+
+
+

+ AuthorizationError indicates the credentials used do not have + permission to perform the requested action. +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/Client.html b/2.2.0/classes/Client.html new file mode 100644 index 00000000..a62d4473 --- /dev/null +++ b/2.2.0/classes/Client.html @@ -0,0 +1,1465 @@ + + + + + + Client | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class Client

+
+
+
+

Client for calling Fauna.

+
+
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Accessors

+
+ + clientConfiguration + + lastTxnTs +
+
+
+

Methods

+
+ + close + + paginate + + query + + stream +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+
    +
  • + new Client(clientConfiguration?, + httpClient?): Client + +
    • +
  • +
    +

    + Constructs a new + Client. +

    +
    +
    +

    Parameters

    +
      +
    • + OptionalclientConfiguration: + ClientConfiguration +
      +

      + the + ClientConfiguration + to apply. Defaults to recommended + ClientConfiguraiton. +

      +
      +
      +
      • +
    • + OptionalhttpClient: + HTTPClient +
      +

      + The underlying + HTTPClient + that will execute the actual HTTP calls. Defaults to + recommended HTTPClient. +

      +
      +
      +
      • +
    +
    +

    + Returns + Client +

    +
    +

    + Example + +

    + 
     const myClient = new Client(
      {
        endpoint: endpoints.cloud,
        secret: "foo",
        query_timeout_ms: 60_000,
      }
    );
+
    +
    + +
    • +
+
+
+
+
+ +

+ + + + Accessors +

+ +
+
+ +

+ clientConfiguration + +

+ +
+
+ +

+ lastTxnTs + +

+
    +
  • + get lastTxnTs(): undefined | number +
    • +
  • +

    + Returns undefined | number +

    +

    + the last transaction time seen by this client, or undefined + if this client has not seen a transaction time. +

    +
    + +
    • +
  • + set lastTxnTs(ts): void +
    • +
  • +
    +

    Sets the last transaction time of this client.

    +
    +
    +

    Parameters

    +
      +
    • + ts: + undefined | number +
      +

      + the last transaction timestamp to set, as + microseconds since the epoch. If ts is + less than the existing #lastTxnTs value + or is undefined , then no change is made. +

      +
      +
      +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ close + +

+
    +
  • + close(): void + +
    • +
  • +
    +

    + Closes the underlying HTTP client. Subsquent query or + close calls will fail. +

    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+ +

+ paginate + +

+
    +
  • + paginate<T>(iterable, + options?): SetIterator<T> + +
    • +
  • +
    +

    + Creates an iterator to yield pages of data. If additional + pages exist, the iterator will lazily fetch addition pages + on each iteration. Pages will be retried in the event of a + ThrottlingError up to the client's configured + max_attempts, inclusive of the initial call. +

    +
    +
    +

    Type Parameters

    +
      +
    • + T extends QueryValue +
      +

      + The expected type of the items returned from Fauna + on each iteration. T can be inferred if the provided + query used a type parameter. +

      +
      +
      +
      • +
    +
    +
    +

    Parameters

    + +
    +

    + Returns + SetIterator<T> +

    +

    + A + SetIterator + that lazily fetches new pages of data on each iteration +

    +
    +

    + Example + +

    + 
     const userIterator = await client.paginate(fql`
       Users.all()
     `);

     for await (const users of userIterator) {
       for (const user of users) {
         // do something with each user
       }
     }
+
    + +

    + Example + +

    +

    + The + SetIterator.flatten + method can be used so the iterator yields items directly. + Each item is fetched asynchronously and hides when + additional pages are fetched. +

    + 
     const userIterator = await client.paginate(fql`
       Users.all()
     `);

     for await (const user of userIterator.flatten()) {
       // do something with each user
     }
+
    +
    + +
    • +
+
+
+ +

+ query + +

+
    +
  • + query<T>(query, + options?): Promise<QuerySuccess<T>> + +
    • +
  • +
    +

    + Queries Fauna. Queries will be retried in the event of a + ThrottlingError up to the client's configured + max_attempts, inclusive of the initial call. +

    +
    +
    +

    Type Parameters

    +
      +
    • + T extends QueryValue +
      +

      + The expected type of the response from Fauna. T can + be inferred if the provided query used a type + parameter. +

      +
      +
      +
      • +
    +
    +
    +

    Parameters

    +
      +
    • + query: + Query<T> +
      +

      + a + Query + to execute in Fauna. Note, you can embed header + fields in this object; if you do that there's no + need to pass the headers parameter. +

      +
      +
      +
      • +
    • + Optionaloptions: + QueryOptions +
      +

      + optional + QueryOptions + to apply on top of the request input. Values in this + headers parameter take precedence over the same + values in the + ClientConfiguration. +

      +
      +
      +
      • +
    +
    +

    + Returns Promise<QuerySuccess<T>> +

    +

    + Promise<QuerySuccess>. +

    +
    +

    + Throws + +

    +

    + ServiceError + Fauna emitted an error. The ServiceError will be one of + ServiceError's child classes if the error can be further + categorized, or a concrete ServiceError if it cannot. You + can use either the type, or the underlying httpStatus + + code to determine the root cause. +

    +

    + Throws + +

    +

    + ProtocolError + the client a HTTP error not sent by Fauna. +

    +

    + Throws + +

    +

    + NetworkError + the client encountered a network issue connecting to + Fauna. +

    +

    + Throws + +

    +

    + A + ClientError + the client fails to submit the request +

    +

    + Throws + +

    +

    + ClientClosedError + if a query is issued after the client is closed. due to an + internal error. +

    +
    + +
    • +
+
+
+ +

+ stream + +

+
    +
  • + stream<T>(tokenOrQuery, + options?): StreamClient<T> + +
    • +
  • +
    +

    Initialize a streaming request to Fauna

    +
    +
    +

    Type Parameters

    +
      +
    • + T extends QueryValue +
      +

      + The expected type of the response from Fauna. T can + be inferred if the provided query used a type + parameter. +

      +
      +
      +
      • +
    +
    +
    +

    Parameters

    + +
    +

    + Returns + StreamClient<T> +

    +

    + A + StreamClient + that which can be used to listen to a stream of events +

    +
    +

    + Example + +

    + 
     const stream = client.stream(fql`MyCollection.all().toStream()`)

     try {
       for await (const event of stream) {
         switch (event.type) {
           case "update":
           case "add":
           case "remove":
             console.log("Stream update:", event);
             // ...
             break;
         }
       }
     } catch (error) {
       // An error will be handled here if Fauna returns a terminal, "error" event, or
       // if Fauna returns a non-200 response when trying to connect, or
       // if the max number of retries on network errors is reached.

       // ... handle fatal error
     };
+
    + +

    + Example + +

    + 
     const stream = client.stream(fql`MyCollection.all().toStream()`)

     stream.start(
       function onEvent(event) {
         switch (event.type) {
           case "update":
           case "add":
           case "remove":
             console.log("Stream update:", event);
             // ...
             break;
         }
       },
       function onError(error) {
         // An error will be handled here if Fauna returns a terminal, "error" event, or
         // if Fauna returns a non-200 response when trying to connect, or
         // if the max number of retries on network errors is reached.

         // ... handle fatal error
       }
     );
+
    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Accessors + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/ClientClosedError.html b/2.2.0/classes/ClientClosedError.html new file mode 100644 index 00000000..974796c9 --- /dev/null +++ b/2.2.0/classes/ClientClosedError.html @@ -0,0 +1,888 @@ + + + + + + ClientClosedError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class ClientClosedError

+
+
+
+

+ An error thrown if you try to call the client after it has been + closed. +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + message + + name + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/ClientError.html b/2.2.0/classes/ClientError.html new file mode 100644 index 00000000..851bd354 --- /dev/null +++ b/2.2.0/classes/ClientError.html @@ -0,0 +1,884 @@ + + + + + + ClientError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class ClientError

+
+
+
+

+ An error representing a failure internal to the client, itself. + This indicates Fauna was never called - the client failed + internally prior to sending the request. +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + message + + name + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/ConstraintFailureError.html b/2.2.0/classes/ConstraintFailureError.html new file mode 100644 index 00000000..ca21bf8a --- /dev/null +++ b/2.2.0/classes/ConstraintFailureError.html @@ -0,0 +1,1141 @@ + + + + + + ConstraintFailureError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class ConstraintFailureError

+
+
+
+

A runtime error due to failing schema constraints.

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+
    +
  • + new ConstraintFailureError(failure, + httpStatus?): ConstraintFailureError + +
    • +
  • +
    +

    Parameters

    +
      +
    • + failure: + QueryInfo & {
          error: {
              abort?: QueryValue;
              code: string;
              constraint_failures?: ConstraintFailure[];
              message: string;
          };
      } & {
          error: {
              constraint_failures: ConstraintFailure[];
          };
      }       +
      • +
    • + OptionalhttpStatus: + number +
      • +
    +
    +

    + Returns + ConstraintFailureError +

    + +
    • +
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Readonlyconstraint_failures + +

+
+ constraint_failures: + ConstraintFailure[] +
+
+

The list of constraints that failed.

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/ContendedTransactionError.html b/2.2.0/classes/ContendedTransactionError.html new file mode 100644 index 00000000..1f393dd8 --- /dev/null +++ b/2.2.0/classes/ContendedTransactionError.html @@ -0,0 +1,1095 @@ + + + + + + + ContendedTransactionError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class ContendedTransactionError

+
+
+
+

An error due to a contended transaction.

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/DateStub.html b/2.2.0/classes/DateStub.html new file mode 100644 index 00000000..108b4b6d --- /dev/null +++ b/2.2.0/classes/DateStub.html @@ -0,0 +1,752 @@ + + + + + + DateStub | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class DateStub

+
+
+
+

+ A wrapper aroud the Fauna Date type. It represents a + calendar date that is not associated with a particular time or + time zone, e.g. August 24th, 2006. Convert to and from Javascript + Date's with the + DateStub.fromDate + and + DateStub.toDate + methods. Javascript Dates are rendered in UTC time before the date + part is used. See remarks for possible precision loss when doing + this. If precision loss is a concern consider using a 3rd party + datetime library such as luxon. +

+
+
+

+ Remarks + +

+

+ The Javascript Date type always has a time associated + with it, but Fauna's Date type does not. When + converting from a Fauna Date to a Javascript + Date, we set time to 00:00:00 UTC. When converting a + Javascript Date or time string to Fauna + Date, we convert to UTC first. Care should be taken + to specify the desired date, since Javascript Dates + use local timezone info by default. +

+

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#date +

+
+
+ +
+
+
+ + + +
+
+

Properties

+
+ + dateString +
+
+
+

Methods

+
+ + toDate + + toString + + from + + fromDate +
+
+
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ ReadonlydateString + +

+
+ dateString: + string +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ toDate + +

+
    +
  • + toDate(): Date + +
    • +
  • +
    +

    + Get a copy of the TimeStub converted to a + Javascript Date. Does not mutate the existing + TimeStub value. +

    +
    +

    + Returns Date +

    +

    A Date

    +
    + +
    • +
+
+
+ +

+ toString + +

+
    +
  • + toString(): string + +
    • +
  • +
    +

    Override default string conversion

    +
    +

    + Returns string +

    +

    the string representation of a DateStub

    +
    + +
    • +
+
+
+ +

+ Staticfrom + +

+
    +
  • + from(dateString): DateStub + +
    • +
  • +
    +

    + Creates a new + DateStub + from a date string +

    +
    +
    +

    Parameters

    +
      +
    • + dateString: + string +
      +

      + A plain date string. The time is converted to UTC + before saving the date. +

      +
      +
      +
      • +
    +
    +

    + Returns + DateStub +

    +

    + A new + DateStub +

    +
    +

    + Throws + +

    +

    + TypeError if a string is not provided, or RangeError if + dateString is not a valid date +

    +
    + +
    • +
+
+
+ +

+ StaticfromDate + +

+
    +
  • + fromDate(date): DateStub + +
    • +
  • +
    +

    + Creates a new + DateStub + from a Javascript Date +

    +
    +
    +

    Parameters

    +
      +
    • + date: + Date +
      +

      + A Javascript Date. The time is + converted to UTC before saving the date. +

      +
      +
      +
      • +
    +
    +

    + Returns + DateStub +

    +

    + A new + DateStub +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/Document.html b/2.2.0/classes/Document.html new file mode 100644 index 00000000..bd9385d3 --- /dev/null +++ b/2.2.0/classes/Document.html @@ -0,0 +1,931 @@ + + + + + + Document | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class Document

+
+
+
+

+ A materialized Document with an ID. Keys, Tokens and Documents in + user-defined Collections are modeled with a + Document. All + top level Document fields are added to a + Document + instance, but types cannot be provided. Cast the instance to a + DocumentT + to have typesafe access to all top level fields. +

+

+ The example below retrieves a document from a hypothetical + "Users" collection. +

+
+
+

+ Example + +

+ 
 const response = await client.query(fql`
   Users.byId("101")
 `);
 const userDocument = response.data;

 const color = userDocument.color;
+
+ +

+ Remarks + +

+

+ The + Document class + cannot be generic because classes cannot extend generic type + arguments. +

+

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#special +

+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + coll + + id + + ts + + ttl? +
+
+
+

Methods

+
+ + toObject +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Readonlycoll + +

+
+ coll: + Module +
+ +
+
+ +

+ Readonlyid + +

+
+ id: + string +
+ +
+
+ +

+ Readonlyts + +

+
+ ts: + TimeStub +
+ +
+
+ +

+ Optional + Readonlyttl + +

+
+ ttl?: + TimeStub +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ toObject + +

+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/DocumentReference.html b/2.2.0/classes/DocumentReference.html new file mode 100644 index 00000000..ea745f59 --- /dev/null +++ b/2.2.0/classes/DocumentReference.html @@ -0,0 +1,590 @@ + + + + + + DocumentReference | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class DocumentReference

+
+
+
+

+ A reference to a Document with an ID. The Document may or may not + exist. References to Keys, Tokens, and Documents in user-defined + Collections are modeled with a + DocumentReference. +

+

+ The example below retrieves a document reference from a + hypothetical "Users" collection. +

+
+
+

+ Example + +

+ 
 const response = await client.query(fql`
   Users.byId("101")
 `);
 const userDocumentReference = response.data;

 const id = userDocumentReference.id;
 id === "101"; // returns true
+
+ +

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#special +

+
+
+
+

+ Hierarchy (view full) +

+
    +
  • + DocumentReference + +
    • +
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + coll + + id +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Readonlycoll + +

+
+ coll: + Module +
+ +
+
+ +

+ Readonlyid + +

+
+ id: + string +
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/EmbeddedSet.html b/2.2.0/classes/EmbeddedSet.html new file mode 100644 index 00000000..3f118560 --- /dev/null +++ b/2.2.0/classes/EmbeddedSet.html @@ -0,0 +1,477 @@ + + + + + + EmbeddedSet | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class EmbeddedSet

+
+
+
+

+ A un-materialized Set. Typically received when a materialized Set + contains another set, the EmbeddedSet does not contain any data to + avoid potential issues such as self-reference and infinite + recursion +

+
+
+

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#set +

+
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + after +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Readonlyafter + +

+
+ after: + string +
+
+

+ A pagination cursor, used to obtain additional information in + the Set. +

+
+
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/FaunaError.html b/2.2.0/classes/FaunaError.html new file mode 100644 index 00000000..5f000ffe --- /dev/null +++ b/2.2.0/classes/FaunaError.html @@ -0,0 +1,851 @@ + + + + + + FaunaError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class FaunaErrorAbstract

+
+
+
+

A common error base class for all other errors.

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + message + + name + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+
    +
  • + new FaunaError(...args): FaunaError + +
    • +
  • +
    +

    Parameters

    +
      +
    • + Rest...args: + any[] +
      • +
    +
    +

    + Returns + FaunaError +

    + +
    • +
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/FetchClient.html b/2.2.0/classes/FetchClient.html new file mode 100644 index 00000000..36812ba3 --- /dev/null +++ b/2.2.0/classes/FetchClient.html @@ -0,0 +1,751 @@ + + + + + + FetchClient | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class FetchClient

+
+
+
+

+ An implementation for + HTTPClient + that uses the native fetch API +

+
+
+
+
+

Implements

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Methods

+
+ + close + + request + + stream +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ close + +

+
    +
  • + close(): void + +
    • +
  • +
    +

    + Flags the calling + Client as + no longer referencing this HTTPClient. Once no + Client + instances reference this HTTPClient the underlying + resources will be closed. It is expected that calls to + this method are only made by a + Client + instantiation. The behavior of direct calls is undefined. +

    +
    +

    + Returns void +

    +
    +

    + Remarks + +

    +

    + For some HTTPClients, such as the + FetchClient, this method is a no-op as there is no shared resource + to close. +

    +
    + +
    • +
+
+
+ +

+ request + +

+ +
+
+ +

+ stream + +

+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/InvalidRequestError.html b/2.2.0/classes/InvalidRequestError.html new file mode 100644 index 00000000..46bbe0cd --- /dev/null +++ b/2.2.0/classes/InvalidRequestError.html @@ -0,0 +1,1093 @@ + + + + + + InvalidRequestError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class InvalidRequestError

+
+
+
+

+ An error due to an invalid request to Fauna. Either the request + body was not valid JSON or did not conform to the API + specification +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/Module.html b/2.2.0/classes/Module.html new file mode 100644 index 00000000..addbaa0a --- /dev/null +++ b/2.2.0/classes/Module.html @@ -0,0 +1,487 @@ + + + + + + Module | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class Module

+
+
+
+

+ A Fauna module, such as a Collection, Database, Function, Role, + etc. Every module is usable directly in your FQL code. +

+

+ The example below shows FQL code that gets all documents for a + hypothetical 'Users' collection by creating a Module for user and + then calling .all(). +

+

+ You can also create modules for databases, functions, roles and + other entities in your database. +

+
+
+

+ Example + +

+ 
 const response = await client.query(fql`
   ${new Module("Users")}.all()
 `);
 const allUserDocuments = response.data;
+
+ +

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#module +

+
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + name +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Readonlyname + +

+
+ name: + string +
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + +
+ + name +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/NamedDocument.html b/2.2.0/classes/NamedDocument.html new file mode 100644 index 00000000..09006cf1 --- /dev/null +++ b/2.2.0/classes/NamedDocument.html @@ -0,0 +1,996 @@ + + + + + + NamedDocument | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class NamedDocument<T>

+
+
+
+

+ A materialized Document with a name. Specific AccessProviders, + Collections, Databases, Functions, etc. that include user defined + data are modeled with a + NamedDocument. +

+

+ The example below retrieves a NamedDocument for a hypothetical + "Users" collection. +

+
+
+

+ Example + +

+ 
 const response = await client.query(fql`
   Users.definition
 `);
 const userCollectionNamedDocument = response.data;

 const indexes = userCollectionNamedDocument.indexes;
+
+ +

+ Example + +

+

+ All of the named Documents can have optional, user-defined data. + The generic class lets you define the shape of that data in a + typesafe way +

+ 
 type CollectionMetadata = {
   metadata: string
 }

 const response = await client.query<NamedDocument<CollectionMetadata>>(fql`
   Users.definition
 `);
 const userCollection = response.data;

 const metadata = userCollection.data.metadata;
+
+ +

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#special +

+
+
+
+

Type Parameters

+ +
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + coll + + data + + name + + ts +
+
+
+

Methods

+
+ + toObject +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Readonlycoll + +

+
+ coll: + Module +
+ +
+
+ +

+ Readonlydata + +

+
+ data: + T +
+ +
+
+ +

+ Readonlyname + +

+
+ name: + string +
+ +
+
+ +

+ Readonlyts + +

+
+ ts: + TimeStub +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ toObject + +

+
    +
  • + toObject(): {
        coll: Module;
        data: T;
        name: string;
        ts: TimeStub;
    } + +
    • +
  • +

    + Returns {
        coll: Module;
        data: T;
        name: string;
        ts: TimeStub;
    } +

    +
      +
    • +
      + coll: Module +
      +
      • +
    • +
      + data: T +
      +
      • +
    • +
      + name: string +
      +
      • +
    • +
      + ts: TimeStub +
      +
      • +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/NamedDocumentReference.html b/2.2.0/classes/NamedDocumentReference.html new file mode 100644 index 00000000..1259c755 --- /dev/null +++ b/2.2.0/classes/NamedDocumentReference.html @@ -0,0 +1,596 @@ + + + + + + NamedDocumentReference | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class NamedDocumentReference

+
+
+
+

+ A reference to a Document with a name. The Document may or may not + exist. References to specific AccessProviders, Collections, + Databases, Functions, etc. are modeled with a + NamedDocumentReference. +

+

+ The example below retrieves a NamedDocumentReference for a + hypothetical "Users" collection. +

+
+
+

+ Example + +

+ 
 const response = await client.query(fql`
   Users.definition
 `);
 const namedDocumentReference = response.data;

 const collectionName = namedDocumentReference.name;
 collectionName === "Users"; // returns true
+
+ +

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#special +

+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + coll + + name +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Readonlycoll + +

+
+ coll: + Module +
+ +
+
+ +

+ Readonlyname + +

+
+ name: + string +
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/NetworkError.html b/2.2.0/classes/NetworkError.html new file mode 100644 index 00000000..750ef9f1 --- /dev/null +++ b/2.2.0/classes/NetworkError.html @@ -0,0 +1,881 @@ + + + + + + NetworkError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class NetworkError

+
+
+
+

+ An error representing a failure due to the network. This indicates + Fauna was never reached. +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + message + + name + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/NodeHTTP2Client.html b/2.2.0/classes/NodeHTTP2Client.html new file mode 100644 index 00000000..7734722f --- /dev/null +++ b/2.2.0/classes/NodeHTTP2Client.html @@ -0,0 +1,795 @@ + + + + + + NodeHTTP2Client | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class NodeHTTP2Client

+
+
+
+

+ An implementation for + HTTPClient + that uses the node http package +

+
+
+
+
+

Implements

+ +
+ +
+
+
+ + + +
+
+

Methods

+
+ + close + + isClosed + + request + + stream + + getClient +
+
+
+
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ close + +

+
    +
  • + close(): void + +
    • +
  • +
    +

    + Flags the calling + Client as + no longer referencing this HTTPClient. Once no + Client + instances reference this HTTPClient the underlying + resources will be closed. It is expected that calls to + this method are only made by a + Client + instantiation. The behavior of direct calls is undefined. +

    +
    +

    + Returns void +

    +
    +

    + Remarks + +

    +

    + For some HTTPClients, such as the + FetchClient, this method is a no-op as there is no shared resource + to close. +

    +
    + +
    • +
+
+
+ +

+ isClosed + +

+ +
+
+ +

+ request + +

+ +
+
+ +

+ stream + +

+ +
+
+ +

+ StaticgetClient + +

+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/NullDocument.html b/2.2.0/classes/NullDocument.html new file mode 100644 index 00000000..4bf3291d --- /dev/null +++ b/2.2.0/classes/NullDocument.html @@ -0,0 +1,549 @@ + + + + + + NullDocument | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class NullDocument

+
+
+
+

+ A reference to a Document or Named Document that could not be + read. The Document may or may not exist in future queries. The + cause field specifies the reason the document could not be read, + typically because the Document does not exist or due to + insufficient privileges. +

+

+ Some read operations, such as the + <Collection>.byId method may return either a + Document or a NullDocument. This example shows how to handle such + a result with the driver +

+
+
+

+ Example + +

+ 
 const response = await client.query<Document | NullDocument>(fql`
   Users.byId("101")
 `);
 const maybeUserDocument = response.data;

 if (maybeUserDocument instanceof NullDocument) {
   // handle NullDocument case
   const cause = maybeUserDocument.cause
 } else {
   // handle Document case
   const color = maybeUserDocument.color;
 }
+
+ +

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#nulldoc +

+
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause + + ref +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Readonlycause + +

+
+ cause: + string +
+ +
+
+ +

+ Readonlyref + +

+
+ ref: + DocumentReference | NamedDocumentReference +
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/Page.html b/2.2.0/classes/Page.html new file mode 100644 index 00000000..73ab3012 --- /dev/null +++ b/2.2.0/classes/Page.html @@ -0,0 +1,607 @@ + + + + + + Page | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class Page<T>

+
+
+
+

A materialized view of a Set.

+
+
+

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#set +

+
+
+
+

Type Parameters

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + after? + + data +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+
    +
  • + new Page<T>(__namedParameters): Page<T> + +
    • +
  • +
    +

    Type Parameters

    + +
    +
    +

    Parameters

    +
      +
    • + __namedParameters: {
          after?: string;
          data: T[];
      }       +
        +
      • +
        + Optionalafter?: string +
        +
        • +
      • +
        + data: T[] +
        +
        • +
      +
      • +
    +
    +

    + Returns + Page<T> +

    + +
    • +
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optional + Readonlyafter + +

+
+ after?: + string +
+
+

+ A pagination cursor, used to obtain additional information in + the Set. If after is not provided, then + data must be present and represents the last Page + in the Set. +

+
+
+ +
+
+ +

+ Readonlydata + +

+
+ data: + T[] +
+
+

A materialized page of data

+
+
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/ProtocolError.html b/2.2.0/classes/ProtocolError.html new file mode 100644 index 00000000..d71d56bf --- /dev/null +++ b/2.2.0/classes/ProtocolError.html @@ -0,0 +1,932 @@ + + + + + + ProtocolError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class ProtocolError

+
+
+
+

+ An error representing a HTTP failure - but one not directly + emitted by Fauna. +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + httpStatus + + message + + name + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ ReadonlyhttpStatus + +

+
+ httpStatus: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/Query.html b/2.2.0/classes/Query.html new file mode 100644 index 00000000..b67f6ff4 --- /dev/null +++ b/2.2.0/classes/Query.html @@ -0,0 +1,574 @@ + + + + + + Query | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class Query<T>

+
+
+
+

+ Internal class. A builder for composing queries using the + fql + tagged template function +

+
+
+
+
+

Type Parameters

+
    +
  • + T extends QueryValue + = any +
    +

    + The expected type of the response from Fauna when evaluated. T + can be used to infer the type of the response type from + Client + methods. +

    +
    +
    +
    • +
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Methods

+
+ + encode +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+
    +
  • + new Query<T>(queryFragments, + ...queryArgs): Query<T> + +
    • +
  • +
    +

    Type Parameters

    + +
    +
    +

    Parameters

    +
      +
    • + queryFragments: readonly string[] +
      • +
    • + Rest...queryArgs: + QueryArgument[] +
      • +
    +
    +

    + Returns + Query<T> +

    + +
    • +
+
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ encode + +

+
    +
  • + encode(): FQLFragment + +
    • +
  • +
    +

    + Converts this Query to an FQLFragment you can send to + Fauna. +

    +
    +

    + Returns FQLFragment +

    +

    a FQLFragment.

    +
    +

    + Example + +

    + 
     const num = 8;
     const queryBuilder = fql`'foo'.length == ${num}`;
     const queryRequest = queryBuilder.toQuery();
     // produces:
     { fql: ["'foo'.length == ", { value: { "@int": "8" } }, ""] }
+
    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/QueryCheckError.html b/2.2.0/classes/QueryCheckError.html new file mode 100644 index 00000000..51164442 --- /dev/null +++ b/2.2.0/classes/QueryCheckError.html @@ -0,0 +1,1088 @@ + + + + + + QueryCheckError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class QueryCheckError

+
+
+
+

+ An error due to a "compile-time" check of the query + failing. +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/QueryRuntimeError.html b/2.2.0/classes/QueryRuntimeError.html new file mode 100644 index 00000000..a38f17f7 --- /dev/null +++ b/2.2.0/classes/QueryRuntimeError.html @@ -0,0 +1,1094 @@ + + + + + + QueryRuntimeError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class QueryRuntimeError

+
+
+
+

+ An error response that is the result of the query failing during + execution. QueryRuntimeError's occur when a bug in your query + causes an invalid execution to be requested. The 'code' field will + vary based on the specific error cause. +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/QueryTimeoutError.html b/2.2.0/classes/QueryTimeoutError.html new file mode 100644 index 00000000..d7ec83b6 --- /dev/null +++ b/2.2.0/classes/QueryTimeoutError.html @@ -0,0 +1,1151 @@ + + + + + + QueryTimeoutError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class QueryTimeoutError

+
+
+
+

A failure due to the query timeout being exceeded.

+

+ This error can have one of two sources: 1. Fauna is behaving + expectedly, but the query timeout provided was too aggressive and + lower than the query's expected processing time. 2. Fauna was not + available to service the request before the timeout was reached. +

+

+ In either case, consider increasing the + query_timeout_ms configuration for your client. +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + stats? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Optional + Readonlystats + +

+
+ stats?: + {
    [key: + string]: number;
} +
+
+

Statistics regarding the query.

+
+
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/ServiceError.html b/2.2.0/classes/ServiceError.html new file mode 100644 index 00000000..de6592b2 --- /dev/null +++ b/2.2.0/classes/ServiceError.html @@ -0,0 +1,1136 @@ + + + + + + ServiceError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class ServiceError

+
+
+
+

An error representing a query failure returned by Fauna.

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/ServiceInternalError.html b/2.2.0/classes/ServiceInternalError.html new file mode 100644 index 00000000..f2b8bfce --- /dev/null +++ b/2.2.0/classes/ServiceInternalError.html @@ -0,0 +1,1091 @@ + + + + + + ServiceInternalError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class ServiceInternalError

+
+
+
+

ServiceInternalError indicates Fauna failed unexpectedly.

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/SetIterator.html b/2.2.0/classes/SetIterator.html new file mode 100644 index 00000000..d75b407a --- /dev/null +++ b/2.2.0/classes/SetIterator.html @@ -0,0 +1,1410 @@ + + + + + + SetIterator | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class SetIterator<T>

+
+
+
+

+ A class to provide an iterable API for fetching multiple pages of + data, given a Fauna Set +

+
+
+
+
+

Type Parameters

+ +
+
+

Implements

+
    +
  • + AsyncGenerator<T[], void, unknown> +
    • +
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Methods

+
+ + [asyncIterator] + + flatten + + next + + return + + throw + + fromPageable + + fromQuery +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+
    +
  • + new SetIterator<T>(client, + initial, + options?): SetIterator<T> + +
    • +
  • +
    +

    + Constructs a new + SetIterator. +

    +
    +
    +

    Type Parameters

    +
      +
    • + T extends QueryValue +
      +

      + The expected type of the items returned from Fauna + on each iteration +

      +
      +
      +
      • +
    +
    +
    +

    Parameters

    +
      +
    • + client: + Client +
      +

      + The + Client + that will be used to fetch new data on each + iteration +

      +
      +
      +
      • +
    • + initial: + EmbeddedSet | Page<T> | (() => Promise<EmbeddedSet | T | Page<T>>) +
      +

      + An existing fauna Set (Page + or + EmbeddedSet) or function which returns a promise. If the + Promise resolves to a + Page + or + EmbeddedSet + then the iterator will use the client to fetch + additional pages of data. +

      +
      +
      +
      • +
    • + Optionaloptions: + QueryOptions +
      +

      + a + QueryOptions + to apply to the queries. Optional. +

      +
      +
      +
      • +
    +
    +

    + Returns + SetIterator<T> +

    +
    +

    + Remarks + +

    +

    + Though you can use + SetIterator + class directly, it is most common to create an instance + through the + Client.paginate + paginate method. +

    +
    + +
    • +
+
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ [asyncIterator] + +

+ +
+
+ +

+ flatten + +

+
    +
  • + flatten(): FlattenedSetIterator<T> + +
    • +
  • +
    +

    + Constructs a new FlattenedSetIterator from the current + instance +

    +
    +

    + Returns + FlattenedSetIterator<T> +

    +

    A new FlattenedSetIterator from the current instance

    +
    + +
    • +
+
+
+ +

+ next + +

+
    +
  • + next(): Promise<IteratorResult<T[], void>> + +
    • +
  • +
    +

    Implement AsyncGenerator.next

    +
    +

    + Returns Promise<IteratorResult<T[], void>> +

    +
    + +
    • +
+
+
+ +

+ return + +

+
    +
  • + return(): Promise<IteratorResult<T[], void>> + +
    • +
  • +
    +

    Implement AsyncGenerator.return

    +
    +

    + Returns Promise<IteratorResult<T[], void>> +

    +
    + +
    • +
+
+
+ +

+ throw + +

+
    +
  • + throw(e): Promise<IteratorResult<T[], void>> + +
    • +
  • +
    +

    Implement AsyncGenerator.throw

    +
    +
    +

    Parameters

    +
      +
    • + e: + any +
      • +
    +
    +

    + Returns Promise<IteratorResult<T[], void>> +

    +
    + +
    • +
+
+
+ +

+ StaticfromPageable + +

+ +
+
+ +

+ StaticfromQuery + +

+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/StreamClient.html b/2.2.0/classes/StreamClient.html new file mode 100644 index 00000000..691d13ca --- /dev/null +++ b/2.2.0/classes/StreamClient.html @@ -0,0 +1,1027 @@ + + + + + + StreamClient | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class StreamClient<T>

+
+
+
+

A class to listen to Fauna streams.

+
+
+
+
+

Type Parameters

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + closed +
+
+
+

Accessors

+
+ + last_ts +
+
+
+

Methods

+
+ + [asyncIterator] + + close + + start +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ closed + +

+
+ closed: + boolean = false +
+
+

Whether or not this stream has been closed

+
+
+ +
+
+
+
+ +

+ + + + Accessors +

+ +
+
+ +

+ last_ts + +

+
    +
  • + get last_ts(): undefined | number +
    • +
  • +

    + Returns undefined | number +

    + +
    • +
+
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ [asyncIterator] + +

+
    +
  • + [asyncIterator](): AsyncGenerator<StreamEventData<T> | StreamEventStatus, any, unknown> + +
    • +
  • +

    + Returns + AsyncGenerator<StreamEventData<T> | StreamEventStatus, any, unknown> +

    + +
    • +
+
+
+ +

+ close + +

+ +
+
+ +

+ start + +

+
    +
  • + start(onEvent, + onError?): void + +
    • +
  • +
    +

    + A synchronous method to start listening to the stream and + handle events using callbacks. +

    +
    +
    +

    Parameters

    +
      +
    • + onEvent: + ((event: StreamEventData<T> | StreamEventStatus) => void) +
      +

      A callback function to handle each event

      +
      +
      +
        +
      • +
          +
        • + (event): void +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + event: + StreamEventData<T> + | StreamEventStatus +
            • +
          +
          +

          + Returns + void +

          +
          • +
        +
        • +
      +
      • +
    • + OptionalonError: + ((error: Error) => void) +
      +

      + An Optional callback function to handle errors. If + none is provided, error will not be handled, and the + stream will simply end. +

      +
      +
      +
        +
      • +
          +
        • + (error): void +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + error: + Error +
            • +
          +
          +

          + Returns + void +

          +
          • +
        +
        • +
      +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Accessors + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/StreamToken.html b/2.2.0/classes/StreamToken.html new file mode 100644 index 00000000..d8af7377 --- /dev/null +++ b/2.2.0/classes/StreamToken.html @@ -0,0 +1,468 @@ + + + + + + StreamToken | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class StreamToken

+
+
+
+

+ A token used to initiate a Fauna stream at a particular snapshot + in time. +

+

+ The example below shows how to request a stream token from Fauna + and use it to establish an event steam. +

+
+
+

+ Example + +

+ 
 const response = await client.query(fql`
   Messages.byRecipient(User.byId("1234"))
 `);
 const token = response.data;

 const stream = client.stream(token)
   .on("add", (event) => console.log("New message", event))

 stream.start();
+
+
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + token +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Readonlytoken + +

+
+ token: + string +
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/TaggedTypeFormat.html b/2.2.0/classes/TaggedTypeFormat.html new file mode 100644 index 00000000..dddd34db --- /dev/null +++ b/2.2.0/classes/TaggedTypeFormat.html @@ -0,0 +1,667 @@ + + + + + + TaggedTypeFormat | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class TaggedTypeFormat

+
+
+
+

+ TaggedType provides the encoding/decoding of the Fauna Tagged Type + formatting +

+
+
+
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Methods

+
+ + decode + + encode + + encodeInterpolation +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ Staticdecode + +

+
    +
  • + decode(input, + decodeOptions): any + +
    • +
  • +
    +

    + Decode the JSON string result from Fauna to remove Tagged + Type formatting. +

    +
    +
    +

    Parameters

    +
      +
    • + input: + string +
      +

      JSON string result from Fauna

      +
      +
      +
      • +
    • + decodeOptions: + DecodeOptions +
      • +
    +
    +

    + Returns any +

    +

    object of result of FQL query

    +
    + +
    • +
+
+
+ +

+ Staticencode + +

+
    +
  • + encode(input): TaggedType + +
    • +
  • +
    +

    Encode the value to the Tagged Type format for Fauna

    +
    +
    +

    Parameters

    +
      +
    • + input: + QueryArgument +
      +

      value that will be encoded

      +
      +
      +
      • +
    +
    +

    + Returns TaggedType +

    +

    Map of result

    +
    + +
    • +
+
+
+ +

+ StaticencodeInterpolation + +

+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/ThrottlingError.html b/2.2.0/classes/ThrottlingError.html new file mode 100644 index 00000000..e902b730 --- /dev/null +++ b/2.2.0/classes/ThrottlingError.html @@ -0,0 +1,1088 @@ + + + + + + ThrottlingError | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class ThrottlingError

+
+
+
+

+ ThrottlingError indicates some capacity limit was exceeded and + thus the request could not be served. +

+
+
+
+
+

+ Hierarchy (view full) +

+ +
+ +
+
+
+ + + +
+
+

Constructors

+
+ + constructor +
+
+
+

Properties

+
+ + cause? + + code + + constraint_failures? + + httpStatus? + + message + + name + + queryInfo? + + stack? + + prepareStackTrace? + + stackTraceLimit +
+
+
+

Methods

+
+ + captureStackTrace +
+
+
+
+
+
+
+ +

+ + + + Constructors +

+ +
+
+ +

+ constructor + +

+ +
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalcause + +

+
+ cause?: + unknown +
+ +
+
+ +

+ Readonlycode + +

+
+ code: + string +
+
+

+ A code for the error. Codes indicate the cause of the error. + It is safe to write programmatic logic against the code. They + are part of the API contract. +

+
+
+ +
+
+ +

+ Optional + Readonlyconstraint_failures + +

+
+ constraint_failures?: + ConstraintFailure[] +
+
+

+ A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

+
+
+ +
+
+ +

+ Optional + ReadonlyhttpStatus + +

+
+ httpStatus?: + number +
+
+

The HTTP Status Code of the error.

+
+
+ +
+
+ +

+ message + +

+
+ message: + string +
+ +
+
+ +

+ name + +

+
+ name: + string +
+ +
+
+ +

+ Optional + ReadonlyqueryInfo + +

+
+ queryInfo?: + QueryInfo +
+
+

Details about the query sent along with the response

+
+
+ +
+
+ +

+ Optionalstack + +

+
+ stack?: + string +
+ +
+
+ +

+ Static + OptionalprepareStackTrace + +

+
+ prepareStackTrace?: + ((err: Error, + stackTraces: CallSite[]) => any) +
+
+

Optional override for formatting stack traces

+
+
+

+ See + +

+

+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces +

+
+ +
+
+ +

+ StaticstackTraceLimit + +

+
+ stackTraceLimit: + number +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ StaticcaptureStackTrace + +

+
    +
  • + captureStackTrace(targetObject, + constructorOpt?): void + +
    • +
  • +
    +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • + targetObject: + object +
      • +
    • + OptionalconstructorOpt: + Function +
      • +
    +
    +

    + Returns void +

    +
    + +
    • +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Constructors + + +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/classes/TimeStub.html b/2.2.0/classes/TimeStub.html new file mode 100644 index 00000000..1b7a689b --- /dev/null +++ b/2.2.0/classes/TimeStub.html @@ -0,0 +1,745 @@ + + + + + + TimeStub | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class TimeStub

+
+
+
+

+ A wrapper around the Fauna Time type. It, represents + a fixed point in time without regard to calendar or location, e.g. + July 20, 1969, at 20:17 UTC. Convert to and from Javascript Date's + with the + TimeStub.fromDate + and + TimeStub.toDate + methods. See remarks for possible precision loss when doing this. + If precision loss is a concern consider using a 3rd party datetime + library such as luxon. +

+
+
+

+ Remarks + +

+

+ The Javascript Date type most closely resembles a + Fauna Time, not a Fauna Date. However, + Fauna stores Time values with nanosecond precision, + while Javascript Date values only have millisecond + precision. This TimeStub class preserves precision by storing the + original string value and should be used whenever possible to pass + Time values back to Fauna. Converting to a Javascript + date before sending to Fauna could result in loss of precision. +

+

+ See + +

+

+ https://docs.fauna.com/fauna/current/reference/fql_reference/types#time +

+
+
+ +
+
+
+ + + +
+
+

Properties

+
+ + isoString +
+
+
+

Methods

+
+ + toDate + + toString + + from + + fromDate +
+
+
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ ReadonlyisoString + +

+
+ isoString: + string +
+ +
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ toDate + +

+
    +
  • + toDate(): Date + +
    • +
  • +
    +

    + Get a copy of the TimeStub converted to a + Javascript Date. Does not mutate the existing + TimeStub value. +

    +
    +

    + Returns Date +

    +

    A Date

    +
    + +
    • +
+
+
+ +

+ toString + +

+
    +
  • + toString(): string + +
    • +
  • +
    +

    Override default string conversion

    +
    +

    + Returns string +

    +

    the string representation of a TimeStub

    +
    + +
    • +
+
+
+ +

+ Staticfrom + +

+
    +
  • + from(isoString): TimeStub + +
    • +
  • +
    +

    + Creates a new + TimeStub + from an ISO date string +

    +
    +
    +

    Parameters

    +
      +
    • + isoString: + string +
      +

      An ISO date string.

      +
      +
      +
      • +
    +
    +

    + Returns + TimeStub +

    +

    + A new + TimeStub +

    +
    +

    + Throws + +

    +

    + TypeError if a string is not provided, or RangeError if + item is not a valid date +

    +
    + +
    • +
+
+
+ +

+ StaticfromDate + +

+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Properties + + +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/functions/fql.html b/2.2.0/functions/fql.html new file mode 100644 index 00000000..4a17d211 --- /dev/null +++ b/2.2.0/functions/fql.html @@ -0,0 +1,377 @@ + + + + + + fql | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function fql

+
+
+
    +
  • + fql<T>(queryFragments, + ...queryArgs): Query<T> + +
    • +
  • +
    +

    Creates a new Query. Accepts template literal inputs.

    +
    +
    +

    Type Parameters

    +
      +
    • + T extends QueryValue + = any +
      +

      + The expected type of the response from Fauna when + evaluated. +

      +
      +
      +
      • +
    +
    +
    +

    Parameters

    +
      +
    • + queryFragments: + readonly string[] +
      +

      + a TemplateStringsArray that constitute the strings that + are the basis of the query. +

      +
      +
      +
      • +
    • + Rest...queryArgs: + QueryArgument[] +
      +

      + an Array<QueryValue | Query> that constitute the + arguments to inject between the queryFragments. +

      +
      +
      +
      • +
    +
    +

    + Returns + Query<T> +

    +
    +

    + Throws + +

    +

    + Error - if you call this method directly (not using template + literals) and pass invalid construction parameters +

    +

    + Example + +

    + 
     const str = "baz";
     const num = 17;
     const innerQuery = fql`${num} + 3)`;
     const queryRequestBuilder = fql`${str}.length == ${innerQuery}`;
+
    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/functions/getDefaultHTTPClient.html b/2.2.0/functions/getDefaultHTTPClient.html new file mode 100644 index 00000000..0b9f03c5 --- /dev/null +++ b/2.2.0/functions/getDefaultHTTPClient.html @@ -0,0 +1,294 @@ + + + + + + getDefaultHTTPClient | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function getDefaultHTTPClient

+
+
+ +
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/functions/isHTTPResponse.html b/2.2.0/functions/isHTTPResponse.html new file mode 100644 index 00000000..a1ce10f9 --- /dev/null +++ b/2.2.0/functions/isHTTPResponse.html @@ -0,0 +1,282 @@ + + + + + + isHTTPResponse | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function isHTTPResponse

+
+
+ +
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/functions/isStreamClient.html b/2.2.0/functions/isStreamClient.html new file mode 100644 index 00000000..1c5a21d5 --- /dev/null +++ b/2.2.0/functions/isStreamClient.html @@ -0,0 +1,289 @@ + + + + + + isStreamClient | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function isStreamClient

+
+
+ +
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/hierarchy.html b/2.2.0/hierarchy.html new file mode 100644 index 00000000..1e9946bb --- /dev/null +++ b/2.2.0/hierarchy.html @@ -0,0 +1,480 @@ + + + + + + Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+

Fauna v10 JavaScript driver - v2.2.0

+
+

Class Hierarchy

+ + + + + +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/index.html b/2.2.0/index.html new file mode 100644 index 00000000..ba3f278a --- /dev/null +++ b/2.2.0/index.html @@ -0,0 +1,314 @@ + + + + + + Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+

Fauna v10 JavaScript driver - v2.2.0

+
+
+ +

+ Fauna v10 JavaScript driver API reference documentation + +

+

+ This site contains API reference documentation for the official + Fauna v10 JavaScript driver. +

+

+ For examples and tutorials, see the + driver README and + the + Fauna docs. +

+ +

+ Key classes and methods + +

+
    +
  • + Client: Use instances of this + class to send requests to Fauna. +
    • +
  • + query(): Use this method + to run queries. +
    • +
+ +

+ All classes and modules + +

+

+ For all available classes and modules, see + Modules. +

+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ Fauna v10 JavaScript driver API reference + documentation + +
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/interfaces/ClientConfiguration.html b/2.2.0/interfaces/ClientConfiguration.html new file mode 100644 index 00000000..d1467941 --- /dev/null +++ b/2.2.0/interfaces/ClientConfiguration.html @@ -0,0 +1,1326 @@ + + + + + + ClientConfiguration | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface ClientConfiguration

+
+
+
+

+ Configuration for a client. The options provided are used as the + default options for each query. +

+
+
+
+
+ interface ClientConfiguration + {
    client_timeout_buffer_ms?: number;
    endpoint?: URL;
    fetch_keepalive?: boolean;
    format?: ValueFormat;
    http2_max_streams?: number;
    http2_session_idle_ms?: number;
    linearized?: boolean;
    long_type?: "number" | "bigint";
    max_attempts?: number;
    max_backoff?: number;
    max_contention_retries?: number;
    query_tags?: {
        [key: + string]: string;
    };
    query_timeout_ms?: number;
    secret?: string;
    traceparent?: string;
    typecheck?: boolean;
} +
+ +
+
+
+ + + +
+
+

Properties

+
+ + client_timeout_buffer_ms? + + endpoint? + + fetch_keepalive? + + format? + + http2_max_streams? + + http2_session_idle_ms? + + linearized? + + long_type? + + max_attempts? + + max_backoff? + + max_contention_retries? + + query_tags? + + query_timeout_ms? + + secret? + + traceparent? + + typecheck? +
+
+
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalclient_timeout_buffer_ms + +

+
+ client_timeout_buffer_ms?: + number +
+
+

+ Time in milliseconds beyond + ClientConfiguration.query_timeout_ms + at which the client will abort a request if it has not + received a response. The default is 5000 ms, which should + account for network latency for most clients. The value must + be greater than zero. The closer to zero the value is, the + more likely the client is to abort the request before the + server can report a legitimate response or error. +

+
+
+ +
+
+ +

+ Optionalendpoint + +

+
+ endpoint?: + URL +
+
+

+ The URL of Fauna to call. See + endpoints + for some default options. +

+
+
+ +
+
+ +

+ Optionalfetch_keepalive + +

+
+ fetch_keepalive?: + boolean +
+
+

+ When true will keep executing a request even if the page that + fired the request is no longer executing. Only relevant to + underlying clients using the + Fetch standard. + By default set to false. +

+
+
+

+ Remarks + +

+

+ Relevant to clients using the + FetchClient + provided, or any custom HTTP Clients you implement using the + Fetch standard. +

+
+ +
+
+ +

+ Optionalformat + +

+
+ format?: + ValueFormat +
+
+

+ Determines the encoded format expected for the query + arguments field, and the data field + of a successful response. +

+
+
+

+ Remarks + +

+

+ Note, it is very unlikely you need to change this value + from its default. + The default format is "tagged", which specifies that + the driver transmits type information over the wire. Type + information allows the driver and Fauna to distinguish between + types such as int" and "long" which do not have + a standard way of distinguishing in JSON. Rare use cases can + also deal with standard JSON by setting the value to + "simple". Note that the types enocodable in standard + JSON are a subset of the types encodable in the default + "tagged" format. It is not recommended that users + use the "simple" format as you will lose the typing + of your data. e.g. a "Date" will no longer be + recognized by the Fauna as a "Date", but will + instead be treated as a string. +

+
+ +
+
+ +

+ Optionalhttp2_max_streams + +

+
+ http2_max_streams?: + number +
+
+

+ The maximum number of HTTP2 streams to execute in parallel to + Fauna per HTTP2 session. Only relevant to certain HTTP2 + clients. +

+
+
+

+ Remarks + +

+

+ Relevant to clients using the + NodeHTTP2Client + provided, or any custom HTTP2Clients you implement that + support this feature. +

+
+ +
+
+ +

+ Optionalhttp2_session_idle_ms + +

+
+ http2_session_idle_ms?: + number +
+
+

+ Time in milliseconds the client will keep an HTTP2 session + open after all requests are completed. The default is 5000 ms. +

+
+
+ +
+
+ +

+ Optionallinearized + +

+
+ linearized?: + boolean +
+
+

+ If true, unconditionally run the query as strictly serialized. + This affects read-only transactions. Transactions which write + will always be strictly serialized. +

+
+
+ +
+
+ +

+ Optionallong_type + +

+
+ long_type?: + "number" | "bigint" +
+
+

+ Controls what Javascript type to deserialize + Fauna longs + to. Use 'number' to deserialize longs to number. Use 'bigint' + to deserialize to bigint. Defaults to 'number'. Note, for + extremely large maginitude numbers Javascript's number will + lose precision; as Javascript's 'number' can only support +/- + 2^53-1 whereas Fauna's long is 64 bit. If this is detected, a + warning will be logged to the console and precision loss will + occur. If your application uses extremely large magnitude + numbers use 'bigint'. +

+
+
+ +
+
+ +

+ Optionalmax_attempts + +

+
+ max_attempts?: + number +
+
+

Max attempts for retryable exceptions. Default is 3.

+
+
+ +
+
+ +

+ Optionalmax_backoff + +

+
+ max_backoff?: + number +
+
+

Max backoff between retries. Default is 20 seconds.

+
+
+ +
+
+ +

+ Optionalmax_contention_retries + +

+
+ max_contention_retries?: + number +
+
+

+ The max number of times to retry the query if contention is + encountered. +

+
+
+ +
+
+ +

+ Optionalquery_tags + +

+
+ query_tags?: + {
    [key: + string]: string;
} +
+
+

Tags provided back via logging and telemetry.

+
+
+ +
+
+ +

+ Optionalquery_timeout_ms + +

+
+ query_timeout_ms?: + number +
+
+

+ The timeout of each query, in milliseconds. This controls the + maximum amount of time Fauna will execute your query before + marking it failed. The default is 5000 ms. +

+
+
+ +
+
+ +

+ Optionalsecret + +

+
+ secret?: + string +
+
+

+ A secret for your Fauna DB, used to authorize your queries. +

+
+
+

+ See + +

+

+ https://docs.fauna.com/fauna/current/security/keys +

+
+ +
+
+ +

+ Optionaltraceparent + +

+
+ traceparent?: + string +
+
+

+ A traceparent provided back via logging and telemetry. Must + match format: + https://www.w3.org/TR/trace-context/#traceparent-header +

+
+
+ +
+
+ +

+ Optionaltypecheck + +

+
+ typecheck?: + boolean +
+
+

+ Enable or disable typechecking of the query before evaluation. + If no value is provided, the value of + typechecked in the database configuration will be + used. +

+
+
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/interfaces/Endpoints.html b/2.2.0/interfaces/Endpoints.html new file mode 100644 index 00000000..64373db8 --- /dev/null +++ b/2.2.0/interfaces/Endpoints.html @@ -0,0 +1,492 @@ + + + + + + Endpoints | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Endpoints

+
+
+
+

An extensible interface for a set of Fauna endpoints.

+
+
+

+ Remarks + +

+

+ Leverage the [key: string]: URL; field to extend to + other endpoints. +

+
+
+
+ interface Endpoints + {
    default: URL;
    local: URL;
    localhost: URL;
    [key: + string]: URL;
} +
+
+

Indexable

+
    +
  • +
    + [key: + string]: URL +
    +
    +

    + Any other endpoint you want your client to support. For + example, if you run all requests through a proxy configure it + here. Most clients will not need to leverage this ability. +

    +
    +
    +
    • +
+
+ +
+
+
+ + + +
+
+

Properties

+
+ + default + + local + + localhost +
+
+
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ default + +

+
+ default: + URL +
+
+

Fauna's default endpoint.

+
+
+ +
+
+ +

+ local + +

+
+ local: + URL +
+
+

+ An endpoint for interacting with local instance of Fauna (e.g. + one running in a local docker container). +

+
+
+ +
+
+ +

+ localhost + +

+
+ localhost: + URL +
+
+

An alias for local.

+
+
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/interfaces/HTTPClient.html b/2.2.0/interfaces/HTTPClient.html new file mode 100644 index 00000000..a832fc63 --- /dev/null +++ b/2.2.0/interfaces/HTTPClient.html @@ -0,0 +1,584 @@ + + + + + + HTTPClient | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface HTTPClient

+
+
+
+

+ An interface to provide implementation-specific, asyncronous http + calls. This driver provides default implementations for common + environments. Users can configure the + Client + to use custom implementations if desired. +

+
+
+
+
+ interface HTTPClient + {
    close(): void;
    request(req: HTTPRequest): Promise<HTTPResponse>;
} +
+
+

Implemented by

+ +
+ +
+
+
+ + + +
+
+

Methods

+
+ + close + + request +
+
+
+
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ close + +

+
    +
  • + close(): void + +
    • +
  • +
    +

    + Flags the calling + Client + as no longer referencing this HTTPClient. Once no + Client + instances reference this HTTPClient the underlying + resources will be closed. It is expected that calls to + this method are only made by a + Client + instantiation. The behavior of direct calls is undefined. +

    +
    +

    + Returns void +

    +
    +

    + Remarks + +

    +

    + For some HTTPClients, such as the + FetchClient, this method is a no-op as there is no shared resource + to close. +

    +
    + +
    • +
+
+
+ +

+ request + +

+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/interfaces/HTTPStreamClient.html b/2.2.0/interfaces/HTTPStreamClient.html new file mode 100644 index 00000000..fa2306a4 --- /dev/null +++ b/2.2.0/interfaces/HTTPStreamClient.html @@ -0,0 +1,465 @@ + + + + + + HTTPStreamClient | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface HTTPStreamClient

+
+
+
+

+ An interface to provide implementation-specific, asyncronous http + calls. This driver provides default implementations for common + environments. Users can configure the + Client + to use custom implementations if desired. +

+
+
+
+
+ interface HTTPStreamClient + {
    stream(req: HTTPStreamRequest): StreamAdapter;
} +
+
+

Implemented by

+ +
+ +
+
+
+ + + +
+
+

Methods

+
+ + stream +
+
+
+
+
+
+
+ +

+ + + + Methods +

+ +
+
+ +

+ stream + +

+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Methods + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/interfaces/QueryOptions.html b/2.2.0/interfaces/QueryOptions.html new file mode 100644 index 00000000..d067aac0 --- /dev/null +++ b/2.2.0/interfaces/QueryOptions.html @@ -0,0 +1,891 @@ + + + + + + QueryOptions | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface QueryOptions

+
+
+
+

+ Options for queries. Each query can be made with different + options. Settings here take precedence over those in + ClientConfiguration. +

+
+
+
+
+ interface QueryOptions + {
    arguments?: QueryArgumentObject;
    format?: ValueFormat;
    linearized?: boolean;
    long_type?: "number" | "bigint";
    max_contention_retries?: number;
    query_tags?: Record<string, string>;
    query_timeout_ms?: number;
    secret?: string;
    traceparent?: string;
    typecheck?: boolean;
} +
+ +
+
+
+ + + +
+
+

Properties

+
+ + arguments? + + format? + + linearized? + + long_type? + + max_contention_retries? + + query_tags? + + query_timeout_ms? + + secret? + + traceparent? + + typecheck? +
+
+
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalarguments + +

+
+ arguments?: + QueryArgumentObject +
+
+

+ Optional arguments. Variables in the query will be initialized + to the value associated with an argument key. +

+
+
+ +
+
+ +

+ Optionalformat + +

+
+ format?: + ValueFormat +
+
+

+ Determines the encoded format expected for the query + arguments field, and the data field + of a successful response. Overrides the optional setting on + the + ClientConfiguration. +

+
+
+ +
+
+ +

+ Optionallinearized + +

+
+ linearized?: + boolean +
+
+

+ If true, unconditionally run the query as strictly serialized. + This affects read-only transactions. Transactions which write + will always be strictly serialized. Overrides the optional + setting on the + ClientConfiguration. +

+
+
+ +
+
+ +

+ Optionallong_type + +

+
+ long_type?: + "number" | "bigint" +
+
+

+ Controls what Javascript type to deserialize + Fauna longs + to. Use 'number' to deserialize longs to number. Use 'bigint' + to deserialize to bigint. Defaults to 'number'. Note, for + extremely large maginitude numbers Javascript's number will + lose precision; as Javascript's 'number' can only support +/- + 2^53-1 whereas Fauna's long is 64 bit. If this is detected, a + warning will be logged to the console and precision loss will + occur. If your application uses extremely large magnitude + numbers use 'bigint'. +

+
+
+ +
+
+ +

+ Optionalmax_contention_retries + +

+
+ max_contention_retries?: + number +
+
+

+ The max number of times to retry the query if contention is + encountered. Overrides the optional setting on the + ClientConfiguration. +

+
+
+ +
+
+ +

+ Optionalquery_tags + +

+
+ query_tags?: + Record<string, string> +
+
+

+ Tags provided back via logging and telemetry. Overrides the + optional setting on the + ClientConfiguration. +

+
+
+ +
+
+ +

+ Optionalquery_timeout_ms + +

+
+ query_timeout_ms?: + number +
+
+

+ The timeout to use in this query in milliseconds. Overrides + the optional setting on the + ClientConfiguration. +

+
+
+ +
+
+ +

+ Optionalsecret + +

+
+ secret?: + string +
+
+

Secret to use instead of the client's secret.

+
+
+ +
+
+ +

+ Optionaltraceparent + +

+
+ traceparent?: + string +
+
+

+ A traceparent provided back via logging and telemetry. Must + match format: + https://www.w3.org/TR/trace-context/#traceparent-header + Overrides the optional setting on the + ClientConfiguration. +

+
+
+ +
+
+ +

+ Optionaltypecheck + +

+
+ typecheck?: + boolean +
+
+

+ Enable or disable typechecking of the query before evaluation. + If no value is provided, the value of + typechecked in the database configuration will be + used. Overrides the optional setting on the + ClientConfiguration. +

+
+
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/interfaces/QueryRequest.html b/2.2.0/interfaces/QueryRequest.html new file mode 100644 index 00000000..6c038547 --- /dev/null +++ b/2.2.0/interfaces/QueryRequest.html @@ -0,0 +1,441 @@ + + + + + + QueryRequest | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface QueryRequest<T>

+
+
+
+

A request to make to Fauna.

+
+
+
+
+ interface QueryRequest<T> + {
    arguments?: EncodedObject;
    query: T;
} +
+
+

Type Parameters

+ +
+ +
+
+
+ + + +
+
+

Properties

+
+ + arguments? + + query +
+
+
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ Optionalarguments + +

+
+ arguments?: + EncodedObject +
+
+

+ Optional arguments. Variables in the query will be initialized + to the value associated with an argument key. +

+
+
+ +
+
+ +

+ query + +

+
+ query: + T +
+

The query

+
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/interfaces/Span.html b/2.2.0/interfaces/Span.html new file mode 100644 index 00000000..9e98d0ac --- /dev/null +++ b/2.2.0/interfaces/Span.html @@ -0,0 +1,490 @@ + + + + + + Span | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Span

+
+
+
+

A source span indicating a segment of FQL.

+
+
+
+
+ interface Span + {
    end: number;
    function: string;
    src: string;
    start: number;
} +
+ +
+
+
+ + + +
+
+

Properties

+
+ + end + + function + + src + + start +
+
+
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ end + +

+
+ end: + number +
+
+

The span's ending index within the src, inclusive.

+
+
+ +
+
+ +

+ function + +

+
+ function: + string +
+
+

The name of the enclosing function, if applicable.

+
+
+ +
+
+ +

+ src + +

+
+ src: + string +
+
+

+ A string identifier of the FQL source. For example, if + performing a raw query against the API this would be + query. +

+
+
+ +
+
+ +

+ start + +

+
+ start: + number +
+
+

The span's starting index within the src, inclusive.

+
+
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/interfaces/StreamAdapter.html b/2.2.0/interfaces/StreamAdapter.html new file mode 100644 index 00000000..15157f84 --- /dev/null +++ b/2.2.0/interfaces/StreamAdapter.html @@ -0,0 +1,416 @@ + + + + + + StreamAdapter | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface StreamAdapter

+
+
+
+

+ A common interface for a StreamClient to operate a stream from any + HTTPStreamClient +

+
+
+
+
+ interface StreamAdapter + {
    close: (() => void);
    read: AsyncGenerator<string, any, unknown>;
} +
+ +
+
+
+ + + +
+
+

Properties

+
+ + close + + read +
+
+
+
+
+
+
+ +

+ + + + Properties +

+ +
+
+ +

+ close + +

+
+ close: + (() => void) +
+ +
+
+ +

+ read + +

+
+ read: + AsyncGenerator<string, any, unknown> +
+ +
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+
+ + + Properties + + +
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/modules.html b/2.2.0/modules.html new file mode 100644 index 00000000..c84b48d3 --- /dev/null +++ b/2.2.0/modules.html @@ -0,0 +1,585 @@ + + + + + + Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+

Fauna v10 JavaScript driver - v2.2.0

+
+
+
+

Index

+
+

Classes

+
+ + AbortError + + AuthenticationError + + AuthorizationError + + Client + + ClientClosedError + + ClientError + + ConstraintFailureError + + ContendedTransactionError + + DateStub + + Document + + DocumentReference + + EmbeddedSet + + FaunaError + + FetchClient + + InvalidRequestError + + Module + + NamedDocument + + NamedDocumentReference + + NetworkError + + NodeHTTP2Client + + NullDocument + + Page + + ProtocolError + + Query + + QueryCheckError + + QueryRuntimeError + + QueryTimeoutError + + ServiceError + + ServiceInternalError + + SetIterator + + StreamClient + + StreamToken + + TaggedTypeFormat + + ThrottlingError + + TimeStub +
+
+
+

Interfaces

+
+ + ClientConfiguration + + Endpoints + + HTTPClient + + HTTPStreamClient + + QueryOptions + + QueryRequest + + Span + + StreamAdapter +
+
+
+

Type Aliases

+
+ + DocumentT + + HTTPRequest + + HTTPResponse + + QueryArgument + + QueryFailure + + QueryInfo + + QueryInterpolation + + QueryStats + + QuerySuccess + + QueryValue + + QueryValueObject + + StreamClientConfiguration + + ValueFragment +
+
+
+

Variables

+
+ + LONG_MAX + + LONG_MIN + + endpoints +
+
+
+

Functions

+
+ + fql + + getDefaultHTTPClient + + isHTTPResponse + + isStreamClient +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/DocumentT.html b/2.2.0/types/DocumentT.html new file mode 100644 index 00000000..0d202f30 --- /dev/null +++ b/2.2.0/types/DocumentT.html @@ -0,0 +1,320 @@ + + + + + + DocumentT | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias DocumentT<T>

+
+
+ DocumentT<T>: + Document & T +
+
+

+ A Document typed with a user-defined data type. Typescript users can + cast instances of + Document + to + DocumentT + to access user-defined fields with type safety. +

+

+ The example below creates a local type "User" that is + applied to queries for documents in a hypothetical "Users" + collection. +

+
+
+

Type Parameters

+ +
+
+

+ Example + +

+ 
 type User = {
   color: string
 }

 const response = await client.query<DocumentT<User>>(fql`
   Users.byId("101")
 `);
 const user = response.data;

 const color = user.color;
+
+ +

+ Remarks + +

+

+ The + Document + class cannot be generic because classes cannot extend generic type + arguments. +

+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/HTTPRequest.html b/2.2.0/types/HTTPRequest.html new file mode 100644 index 00000000..40dbf5ed --- /dev/null +++ b/2.2.0/types/HTTPRequest.html @@ -0,0 +1,342 @@ + + + + + + HTTPRequest | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias HTTPRequest

+
+
+ HTTPRequest: + {
    client_timeout_ms: number;
    data: QueryRequest;
    headers: Record<string, string | undefined>;
    method: "POST";
} +
+
+

+ An object representing an http request. The + Client + provides this to the + HTTPClient + implementation. +

+
+
+

Type declaration

+
    +
  • +
    + client_timeout_ms: number +
    +
    +

    The timeout of each http request, in milliseconds.

    +
    +
    +
    • +
  • +
    + data: QueryRequest +
    +
    +

    The encoded Fauna query to send

    +
    +
    +
    • +
  • +
    + headers: Record<string, string | undefined> +
    +
    +

    Headers in object format

    +
    +
    +
    • +
  • +
    + method: "POST" +
    +
    +

    HTTP method to use

    +
    +
    +
    • +
+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/HTTPResponse.html b/2.2.0/types/HTTPResponse.html new file mode 100644 index 00000000..b592abad --- /dev/null +++ b/2.2.0/types/HTTPResponse.html @@ -0,0 +1,273 @@ + + + + + + HTTPResponse | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias HTTPResponse

+
+
+ HTTPResponse: + {
    body: string;
    headers: Record<string, string | string[] | undefined>;
    status: number;
} +
+
+

+ An object representing an http request. It is returned to, and + handled by, the + Client. +

+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/QueryArgument.html b/2.2.0/types/QueryArgument.html new file mode 100644 index 00000000..fc3f8f73 --- /dev/null +++ b/2.2.0/types/QueryArgument.html @@ -0,0 +1,281 @@ + + + + + + QueryArgument | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias QueryArgument

+
+
+ QueryArgument:
    | QueryValue
    | Query<any>
    | Date
    | ArrayBuffer
    | Uint8Array
    | QueryArgument[]
    | QueryArgumentObject +
+
+

+ A QueryArgument represents all possible values that can be encoded + and passed to Fauna as a query argument. +

+

+ The + fql + tagged template function requires all arguments to be of type + QueryArgument. +

+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/QueryFailure.html b/2.2.0/types/QueryFailure.html new file mode 100644 index 00000000..63bad8e6 --- /dev/null +++ b/2.2.0/types/QueryFailure.html @@ -0,0 +1,394 @@ + + + + + + QueryFailure | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias QueryFailure

+
+
+ QueryFailure: + QueryInfo & {
    error: {
        abort?: QueryValue;
        code: string;
        constraint_failures?: ConstraintFailure[];
        message: string;
    };
} +
+
+

+ A decoded response from a failed query to Fauna. Integrations which + only want to report a human readable version of the failure can + simply print out the "summary" field. +

+
+
+

Type declaration

+
    +
  • +
    + error: {
        abort?: QueryValue;
        code: string;
        constraint_failures?: ConstraintFailure[];
        message: string;
    } +
    +
    +

    The result of the query resulting in

    +
    +
    +
      +
    • +
      + Optionalabort?: QueryValue +
      +
      +

      + The user provided value passed to the originating + abort() call. Present only when the query + encountered an abort() call, which is denoted + by the error code "abort" +

      +
      +
      +
      • +
    • +
      + code: string +
      +
      +

      + A predefined code which indicates the type of error. See + XXX for a list of error codes. +

      +
      +
      +
      • +
    • +
      + Optionalconstraint_failures?: ConstraintFailure[] +
      +
      +

      + A machine readable description of any constraint failures + encountered by the query. Present only if this query + encountered constraint failures. +

      +
      +
      +
      • +
    • +
      + message: string +
      +
      +

      A short, human readable description of the error

      +
      +
      +
      • +
    +
    • +
+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/QueryInfo.html b/2.2.0/types/QueryInfo.html new file mode 100644 index 00000000..7c3e4610 --- /dev/null +++ b/2.2.0/types/QueryInfo.html @@ -0,0 +1,351 @@ + + + + + + QueryInfo | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias QueryInfo

+
+
+ QueryInfo: + {
    query_tags?: Record<string, string>;
    schema_version?: number;
    stats?: QueryStats;
    summary?: string;
    txn_ts?: number;
} +
+
+

Type declaration

+
    +
  • +
    + Optionalquery_tags?: Record<string, string> +
    +
    +

    The value of the x-query-tags header, if it was provided.

    +
    +
    +
    • +
  • +
    + Optionalschema_version?: number +
    +
    +

    The schema version that was used for the query execution.

    +
    +
    +
    • +
  • +
    + Optionalstats?: QueryStats +
    +
    +

    Stats on query performance and cost

    +
    +
    +
    • +
  • +
    + Optionalsummary?: string +
    +
    +

    + A readable summary of any warnings or logs emitted by the + query. +

    +
    +
    +
    • +
  • +
    + Optionaltxn_ts?: number +
    +
    +

    + The last transaction timestamp of the query. A Unix epoch in + microseconds. +

    +
    +
    +
    • +
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/QueryInterpolation.html b/2.2.0/types/QueryInterpolation.html new file mode 100644 index 00000000..57771909 --- /dev/null +++ b/2.2.0/types/QueryInterpolation.html @@ -0,0 +1,275 @@ + + + + + + QueryInterpolation | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias QueryInterpolation

+
+
+ QueryInterpolation:
    | FQLFragment
    | ValueFragment
    | ObjectFragment
    | ArrayFragment +
+
+

+ A piece of an interpolated query. Interpolated queries can be safely + composed together without concern of query string injection. +

+
+
+

+ See + +

+

+ ValueFragment + and FQLFragment for additional information +

+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/QueryStats.html b/2.2.0/types/QueryStats.html new file mode 100644 index 00000000..5477473d --- /dev/null +++ b/2.2.0/types/QueryStats.html @@ -0,0 +1,380 @@ + + + + + + QueryStats | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias QueryStats

+
+
+ QueryStats: + {
    attempts: number;
    compute_ops: number;
    contention_retries: number;
    query_time_ms: number;
    read_ops: number;
    storage_bytes_read: number;
    storage_bytes_write: number;
    write_ops: number;
} +
+
+

Type declaration

+
    +
  • +
    + attempts: number +
    +
    +

    The number query attempts made due to retryable errors.

    +
    +
    +
    • +
  • +
    + compute_ops: number +
    +
    +

    + The amount of Transactional Compute Ops consumed by the query. +

    +
    +
    +
    • +
  • +
    + contention_retries: number +
    +
    +

    + The number of times the transaction was retried due to write + contention. +

    +
    +
    +
    • +
  • +
    + query_time_ms: number +
    +
    +

    The query run time in milliseconds.

    +
    +
    +
    • +
  • +
    + read_ops: number +
    +
    +

    + The amount of Transactional Read Ops consumed by the query. +

    +
    +
    +
    • +
  • +
    + storage_bytes_read: number +
    +
    +

    The amount of data read from storage, in bytes.

    +
    +
    +
    • +
  • +
    + storage_bytes_write: number +
    +
    +

    The amount of data written to storage, in bytes.

    +
    +
    +
    • +
  • +
    + write_ops: number +
    +
    +

    + The amount of Transactional Write Ops consumed by the query. +

    +
    +
    +
    • +
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/QuerySuccess.html b/2.2.0/types/QuerySuccess.html new file mode 100644 index 00000000..20ea9d2e --- /dev/null +++ b/2.2.0/types/QuerySuccess.html @@ -0,0 +1,334 @@ + + + + + + QuerySuccess | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias QuerySuccess<T>

+
+
+ QuerySuccess<T>: + QueryInfo & {
    data: T;
    static_type?: string;
} +
+
+

A decoded response from a successful query to Fauna

+
+
+

Type Parameters

+ +
+
+

Type declaration

+
    +
  • +
    + data: T +
    +
    +

    + The result of the query. The data is any valid JSON value. +

    +
    +
    +

    + Remarks + +

    +

    + data is type parameterized so that you can treat it as a + certain type if you are using typescript. +

    +
    +
    • +
  • +
    + Optionalstatic_type?: string +
    +
    +

    The query's inferred static result type.

    +
    +
    +
    • +
+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/QueryValue.html b/2.2.0/types/QueryValue.html new file mode 100644 index 00000000..23088c61 --- /dev/null +++ b/2.2.0/types/QueryValue.html @@ -0,0 +1,334 @@ + + + + + + QueryValue | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias QueryValue

+
+
+ QueryValue:
    | null
    | string
    | number
    | bigint
    | boolean
    | QueryValueObject
    | QueryValue[]
    | Uint8Array
    | DateStub
    | TimeStub
    | Module
    | Document
    | DocumentReference
    | NamedDocument
    | NamedDocumentReference
    | NullDocument
    | Page<QueryValue>
    | EmbeddedSet
    | StreamToken +
+
+

+ A QueryValue represents the possible return values in a + QuerySuccess. +

+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/QueryValueObject.html b/2.2.0/types/QueryValueObject.html new file mode 100644 index 00000000..091ea2f7 --- /dev/null +++ b/2.2.0/types/QueryValueObject.html @@ -0,0 +1,262 @@ + + + + + + QueryValueObject | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias QueryValueObject

+
+
+ QueryValueObject: + {
    [key: + string]: QueryValue;
} +
+
+

+ A QueryValueObject is a plain javascript object where each value is + a valid QueryValue. These objects can be returned in + QuerySuccess. +

+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/StreamClientConfiguration.html b/2.2.0/types/StreamClientConfiguration.html new file mode 100644 index 00000000..c4a07294 --- /dev/null +++ b/2.2.0/types/StreamClientConfiguration.html @@ -0,0 +1,420 @@ + + + + + + + StreamClientConfiguration | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias StreamClientConfiguration

+
+
+ StreamClientConfiguration: + {
    httpStreamClient: HTTPStreamClient;
    long_type: "number" | "bigint";
    max_attempts: number;
    max_backoff: number;
    secret: string;
    status_events?: boolean;
} +
+
+

+ Configuration for a streaming client. This typically comes from the + Client instance configuration. +

+
+
+

Type declaration

+
    +
  • +
    + httpStreamClient: HTTPStreamClient +
    +
    +

    + The underlying + HTTPStreamClient + that will execute the actual HTTP calls +

    +
    +
    +
    • +
  • +
    + long_type: "number" | "bigint" +
    +
    +

    + Controls what Javascript type to deserialize + Fauna longs + to. +

    +
    +
    +

    + See + +

    +

    + ClientConfiguration.long_type +

    +
    +
    • +
  • +
    + max_attempts: number +
    +
    +

    Max attempts for retryable exceptions.

    +
    +
    +
    • +
  • +
    + max_backoff: number +
    +
    +

    Max backoff between retries.

    +
    +
    +
    • +
  • +
    + secret: string +
    +
    +

    + A secret for your Fauna DB, used to authorize your queries. +

    +
    +
    +

    + See + +

    +

    + https://docs.fauna.com/fauna/current/security/keys +

    +
    +
    • +
  • +
    + Optionalstatus_events?: boolean +
    +
    +

    + Indicates if stream should include "status" events, + periodic events that update the client with the latest valid + timestamp (in the event of a dropped connection) as well as + metrics about about the cost of maintaining the stream other + than the cost of the received events. +

    +
    +
    +
    • +
+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/types/ValueFragment.html b/2.2.0/types/ValueFragment.html new file mode 100644 index 00000000..2455bae3 --- /dev/null +++ b/2.2.0/types/ValueFragment.html @@ -0,0 +1,286 @@ + + + + + + ValueFragment | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type Alias ValueFragment

+
+
+ ValueFragment: + {
    value: TaggedType;
} +
+
+

+ A piece of an interpolated query that represents an actual value. + Arguments are passed to fauna using ValueFragments so that query + string injection is not possible. +

+
+
+

+ Remarks + +

+

+ A ValueFragment is created by this driver when a literal value or + object is provided as an argument to the + fql + tagged template function. +

+

+ ValueFragments must always be encoded with tags, regardless of the + "x-format" request header sent. +

+

+ Example + +

+ 
 const num = 17;
 const query = fql`${num} + 3)`;
 // produces
 { "fql": [{ "value": { "@int": "17" } }, " + 3"] }
+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/variables/LONG_MAX.html b/2.2.0/variables/LONG_MAX.html new file mode 100644 index 00000000..9e6ad155 --- /dev/null +++ b/2.2.0/variables/LONG_MAX.html @@ -0,0 +1,241 @@ + + + + + + LONG_MAX | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Variable LONG_MAXConst

+
+
+ LONG_MAX: + bigint = ... +
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/variables/LONG_MIN.html b/2.2.0/variables/LONG_MIN.html new file mode 100644 index 00000000..998c27f6 --- /dev/null +++ b/2.2.0/variables/LONG_MIN.html @@ -0,0 +1,241 @@ + + + + + + LONG_MIN | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Variable LONG_MINConst

+
+
+ LONG_MIN: + bigint = ... +
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ +
+ + diff --git a/2.2.0/variables/endpoints-1.html b/2.2.0/variables/endpoints-1.html new file mode 100644 index 00000000..8dd005b5 --- /dev/null +++ b/2.2.0/variables/endpoints-1.html @@ -0,0 +1,294 @@ + + + + + + endpoints | Fauna v10 JavaScript driver - v2.2.0 + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Variable endpointsConst

+
+
+ endpoints: + Endpoints = ... +
+
+

A extensible set of endpoints for calling Fauna.

+
+
+

+ Remarks + +

+

Most clients will will not need to extend this set.

+

+ Example + +

+ +

+ To Extend + +

+ 
  // add to the endpoints constant
  endpoints.myProxyEndpoint = new URL("https://my.proxy.url");
+
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+ Member Visibility +
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ To Extend +
+
+
+
+ +
+
+
+ +
+ + diff --git a/README.md b/README.md new file mode 100644 index 00000000..e69de29b diff --git a/latest b/latest new file mode 120000 index 00000000..e3a4f193 --- /dev/null +++ b/latest @@ -0,0 +1 @@ +2.2.0 \ No newline at end of file