diff --git a/docs/0.8.1/assets/highlight.css b/docs/0.8.1/assets/highlight.css new file mode 100644 index 000000000..7b34b7560 --- /dev/null +++ b/docs/0.8.1/assets/highlight.css @@ -0,0 +1,113 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #001080; + --dark-hl-3: #9CDCFE; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #267F99; + --dark-hl-6: #4EC9B0; + --light-hl-7: #008000; + --dark-hl-7: #6A9955; + --light-hl-8: #0070C1; + --dark-hl-8: #4FC1FF; + --light-hl-9: #098658; + --dark-hl-9: #B5CEA8; + --light-hl-10: #EE0000; + --dark-hl-10: #D7BA7D; + --light-hl-11: #000000FF; + --dark-hl-11: #D4D4D4; + --light-hl-12: #000000; + --dark-hl-12: #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); + --hl-12: var(--light-hl-12); + --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); + --hl-12: var(--dark-hl-12); + --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); + --hl-12: var(--light-hl-12); + --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); + --hl-12: var(--dark-hl-12); + --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); } +.hl-12 { color: var(--hl-12); } +pre, code { background: var(--code-background); } diff --git a/docs/0.8.1/assets/main.js b/docs/0.8.1/assets/main.js new file mode 100644 index 000000000..7270cff8d --- /dev/null +++ b/docs/0.8.1/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){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;r1&&(oe&&(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(ol?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;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=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;l1?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=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.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.handleValueChange()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(e=>{e.style.display="block";let n=Array.from(e.querySelectorAll(".tsd-index-link")).every(r=>r.offsetParent==null);e.style.display=n?"none":"block"})}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/0.8.1/assets/navigation.js b/docs/0.8.1/assets/navigation.js new file mode 100644 index 000000000..6cffbe8a7 --- /dev/null +++ b/docs/0.8.1/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA72dW3PcNhKF/4vy6t2NvLlsXJUHW4oTe9crr28vqZSL4kAarilyihdHylb++xZvMwSJ7j7dmPGjZZzzoZsYECAB8Nf/nTXuvjl7cpa0zfbs0dkuabZnT87uyk2bu/pv3V//um3u8rNHZ5+yYnP25PGjs3Sb5ZvKFWdPft3LL8o23W6u37q6zsriadtsXdFkadKUFeP6FS8biN+c//DN37/+5s9He9hY/F35yRWvkiK5dSwkXJwyT7WRfGQUx8tdmid1jRAZN78254//MQubkV3tmqws6kNdmoddZE1Gy0V6vv7h+/NvH//526xaNXqpPwZKQtlnG5OX9RAhoOayHCi+ym5WNK66SVIlNpzSb7/78zcvoWletpukaM7C2bhxSdNWrib+O90mxa2rn5d5Xv4euhST/cfJ6ONCAl2TV+XGHbxd0d4hzp3Kt/caOFX16RrLgAsulO5Ce4keCr9OquSu/sXlO1W65jKsE+FwYogeLmAFhfrG1W3evGjc3dumcsmdItylVBMyjRXDXmEJS134VfheIdeiwm8ZK+V17tZoPAEDmrXlk1DDl7zGrzB+QUdT+nLN6/r5nKnn53Ooak/z/LJM6/+0rsqmjMmuXxEyajAyK/6gc3+QXbWVlmu7y/7pHhS+i/Kkb9Mk6fbOFZDpvDDl+KzNP3UhAX6zopzbz67p035Zpi1YU0ImUODsLstDvvrqr3QQp+tbtYxRQ/lfJHl+naSfANtZUdptl6RZ8/BuW5Xt7XbXNi+Km7K6S7pRFoTg9SbuRVtV2MUBbUy1eJdUty66EnsXsg79zQjBTAV5J7xfWpaHfMEWHdKQ/mXRuGKetLfZHw7ptGglzapqZQtfKUjvob2Zf0q83EI9/DGS7xlRNblMmuQ6qZ0u7LBKwbjI27phZx0M6iBWEF9X5Q5pnoyUpF2/322SBmr987K0X9944T5hWZ70dblr3GEQMsyiEAAl5ElTKpWclUyguDq7LaabvJYVFgtEI0tHeVFs3L0S4Wt4/3+VaZIbQwlred4bt8u7J2xZab1YnAPNnl9gCLUQYM7K/pPRYrzVozmQddBhnA+Z+71vVWrSXImz6lfJ7o3btCkyuhLkJHU/YXxT/o5gFuUh3w9J3kIxhEQMAW7HQAsei+A3mqVAcn67TapN17wV5nMN5f/T3a55uLr+r0uRavulSc97l7b9cLRJGuSHtRLQzrs8yQo4zcvykO/VDqz0WkP5P8+KDVxprzDl+LNrnqZN9tm9S+pPNdz9EzKJ0k3vqiT95KqfPrui0fNIA46c55fXOpSv4Lz1Q7ewimGwE2MNFjPiauJP4lRsQsrRmJmUCo34MPUIzT8UeE7OUadpiYq1EnEEasijIoomcA3sWIg1ln1av8ru3UYFI6QQ7Y3Lk8bKW4oh4vBawwZcaAGehaPx7wcffddhIQXUDLMfHDtrF8eoGaZt0kcKGdIrd3ftqnqb7YwB8gYM+XVSNVlX2Ahm9Qw3ZoIryBnq23TrOtOqm0hoeGEhSFJHR4sR4svy2gSb60COLYeekCO5pEq32v4loGIZaVtlzYOOsNCw/tVnVxl/XLSYJfZLisxIUs0x9325BUmKGeJ7a08ZFnKkNtuo2rkvoJx/ccnGMEUhZBxF/WQ5KGIJtsEiI2VpJo6GYLvx00qOFXMjlPQc136D4tUQU3OLIoUcydY90EqK1Q8sL91NVmTg0+y1gvV+5+6bq92wcOvS3SRt3jzPXL5BSYye5TrlS+SgiCK8rMsCfiDpFaYcg+NfwJzSUZwrZFXKFbceJTRgBjwJmYYyXiIj7KA2MI+CttUAXWnBaUWe24yVu3RNkuVuY7y4gg9ej1g+yC3ryIfHsgPLHtYzqp+rcFqAZ+Fo/MdFpTFhURY4PYKK0YY1ozrMQsP5T8s9VYCVSCJ0bwyUTy0ZKUTTPrVkxRDR0AwpLcCzcCD/ccWeKR5KC/AsHMh/XMmk8l9qWP9paqYLISDDKJaOh1azTO2UJyjiCOObYxVgqeH8uxfIpoYcFEokNQFy1q3ZWis47/2IJmaIIJpoahBF1hEtjY8UQ0Rzc+QdYLadqWMNz5bjIiU8FPwYro7XrRKLizboALPtTIj1xn2uL7ObGxVmJeII48UukvzhD/wBLK0EWJbLZWiThqaoaIHmhqdub+pmBreurmDMVI7Tg1wrT+a0lvVVYRXDWC+LuiiLm+y2rXQPdhVWXG1G2+n9n70ukBFXk7Kq7XRSzBDVL5FCGs7f9gqJVnIsC0Xhb3t9RAoZUszLI0HOUNXvzEMayn9Wp4vKJY0b9hf2Ote4CuEhHgB/ar864kylYDwNHtuDcEalkvUsqbPUDpzkSuoL9mQBgTmIESK+8D+sohn1rizABrEvSrt9zmpwX8q8LOPXD0wxu6ko5eateHqDLmwPq0QGuOthWV70fVlea2yH4ohr/5JCaT1pEH9Dxj0VyZjPKnBGUMUz9G/GKR3AQdvPSiF5KzaWBiS8u9JZ5drtwnVVk0GvPkkhQsJ2ha0VtPcwUIBM90UlN3i1wUpAOy/W5kHmaw3v/8EVG/YMIt96X5x2XZ7hhtY8rBM42vQERCRhuWoQAQQ0lL/1kAPt6QbTrhBXbLLiFgCsBKRztw4R7mT80pTn7BkB7BzScP4qY4Uj1lMty1O+7n5XVs2PvONQ6GPvfPAiDqLab9rDPA/lIfuLsqibpJD2PQbc90qI83rrzZgWZ/5JhF7tc+Zn/72uytTVdbeHtK3tkLkLDXv3sLMH0omX1v7hZcFlL4qLs5SerBWsQLoG0WUCv1YMrDcScjoMUYUb5h44lj5J5iZvXbL+ndxhbW5t30mx7HgP/3TheNJT5s0HnTaJFEvO6CUyEZxwY+FTZG2y1v8ykTyt3eXebXkKjjYgSg4F9ixp0i0UGYnpLdYhLgP0Hz6bgiQsThEohUKDjQrziwRoDa1/JmCKy1ce93cXAoR/est4vDcJprjCDqe4aAQJvHKBJ7imeDmfU0TN8uTY94fLDM+FlyNiNt6g9iS3pTBJl1d8sC/iwiN+/8blnfnyqnpa3YLBBoSnyGkIo0toN8NFuyCeNjnxGZ0ffqEMNiiFgnzu3AYJMEzo1NzPb7nHXx9WRPf6NE3drgGDIziDhxCi9zJHH2JYDv/msUkjzRk8uBD7Oyuwm25iHcqf4oc9cz/NcCIIkH+++9cl0DNQDzZTnSxjc8YJ8xbGgNlDnmh6tEFwspyN9rp0LYMQErZihGJaZovcDqaMUvY57qMrgEc8vWK3qBiiphyOetNkQdK9cya2x3fyuHTxHLahGEIKiI88DqAo8igguMcmKsalx0lDXcHAiG3DuqD0uHPHMCI4XXw0v0V0h8ij97swY2YipW+cNBiyt1Rig8WygpvGCtCJ6cwNEwOz+SCX0jXf+mLIWVB+9MSFKcfMXpiAp9CYutOm7HSp0qbI8oRzrTvqwDpgj3Qvy61qhqBIi6M3App0zAZBU7DGEdyGF5PXL9MpCbiTZDimm/JMYtP7hdL6BdJpTqO/bS0moYQT+rAq1wdOEXs3ZQbiI/9yEVsjnW/si4k36ANFbWzhYaCypXcmsVF/sWi1UXrLyw1RhvXYxHK1YIiPk0CFVxKRkdqb8Rfrp6K6J3OvdPLOyNQHRXY9X6rHielojP3LqbsVdW8i7K3VhojaYU/qRysoeJg8FRPSErVQidYf+ekWzRFXRMz26BqiO31cp35oF0Kgz+zaqLfZpPzoSdSsFIrJJMHB0xm/KEkwOXpq45YjzTZ46+NcKU/Rm64hSMe5OuYYC2olO8Wb3DXEsMYCyR4H6k34d7rv8SN5J6InOUXufMCp1qNRFGQZ2vu6X5fe/wsL6SA4ScZm9sp1A2WOvUQPI3o5n6tpg5mwZ3Ti7IufIk8H81ONi0MEamS82m+02F+WFY2rbpJU3AT2l3Pf/PG33+FbmRDKUi0AvfNmlytTJF5ADMIeLJAHwNwWAlD31fMNyXkUCPnndxKBDE8tAIeTf7VpmqtY+/0OENx7L+GMpwOFYdtJIJn+7Jq+ba0HJgBgKQZgysx7KtjeGoyvhnEvGndnQ3VKDsN+zhFGsi5m/PjNxePUYjQzV2Y4mOk4dRm82Kr0a7twWl9cNtR2S54Ktle11pWSxQzzWvqjCRIsrOeRVfjsBhHl6VgE821RnMeYWOGHPx6lGoc/chUKfOoUpge0StRF3taNYhRCWyjB3XE2eEOmDFjocguwxBjK88Od/ZYUhe2o4G3r0JFGovVMxdovdtMuzweUOEG5DKSOpoRwvhiAsedUYsiABQCOQiphwaPZIdJMKWPYgzIhXMBBxgKnZkJw0oevwvzqK4hzGQ4w9feUA4692jX+yYYq5KjGcd0zkb7lGYF7vQ5Zv0p2b9ymTfExJWfCwvfTfe8YI4k2V8H2H5K8VUS0kgogZcNHmvx+46/uxubJMEB4uzUMmsuFIcD8M9n++YYgba/kMD/d7dan4wmAmYa1vndp24zh4snyZTxgtjlZ4T9TwfbLneAayKDlL7cnuNqp8rVQcphuuaUyXwcJZ9x97Gn/tHh17ryACIkRmPTZORAbtpEqkOeX6+9fA8SZTkJYR9IBrYBiH6zo6YCdVCF/om+oQshAgjLTbEMNRDehOqHpqLoWpIkEnyaUBqQvlUDUaNMA5q1UFYmlY8ixMPENQYAZMoChxKcENVjPAgaHv4ai4c4dQKwdp8IcDpm1A5ceAnr90VY9mvIQ0DFT+LBcAAa/2KwHMzZCBUIfCtbzaRcBH//wgjMR4N5RK3psQK4AGmMlLFBw4FP1CuZercDFJPYgl4D70+oNtIVWRIU/F4OA5koRszhc3cILWojg5bHlFnLYQ0IvDzQ3kMMWAvh9XO8bkEvA7nhyA+gg4wC/uGRjnm2FxBLM+M5iLRVBMYNaykCERuBUoJjRB6GXkPH3X9ZFwsfeEBkPGK2/JYblEjCmkyH0HJL8Yo2AWuhExOLEOcS9l/APEOlj2hDATAhglE8QZxrA/J27b652rkqasrp0N0mbN4aMUS4i3pnWpaylHOhlXRbKZ+4HCWccnNXAjKCaw13hS4mvPnFGodkQbB0Sa2Hj9Ytijh5G9BFrYKyIbtEX6QBh3Was5KVrkix3m6gLz7npqnOcaqB46tRA5b1O8BGrQHzdXgEPOYBYO06FET7EjFODRrpKRMNB6LD63UKbKyXMtGLdwPGlCKh7s2V6Vk4ZwFDbs3LaAgabG2zQAcTacRhmcXqoARd0ALF2HIYZV0waMJ5SxOzPubSQFmIcZu/FCA8RbZvqrqUSaFxKYeB4SgkzP0LMwFrLEaARhAEs60UXOgmxH2XFD1d4K21FjlABJdjeTMMWMDiy4TI+qirEopVI/yikGHjISVmNeLwSOz9VKAa+9lFVIRaNIafvohtovlQCeeeIGWgBPYi0X0pL6zU3Wk1bjWyi+pZpbJB4O5x9MjcyMNN0dSaMwwK41r7MMaAVUOt1id4edD0fMpQqNVoHD/oyVEm2kypUVnVsJcIWAtj4VnSllDAx70QJvYS0wzSYmPehYbkAjH8bypkIcOPCkpWSw8zqdlG5pHHDLvNe6BpX4VjRCazG1NQt4EmrRD1tm20MrtMbkM+SOktjub2JAf4iwXfb0xYoWLsrKqDlUfWuLFRtZhDwpsNuJs1PYFQItv1AWuPaCzhTb+Wh8vV1QIuidBd1peTflu+Lq3aHeSrI/mV5rXd/WV6j5rr98yslijFf9oOWRc1nZFrUWiujrMtVgmoQp2tpvg5BqM8mWApliAmgM+/OjHBVkynepoflKFCzJXih4xHDKEnhPQgQU+X6F1/GAxaLeBWMhVLGfHDFpsTPNZmLePN+OXA3iHBFM97oFZSAGsDZcraUsqDlYmOcs1RymLgzf9SH/RAnnAoYT8Xf6aftdK7YZMWtgjCXsYDQaaOS+0Ej1L5bg63sdmcaznr2qEkJWCkRDN4T7hV8arpihopjNdbfGzwVZ3+R5Pl1ks6W/zXd502DplPZhd/XP3x//u1j74TSQfHjwTTNk7oO2y7zev54OO/0t/8DblhT5grfAAA=" \ No newline at end of file diff --git a/docs/0.8.1/assets/search.js b/docs/0.8.1/assets/search.js new file mode 100644 index 000000000..408d74e50 --- /dev/null +++ b/docs/0.8.1/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA+S9aXPbSLL3+1VumG99fISV0kTcF2yJ7VaPLHm09CwdJxgUCUs8pkgNCNrteeL57jcIcAESWYXKpcSOuK+6w2IlfpVVqOVfWYn/8y5ffl+9+8vv/+fd19li+u4v4ft3i/FL9u4v78br4vm/J8v15Hn6eJetVrPlYrAunrNFMZuMi2X+7v27dT5/95d3L8vpep6t/ntTYGQp8OG5eJm/e/9uMh+vVtnq3V/evfu/7/fPPTnrB8nh6edmOzevxWy5WO2fX/x4dXl6t0UE8P2713GeLQoXfxwqkyZJlO6rMhptCD3h9vbWedQOz6lVLDgJ43291qssL//Xa80+1B7jrYoftl401PR1vFp9X+ZTzzWtPeYtaxqeurx1+7pv0US1V3vTGs00eLj/5f6fn4ej85uH818ufhrdDe/uLm+u9dF7lkfpN12tvklwGCIny8WqyNcTL43Ta1r3WqlGIxbLr9ni03gxfsp8VAuYP9SrWE3/a7b6r9d8WWSTIpv6rmee/Xs9y7MpnM30qtp+wvFqW7rdX1WBeaSes2/jIvNQy/AkPm0smbY/yjzUEpj3+k426jVZLr7Mnta5j0rVbb9djWqunC0X9/X1mZf2OjzEbx0bFURX6PZVeHP1v6qedo8NyY1VP/JD+3OSw/L4rl0WDhSzRZHlX8YT2+PMZhwWG1hFXVe9CnA9tzUuzbLzYlajAm5LV34FamtUpAD+7jo+Tdw9SGsyCpT7GszRqmgtQiIXrT2EtSkXA9f1V5Rfj7ot51WFkH+p1gpL+oqIzt6YV1dZ8Us2nma5Bn7DmGrvbzBv+mq2KsqfKnX9mjmv/b7p+/G3rPzd5eLLUsP9wJ7PPnQYQOfL9XS8KP77SzYu1nm2+u/J83jxlK1+Xs7ny+/IAmRXYrQrMQIlrCuRg/s+LaeHESNbrF9cTG8K2SeQ7grVhoHDqujny+vL+yGfp7c3wMQqTeFsV5d398NrAdvegBZbXcIydJfde9DNed7ZfbjNWx/lfxrcn/8yurv811AJsdewyPUsdB99mcOkd1nrSPAbzp/MZxuLWug7ay4jpFodXsf5+KU9zTLrsLf2pnXI8nyZ3y/nWT5eTNrrNWZdWlbftE7z2ctMrWvtjL1pDbbFbrPVel5cFlmO6v/cl8VgXP+Nby6OinGu1io7Y2/BfLPIbr58USXfm/TOv3zVAy9teSbO1+0dABO4MuX7vW3KtHk2LrJz8IK9rO6KPBu/qL3AXU/xXufuzcLncjb7JZu/UjYM9VLWTQOy3kSf2OnpxhMRS8y1ZwPGMMh/urwenV9dDq/vR/eXn4Y3D/fK2D30CYKaYE8y1e7q5vrj55urK191Q+z7q1nzJZ8vF9ln4trPrVJN029Un2/j+Ww6LjxVqWXdX63E+yPHRpLskyiN1D3KHgZ/MMN0jrSwJHW0NT6508mtJxssMkfeFphi/yChG/vJdk6eLZ6zfAZUSOdqmR5teslHRT5erL4sc18t1Ws8Qdho1No9ZcVv1TgzWy6Gm82nr1qiTxKtt6R1f12vnn3Vdmv7yH03z8ZTXzXc2j5CDQmje3P77z62551Bv7aRPR8/zjO6+ACebrUqHeNzZnCeHrxsNUB5nPGwdfaSLdfF53z5MlsRFDx6VVtP0hn3aHW3RnZ7r/Q2ePe/Qr9t/QG42iQTbtTVOX5sqtnFG485RqOLjg4YFVY5TtCo63S5yKoSPuvbeMrR68w9kqDXW/eYQqPu8+UTFk2lWOf9E45e15f6cb+Hmm7tH72er9UgPj0v42x91rj1pKPXvdwTbgbTcqt0t359zaswFK9TtuWhR/fI43iVXWTz8Q+fHqg/5Og1zv54vc2K/MdHLCZfczRvPufo9a6WTf4XZv8/WYhXlf3QcdtSZ/m9daypYZfrRXGx/O530V17yNG78mzxZT57eva6CK094+j1pUb2MKbq9nHIseqaLaazhd91yf4RR6/tauZ5T7F7wPFrWixfXzOOcOpe1/0jjl/b9WSSrVb3s5dsVYxfCFEvjGq3n3X0+ueblY/PSu8ecIyaOl6F1FV1O+5Eeq1jnhXr3OvyYv+EI9Rukf3hdSWxtX+Emv0+Xv1YTHa/+h+flRw1HjV6u/pazq1WrkEIK1rMgXOIwdYuL4BgpRcv0OZgnhM1DAlPgBGo1vmuAo3jaS1C0zqLZdK0e+i3wNwpvwXO/TD743WZF/+vuXbfgg/Vb0b/hVnFqvMtME3poy4xuPW03ghRdw1P/bCrjOHpF8OfBw9X96O74e1vl+fD0cPtFYUEL65OdT34ZLm90421Lc/hAlPa98vFqrAfWLRxmsU4FOQxqg1BGpm6XfGUFXdZ/i3LN5cW85cyUIaCYyivwfUpe3nM8tXz7JXPZrKhwfewnk0tqgPKsyuj8fzz8et4Mit+3D/ny/XT8+u64Pupy5aY93WNPON8u24nEztZ0/DxxePD6yYeltrO9XJy3y1XxXbBR3JSo5gmxaDzioSVZoDdfWBSPWfj6cW4GG/OUCg4oJxGXxnM5xeP1I6yL6TSPhePK/Qye0e7HIqJKabZPCsyTou0Sqq8v1tz/JERt6AxHnKc1Cym8/YsJ+sXa4iO4e05lNPpuwwOUE6FY/NGLifkkfZQTJOCO9K2i2tS/W2d5TP6ZNQq7YFJ6LC2FRXGn9bzr5xOVSunxvExI79ih2KaFIPVp9kftiMPK8yhtC7TbTYfFwKqQ3ldLl63bhfXmuEZo3WrpMoMzwBpFtOkYPRptLQuE6NPG8rrctH7NF5cZTXGWX6sVftRuarKVrOnBXtNBktrve1sKkN5lX7EhsIKq/QhNhFWWN9Hgl2QxY7O6n/3APIaqVFSmYW50MUMqJD9Nsu+U2G2ZdSez12KgLJqPMw2ahbVppE4ycMe5CkrPo/zYrZ5Y/mDgMGEiu/2tpnbb6S8Fy5uw1rs6HLeZeN8Yjlg7sDbF/dBJXZey4wuJWd4hYX1icRe8zHy7o0P/3idj2e00xu8vC7Xz5u/c6G2hfWJxG0JjKgQMptQueU4DabZTpLm0W6Vp6y4XEyzP7IVf7ZGDah4qrRMddGukNKOlMzQLKbih+1stBjPf/yHdoqDFFYk4qEoe4X5JunP8GWEysYo9WQUFlTRd26z1/n2AydckQc3oUJ3N3nONgF3OZcNM6BL9uvykQ1VlVUagYQtaTOi0eeFeEYLGjqZkM1oQWWsqPVgajAHLKvNw2lFL29k3e6vS3LQCyyrzSPAUZtxyivskqBKxIAO2WSdzwrL7SMDz76YxgjAoWgW04kdeJ39NftBD2TYF9Pwxfn217vKiaIiO2xp9KDzZS7YlrRLq/hwma9EfkPKq6xbBkUxnjxzllKNkkprFh4NUlajH/FgYEGN3sMjgQVV+svVcjKec1ffsLBSr2Ez4cU1+g4bCSmr0YPYPEhZlZntNvu2upjZPoSAT221ciqrjedxPhXMFlh5zRiUg31mFErDgMoI8MC97oIVVhmnJ8XsW3Y/Xn0lB7c3SmqwsJ2DlFXzzeYWSj6efM3y4bdsUbC8hNjQWeFKAW1GVFaT63xTTuUSk90UhxbL3UqhOhQ5PN0pZ7GT7+7pQI1S6kyr6jbgbJI95JZcWm0sWFCdbJ8iYvsY4pVLWLbFt/9K5f+j58rhYnOr/+N/Zq/ny5fuVHyoV0029B1cfubmtvqYJ8m7oKAX1zby2zVuhWM3zLeEnDvh9S9132ar1+WidsGn9uVo7HG73zs/t2vAypu5aCmP7+3LOlPsDZhzHI2LNfqV8m6cfVltnPt6ehMG0r1T+hIC1jP4HjCJ6bnj+7+OQOHJWT9IDnfVz8fz+eN48nUPtcnqh/PsfirpxNZkhY6P7rmmHqx5Yl9N/H0evrwWP24e/zebOPeYWhGJQ+oUv66WCxrEoYQWw0fk1j/4IFEHk9mC2uhHfJE6iFivlsVPRseiKQvIzrVYOaKDu6i4Trb5zOjoMhcD2bG1UmqOLLOHChh6OwMkp9Xrr9bCLTRmi+JwoAWtWSvILetg7Yivjisd1+EuvsQb4nNnMg5aU7jaU2uMx/ly8tUPXm9v270xnP2p07do9eH0LkaFwIu+T6dCfqlBSbU+8yWr3afkYfS2NkivKfSEuQ/kxWM2pswqKGPdkA9QqKkxMTGdTQ+ymYaYidhONaza3MTpxNTYnKnDDBmjL/H5ssyiVtOhbSIMWlLyHh80q5/rL3G2WL9QCDaFyRi4rXqzHsa985vr+8vrh5uHOzljr2FMiFuaxZmHvw2v7+9uHm7PhwrQTWv+qHdfJ1ZArpnyx3t9c/tpoEG7N6TM2lgeHhJ/EdeBsKDa5D19lDH0pqQ4wbYVI9hycjkVOqi3N+IB8Mssm4sB90Y8AK6yedZIqclDrJnxADkfr4ryEPXSeQ1p4Gxa8oA6LorhYrLcfBCiESXBw21b84O8DcqSdtSmJQ+om5PF+WwiBq3b8TEsZasJ+O4Ic2iqG/IxPBF2ZabBibopI4yd8yKTDkx7Ix4AyZtGAyNvz+iMOVtM5utp1rifwQNtWvIx0M9eZlJv7mx4mSz/fblh+jaei+fLuiUfqJQtuAmSvAN3xyt+zMV4Wxse8IgqiwGQI7I4I36r517g8X0jZmAgjYwkSdU4LtK1UwtijO2xaOIKVvBNtRUUgCetoE6QKyt2Qq6wYrSqoat0IHNlFSIzQVXpAGaJKkRaZ02lg5UhqbiQGhSV3UV5trLSNHBchQVhESgtwDXaigsKK1Je3IDZCgwGLFNi3IAFigyGLFVm3KBlCg3GraDUuKHLFRsMX0m5ca6CQMEx4EuVHDd0iaKDgYuVHcdhUKLwoEOhWOlxHA55ig86GAqUH9exm6kA4WO3RAlyA5YoQhizWBlyw5YpRBi4glLkOPEwFSN0ypEoR66Tu0RBwud3sZLkiM5UlFBoibLkiMtUmFBcidLkhstXnDBgofLkhsxUoDBeiRLlPDIzFSnDuCxRpozIqEK1+zVbqWoZOJZi1QYRK1dt56gqWBZiBSULt66saNmqoKBsUerAU7hsFZAqXRR6juJlY5cpX53kdQXsl9rX+2jSV7vkETQvAwRV7EK8oDNbmPg404QVEoR5Vx9DJMd414vptSZ5R4yRcPfB0BkGyGwx/Wv2QwS4N6EOR9rKoGz0DYwj2urr7FVEtjWgD1aM80LapDUj6oD0SPM2HzPM3IAHT0a2HzOln4g0CqqNI1/r+QVZFL2vxFyDbTuKuwiEj7t7MCHWW/Si8VVYWqNiZY8w2xsxqPM96gudljUzchq3AxRe7mp/YZd+zctk4wjt3YlDbXerj/RuBNmZuXeDHMDBZVLey94qeIyzbJSBfIbdcoEB7HX3URDCEQhO2LTkAfXfQsB/+8GiX5XVGiJtiK2d7jbXIGOn2yh5rJ1uG4K10216wRbPIabbGvEBOPtyvVxkn8ZF7TsdTMymKR+wm8++rpz3cCbOvRUfiHn2TcpXmfABx9FdEEC27mKCbO2ZWCNMu+SR4scURhjEC+YRppnllwvIyPhLwJwsF8UmGWY9dRaTtGnKB+wjZTg0YT6SB0J3QM5GWelFtkLG6GtMP1lrldQ5UjtHOqH9nKENUrPBO1lrewU9Dhl8/nx1eT64v7y5Hv16d3OtBtxDLAtrUH8GXptPD1f3l58Ht/ejT5f/GF7oVaZt+A3rcju8Gtz7qc3BtPf61PvDzfn98H50d387HHzy0+PAE/zU7vDK/9QYyqk1KUt7fc1v/qoA1yutSF1Zucq8Ktt+Kpi+KGsUPNKarM3AWZI1XaAf8YxQSiOdXZE5Ec44Ljuy2QmVFdGMgPIjmZ0weRHMWC/lRy47gTKDUxFSSVCqO+pq9i0bLkhB1ibWgykPsOTIWYSSFzHrhEc5cjbQkQ+dneHWZT6fu8xdpsUJ63Y8YNLCHQyMjIAHZ8CvYrqvHtGk4w3rHNrt5SCGPZheEE7ggzMkQwNAGLkSgAnRsGjkXwxFDRx3Eal0MRR3jbdFpY9rdNQqCBaZ2tfoSOiSRafuNToStmgRqnyNjgQuW5Rq35iio/MXqUZ24WLV03UvC7Vo8ep4CYm3iEXvIAkWs26wkkUtRixe3Lphsxe5GLNssesGzFv0YrSCxa8zqtb4JlkMu974Yy+K8Ut/ssWxt3tpFmbhYtmIbFg0/22d5TNOmlqs/HGXzG0UwYq56RdTiFf1Ix3WgzF/wPyuigALe6oJ2N5RxZs81M6fouPqbvlwf/nqyBi7Tof2PQZbKqDTwZ1H5J/W86+8w69mySN1ZgSC032BF0zRM9tfSQFrdnxgMrolRsntiEZIrOt9zBixcI2CR+x4TQZuvzu4wBwIJ3RPb8rtbZ1wTO0LYZRoXq6oXKURxxUpjE7ItLhgAykjLNgZMM++Sdt9a8IDHHMgBHyScRBDNAyDg9Wn2R/ZlD0aNsofd1BsowjGxqZfdIdIDFQwUjqhygZMhFhh3HQFFw6fOLzGKOpUAfZginDLxlQnXObQisBKRlgnVP5Ai9AKx1sTsHHYvc02jSkZeBsWjj30tmFEg2/TO9rDLwYrGoCdcKVDMEKtMgi7wouHYbwCOgOxUyUEQzHCLh2MnZDZwzECLBuQnXAlQzJCLB6UTdDGYZmruKIGjj0oq2isuGu0h2Q027qg4T0G0FiYVcZjz+FLdnyd0dgtBzt7MMbSr8vGYhdg9lDcxpWNxJ4OCSy84nHY4Vhgm1WGdVUZK3u8VEDy68qoLzRSIlgIyUkRKJCzL6SUCGbMgyE/oKSrymZM+mVlCiQhKYIZkZoWgQLIS0+ldKO6AzQ2jDi0W9WGsjr3ql0vWZogmNcsTf7gX7TsBqRetbRatCQhY00rrYJHSjcmn1DaLtCYTUxs5KnEGY+RXscAyc2u44zK2F0YULm7CgoqZzdhxmXvIpyRyTcIDLC8mwPur1M5XE3PlWgRcx6gaTszAypjR+YOuJyM54TIbxPiwYwHyJesGAsBtyY8wBFWkAY26vKRgiZ9TcjbaxKcwhBZM+MBkpEcVGnpbUM0rMhYAQim8sddn8kDEIx+UV6t4REI/EWbE6xs7YYgKyzhfMVO2MEVFnQ+Yyc64TWWd04VkKzyEHTxYs/tpZSv+bD3U2np5yFmxQ4uWwi64fLXgxiwcFnohMxcHSK4kkWia0SQDqlgyageutRJ6vcFE6wjDbjex2L+qlIp2soB2LjGZEVbmS0ce50pj7ayeEd9rYmHW0lWm07A0vUmgq2y4vQVLNYFr7Lq9Bks5lABnZWnUyVka08EX2H16faiaqw/sXdWbQXqIVivC166CnVDlqxDMWjxStQJm70WRZBlq1HXkEgtWtGKVD1+04HW90snWpcakN9grJasTZXCTp2gjetTTtip0cCxV6fisFOza9TXpmjcqWRp6pTTSrgyRVJaaSxMPcXMdqCrLEs9xsx24+ssSr3kzeuAV1iSuuXNU1iRYtnztBak+vHKHejS5agTsGQ1iiCLF6Mu0Oy1aBtYthR1jAhXYhUtRLWD17tZPb9qolUoDux/bJasQXUi7l2Q4cc4WXGRrYLHuOiEMnA+xqkfF2liI68sKXjlr+SEOzMeIDnfLMM52Z8sc0Ul3lcwYHIuKzgj0j6qhgMyvqnmirfIvg+nM8LNOpywZsYDJGECN/BRJ25nNMa3a5WCuGyIMTZ5EL9HhxTUuTZB/BwdxiH7Gh3mEvTyBOdjdC64wm/RdTwCrwvjU3ROVRF9iU5YE8KH6Ih1YX2HjlUbyWfoyH2N/xU697oxPkKHGed+g8755Xb7BJ0djfwFOqM5w9q//H5wtpo9LXhbAFP5I+wErCisT5FjfjFhTpcTJdDKkj9U7qfJjcSiD5QTwDmf2TZCsz+2bQdGbrIL3i6zhePdatd6wyzeUXjHOmGpbxkdl3fX3fKWsW+8E6A5996NyOzb7wRg+h14Iy7zJry/EawLWHAr3g7duhvf+Dnrhjxu4Sj35A0ostvyBg+J78x3wjJvztvsWiIVBJOZofiRohS0pjGTUxTmMDsmdQIjgjJjE9QXiURsZlyCEVsSlUDD5sYk2NBFEQkEfFY8ghGcH41AeREFsQjml1IaiUCoAD0OwYjNjEKgwDJiEMy43AgEAjA1/sAIy4o+8LP+tXJyIg9omDqvGCvqgAiqNgSzIw787SmsvNxoA3dNZCNQCtaQhuJHijvQWkOanKKwhrRjUteQVNDGb3WQoUlv8Iyjf1XthohLDgNQVG2IqJyQACMtOzDAzxxrZeUECfibCayo3IABV12p9Vt68MCfQVGycAjOF9W1JCdMzlmjhoq0WSDlL+NitlwIBaWWpT+DtoRDiWWmttd8KE4meLH45IwvXd4aaqCy0rVVAn5ZYF+S8a1LWPYYy10TBudTAi1f6KpiZlZpYnsCOOeLAkZo9scEXIHJAp4Zl6feUWCn2WqSLTaNqNB767b84M4Wk/l6mlE/3YrzNo15BF7NvmXDhXuou534YM0P8nz2MiN9QwJn3ZnxA7n6OnuVM26t+EFcv07HRUYQas2cdVN+YLPF9K/ZDznp3o4fzK8ajF/9AiqMTFsrnl6dYpwXKo1ds+Rp7p9MsleFsWhvxw8m48MwOCf3mzAW0NiwciZqBHhZHYFg0Gxly9bbQFEZYOgDBo+o3S/o5hXeLrA+QD+GnVgffgS7a73MO8O/rbN8lok2iA0TR98ntmlk28Wmgwyw/65+pEZ8sOcVWzJvINTi6cMJWjSLINTyycSEbZpTtr+XTC3QxFFnmBaMzkTTcpOf+cZGrzntGJ7jefZxrp3SJNRdSzgX/TbLvtOnn0OpI804AIAzydRqrnHsjkGRT9udsL7Nsu8SrG15bSyBdgsJpaqtEyxHr0VA2UptNyRLo4WIfHXW4QVh6bKt14SvyHYjMrVYyChRYR0hGforSslVXrsxyZor5OOprd1gVJ0VcrEU1m4slrYK2fiqajcgXU+FdEwl1RXtgpR8x8h3Qc+/4wT5lC/Xoo63M+AF7Cr7ls3FdDsr2ohEkRyyceRxJyjRNMGSxLux8my6nrinTkLA9hbUh95i/DgXoe0teEAjHyEgcLzDA3c88RgHDfmZxuRzmAc0hhoF2bgCFAoXt/bWdJmpUUpHWXpotqBdvWg+vyrKE5Oa9UeVlvvbh6GUq7c1IoDbmsMZfx5c3ckhd1Z8UV4N/vVPMeTWiCojpjjx8p7jpY+oQClkPDd4RFGRQiG5ypQbJkehwjDZSpXXvOA2Yg3lyls+9g5wkZLlKY25DVmmbLkmMOcqXHjecpHS5fiNAb7ihX5gQKh8EaCZCpiRWqKEOWZa5yhiaI51tjLmBspRyDBOtlLmhslWzDBWmXLmBsxT0DBagZJGQWXtNs28/D2nGzRLYcNw+UobAZSluBlp+cqbGzJDgcNYuUqcM6TKNMZW5lw/XMBR6PBvFrCVOsepgKXYoZMBX7lzRmUpeAZYvpJHw1UbY+XKHmXa1ZtzPaIyFT+tL210wrYVwN1PeUpgq/SRFME2h1QZbPtFQyG0cvKVQpNZHcXQDs1XDmnURAXRDs1WEh2YMUWRHUndKnxEPVEnerrtDkU1EUPkiolOkBwtEYFkS4m+ItANnNzYc2dU5gSqGLptQ7W82rIzA9TI8V91xRME3E36r77qeQIJWjAUqJ4ukKBlQwPGrTBEeF1rW9AVhgynD9x9zDapiIrZJlGHJNuM2chxEs108DByzFjcZAB+3ZUgbMwd0IFZz5WgJ5np4mfml3FCh7PivtBgPuclmMEtHGk+tMBwJkODdxS7cxc0uy/T8QVn2LYaSM+xyZXgnGV3VIB9nk2DZ51p29D559o0cN7ZtvVl5Z9v09CZZ9w2dsk5NwOecdbdSc8976bhk8+8bdy8c28aMPXs28bLOv+m4bLOwG3M/HNwGjj9LNxGzTwPpyETj0BtvJxjUDKs2mjHOg4lvnaMwzvrq8c9wKNhMza9NmrujrcTumtPwJfL7Jb+JHsEJeGsw2ue9wxYJVT3Dt7jYF1qpL2X8Bof61ghtb2Fx7hZl6ro7TV8xtM6vfx6ew+vcbYuddHci/iNv3WujdbexFNcrks9dPYqfuJ1XfhV9i4e43hd6qC3l/EV3+tSC6W9jZcwTxd+jb2On/BPR/q3GlY19kCqwYy8aijsiTRPA50rYdwj3WXjfPIs2BrVDRx7R9RiEW2EGq7xtf9pI+tse1zgqaEPNj9zwh5IsLPFNPtDiXZnyyPuJjRBq0fsbHnEfVwuv76M869KxDVzHqGfZ0/P89nTc/HzLJtPlYavXtvqW1Thev3ymOXaVdhbfYsqbErej3nbWUsdDmbfpBJ55qMOO6tvUYW72X9INxhcKrC16XV8l4kI2CivoB0Q0FVHIWjTIz5fImhjC5UBF9zVMtei3ZryCVuMaTfMbLRbWz7HEMH2Bhk9pLsaA3Js28rQLxeZDOjcL7pr9AD7ZRIjSWmEd8HI6B705ovbJxXdUMkfVew0676hVTjzwwz9OTa42id+qMv8bnj9nfdRKiPcAKvF/7PgpRti/IBCYWPsfhtAuwepbJTd8BU2zFgNtDbOjmqm2gYaFTV1N9LEKok31NYq6WysiVWSb7CtdVLaaFMrJd1w2+uksvEmVkm4AbdWSGMj/jan+rZZRm1jTqqKl1FOdaPu+0zfXA2VjbvjUaBsA4+eAips5J3PMUUbesMZpnxj7//80jI66Wz0HVOJGEqJN/6eEowIBIA2kZ4Q4Jh0hCsI2NAVhAGDeReBoJaumvMWgKzZRxQDYP5uiQTQnWBcvPGHuDrb/W5w9ia/5V/R1r4blHqp3wjKus5PANWIkobMaqHRTviieGgEXR4E3Y0ti3yG0Arhzg6vnizGufUCKgQ2d0NL9z2QWmW344gtiVtGucXByt3g/N0MJBbuYRw+VMKNRW59qEQUgOz6oRJu1DH+0RJRqHE3siC+GPJKg4pdYcnZLTuIecktCdjkHMJGYF4SYSoqOYuwnZeXRpgAzQ0wh7SiqHInTJ2pTRY/3g1KzyVsRGUmE6ZMDpII99YEIQ5rdwfWG8ZkWXrJ85vi5OYTVqK5QVqx0obiGvS131hf7cKLHyFZrwFEkq3X4Bpput5uUl6+XqtdecJeB2xexl4GNyFlrwM2K2evK7VVmVQIXDJk+T6yUqkdtOSeKF1FufQXsOReEZGSqR+s5A4uUjbVEpYywLWUTq/JIEjVESuf3tJAuFdDroR6SgBBeJXlyqiv1A/uldBQSr3FhxCrIVVO/aV7cK+ITEn1EBVC+GCMRFnVT/FA/WCMRGn1lNzBvQpC5dVHWgcqvEzCMNdAQchwq4ZMmcUqoKDQEtBlSq2RX0Gx9ZsaxEQvVnA9JwWxcL/JnCtUdjF0DYX3DXKZGCcsFcWXVgH9YVNRAabMvx4m37eAlyrDXmIxrfgWpVghDhM1c2zluA2kpiA7xmBylWQruYKibLKvrCzbq6GgMNPqwVWa7dWQK84OtTAqz8M/XufjGfGrMGYLx9ab2zAiqbnpHV8qMwKtIzA74a+yeTYplrwLcwh6zZ5PbNE1TARbfv/SCVumYCLcCuKlE3j2RzZZb359V4z16FtWfVbhC/8WGIL+RXjvywmZL+whxEJNz2004cp52EgiUvLccLk30jBc0VU0N1zyd8utwLxvl9OQBds0BFm6Q3NDXmWX7BQLGPTBnk9syZ4SoRZvJ03Qhp3k9ueCTSS0oHSLrz5EOK76WyQbI8JtY8s/6B5lcHeuB9urrCkBl3Zx6ouhKvbWnCduqbTQsq+iKrh1D9ZW3AYs3YUbbOvJIVZ4mRJCYueIB1Z2mW7QzW6UDH6eLaYCveBQ/NhiASARKQU1p/iSCSCujkbQDS4SCCC0XB3oBhZJAxBYrgt0A8tEAUisoAh0IyvIAZBbSwvohhcIARBaqgJ0w/IlAMgq3P87jBTczX9rlBDt/B1Audv+Fqhoz+8Ayt/wt1CFu/1uWMFWH8JK9/kOsJJNfgtXvMPvBpZs7yGveG+P4ho29pvfCnb1jeLH29I3MRT28023aG3mDZiynXzbqN423gQs28NbiaUb+KZxld27Q2dgbd2NqNJ9O2ZYb9Nuxpbt2N2pOdt1M7Vsr95Bbd2oK9wqa5v5M2zctW+VIc7yuZH3d6vMvSLijT0aB6iywX+DVMymCuhs+N/iPpOpBkoCgGMYvo4QgEbiKwoCbpURCgNYJTQEAt+XgEzsCoKB50tAxlFILCB4zmhrBBcLCs6B4BJhwRABLhYYvId+m+A1BAdHeKnwgOKrCBD+Y9dN/CqCBDV2vV5GKFD4yiDMFCqQJLk6goVj3DpTuLBgywUM3LiukGGrgFzQ6KyBhrDh6dIDofOwhQ6v1wVsD9AVPnxe3qDXgiuE+Lz04FgLKIyw7zr8Ga446Nxs8HYjQPMigLf4f82wf3/R/qpB/p5j+/VD+j1F8usF8PuJ21cL1/cSpa8VnO8lJl8rFN9TBL5e4L2neHu9MHtv0fWaQfVOkNK5z9Okx9h6K0b2uwX0s+P4jx6+rxi1rx2srxyj7yc0Xzsi31Mgvmr8vX7YvYdoe19B9vqx9b5C6vUj6ekB9Ly4+aOHyytEyfuJMVcLLfcTUa4WSO4pflwvbNxntLhykLiP2HClkHAPkeA6AeD6cd8q4d76Ud4qwd0+YrqVQrl9RHArBW77iddWC9PuxhPNXD6mLMZWUStK3CE4nBcTftxQcK0IcNXAb814bw9h3qrR3T6CuvViuZVDuLUjt70EbCvHaXsJz1aOyiYGY8tisP80odeKEdd+45PVw5L9RiOrByF7jj3WDzl+i0hjTwHGPuOKlcOJPUYR6wYP+4sZVg0V9hchrBoY7DMeWDkM2Gf0r3LQr99YX/UQX3dclZnW5xTL3NRqRhwTAo1l8cV/jrBi7WhiL0HEPmKHPYYMe4kU9hkgrB8X7Ckc2FcUsNfgX08xv15DfT1F+DICez9mRTktZqvNt/Tyl/FmPU/baVtMHGG73UVD3XPbHKQzzXYSc+ZaN2wot5RF6DpLrdiRBBZIwFFW6pU3QM2oq9EW14y1BnVAo37jtO0xzjdNHcDK/0jAtgbUwfb5AjLSp3xafE076pjFj1eZ/7YG1MEYu4kWG3cbgePF7cGMvnFoFtPZMdzX29C+NACP35TkrRFB9dEly693N9dCrt7WhgSutIYT3n0enl8OrqSQBzOeOO+H/7iXQm5taBLWJ/iLbJ4VGWOKbxU8wiSPM1Cn+bYLFGZTExp1PnWGo8wIBjjynOAMR1oiGejoiyRnPOKkZQDkTFs2xBh7SWlTF1bwTScvFIA3faFOkExgdjb6FGa0J53EOkA50xiR1XEi6wAlT2UulHC3epeN88nzYDGe//hPRt+1IsXVJrZxZZV0ImDi6dWM0dYGmINMc0r2B+mczQi7NeQNlLHrMLJydx923NjcSem7Eby4zsA+gJ3Uvm41oOys8HYpBvfgJxq3g58uXU8JXGh7e4sa0HvbJvpPw+vLget+y5F/b/MNavDT4O5vzrK8E//e4lvQ3w7+dXml3AB1o29Rh4erj4Nb7TrUjL5BHc4H94Mr3RocTL4F/y+X10PnIzU3/r3Jt+D/9a+q7KW5t+C+Gtzd6Q7/B5Nvwf+v4fkvqvRbg2/AfjG4vrxThd9bfAv6h3tdz+8MvgH78NPg0lX9dGLfGXwL9uuPV8rd5mDyDfh/vrzW7vYHk2/Bfzu81u34e4tvQP9xcHV5rrzUqdl8ixoMbz8p8+8svgX97XCoulLYGXwD9l8ury8uNdl3Bt+C/eFaf41fN/oGdbi8vri5Ht4pV6Jh9S1qcas8+u8MvgX7/UB7r3sw+Qb8vw4+D7S3WTWbb1CDvw7/+feb2wvNChxMvgH/1eD+N+UedDD5BvzXN7d/H35UrkHd6BvU4fPwVnsQPZh8C/4b7Q3A3uKb0N/eP3x8UB6FGlbfoBa3N58G2rpzzeZb1ODhTvstOJh8A/67y0+fr1T70N7iW9B/Vhd/Dibfgv9+cH0x0J2IazbfogZ/H15ot8De5Bvw3/8yUN2Mbe29BfnD7V+VPX8w+Qb8f//l8n5493lwrjr6NKz6qgUe7MGN8jjq5YQWAud2QqP+SncAEDDOJQAXNPLNiTYb7+qEC9y/11lO+hZhG25nQh+OkxejzcfOiOGC+Dx7ep7Pnp6Ln8mJGtqkbWMega/XL4+cKC0UeG/MI/CmwP34SYn4YM0ncp4pEu+MeQS+m/2HdOPGgrs15WM8nczX0+xiORG+bk1D3kA1RgZoSh+WnL2lDcnL2+ICR02F0mZjJUFxQivGtOwnCNvWhD7cZLle0BIeten2Njws2vLZfD5dfl8IV241M/qQT/ly/Vq+eDLKhh1PmFfyl7hhxxPmnfh1rpvRh8zHi6dM+NrsbXiYrblx4HoB4E6R39yQb+2cNY0R2kUEqGVB2ZSVhHd3xHXf0MIMMLDeDTeyAFjrvm7CzkaJlT+qIqGUkRL1i6pCgYLylQo3VKZigbFKlAs3WKaCgcFKlAx/mT7NvEJlwzFzmlThQHOoqSgdxApwFQ9rBUTKB7ECbAXEWgOZEkKtAlMRsddAoowQK8BTSKz4AqXEdTwXKCb4qC5VTkjgmiOPhpLiKR+uGVqirPhJNmtmFSgtzglnOYqLIeMsW3lxzZXNU2DwVNkCJcZxkcpXZNCVqlCZcYOWKDQYtVipIWAzFRsjtkS5IWDzFBwjtUDJccxPzFR00DTFEmXHW7ZiyzpDdtXfLWNx88fsy/6eshaTFSAkH65UCXJMWktUhGygfGXIYNWcSLUqtsm3SROHkKLHSZyKUjASprYcoaAGmfGoQhABkKQBGQnp8g8BkZ5sFodkJpm1YNbfjl+y8fQ2e53PJmUi2ovlZP2SLQrae2I1ovfGLCeXzmuobqTezp67W+3OMnXVL9fLRfZpXEyeFeGbVj1XgdiVHfA5ndoVHXbvu8lztpnec37nNpg4Xte2ATE7tslNen3CCs3tEd3Yxv7w6/JR0BX2pdV6wf8uH5m9oMnS2xlievLgFw9tD1DFzY7BtpOriqe4DjPHGQlcoBijQZfLjBMdaZJzgj/Y9I7/qA7/+FboefZNFbyy5x2blfLVw8LCHR+mg0XKcJLD2szoaAw/NTp3V/ZQK09pips61uowvuJAwqYKD67GzfqDePax2TjO1NNJxJh3rJ7S2111o3M3V5wKjItiPHne/E6vN/SaRr1XYLiYLKezxdNGbVCtBDDstyLkD8d2V4H3+VgO/LQcpDZfcNauA2LZb1Xm4yJbOZ/fdFdgb88z9nIynt9l/1YEP1j0i/6SFWM97K01v8iEJW83MXW9ywRWfCm31vwj6w7pNYt+0eniu4d9hSN4I5x5LV8s2mwcZ7HYScRYLFo9ZezQrQJ6VcCN+60QUXLprgRHb+GAk8SWbmy60sKBXmTfh9MZIV6qk7tm0XfPd54uXXo6bbrkAFNjTDqhWXEmbuBxx/BNjDex23hbPagLhikGdflJEHviDEyOP3GxbIlBqZ1TrehhKO3SalM5KRLYwsKIAzb4xRRa+3X2qsG5teMNs9hsOFVAd5Z8oTJiVEys3DAVK2xsfINoY6qxtFoEX73FzaOTmaMyQR9JzX4x5P+9vL8cXF3+6/L6oxZvDxhVgN+ax+swvL29uVWD31nzTf15eH2h6fSDPd/ktw/X15rkB3u+yc9vB3e/aKLXDHpnv9lkkrwfuqRHdISvWfRN//Pg8koRfW/OC7dlpcY7q/tThYt18PDO6fwGi3UhK6w1uqW4eoFfl4+CNfuh9PHX7IBFuGav+UV5zQ45RWv2bkxBB4Wk0s6Jwlo6pqhfHjOC0YzCCGDEneKltZUbu7Ots9Vqtlxsjk3yl1J7YFxiwU2otTvnroMFiX/nweAqi3Mn63xW/GC4tF7wWLeCWgysO0ENFyi2cJuO3a4GRHB0xmvNVsFj5P5BGchJf1ouMMXsTF9mC6GDensjHgBfsk3eEinhwYoHxF1hIWPNjA/I5XryPH0crIvnm8XcPRGRgbVlzQMy/eRHa6SxIcbYOEM+2GkV1NEfz2FXtJ6PtCF25VkHOW1n4CrScHAxdJHtugl7e1sy0L1VnPjvt5f3WsR7W16JBxefLp2+xtINvDPllfd2+Pnq8nxw7yTnOvWLmj2v5Bc/jR4+Xwzuh3c65A17fsmHd5cflTrJ3pZX4rtfBrcXSn7e2/JLPDx/uL28/6cS88GaPjXMpTl4nf01+0EUu1oFj7WxxEHYOUaazjBuO3ZurTn8y+xpnTM2627WjrNBcQVj7FpcPKi3DHeuCHdtLqgOeWfmXBnedk1QFfoezrkuzI2dpJuxN1LuvU22uxJUjr7lcq4Ucx9Gq0zsPBqTd2xu1o6xjXMkE+3tHH0p3vBx6sLcBRIfJd8asurG2y+q1I2wiWRVjbWzVKkZdbvJ7JXcPahKHakbU1Yd+btVnToStrC8+rH2tSp1o2x2WXXj7YB16kbaFvNqx9wr8+sHDhTPl/lKclSLlj/iOa2Zh3uYh3vIvLle5ivhhhq3oObUZT57Iu7ZLES9gzlaDzb4ybTPnM+X38/zbJotitl4rkaP2PVZjWwxfpxnm0JaFWhY9InO2HTZuLkbrU5omD5tsM8tQXsTsbJHELKMGFTZCvWFVn4/AyErsZ8r5CFpyPXmH8S0LXt+sIl3YM28nLuvNFBWIlATLD//pysw4dKoGZR6WZQCyMhDiENysxBaQNs5CLkDJ176CEOnBYQ6eBo8opcUUWsApYHyhlAbsWAQpaGzsjfqDaQ0WHLCQ52xiQbJSCiJY3LzSHoaRm2o/PSLFliYdfHwU06yRaT0MXIsYhii1IqYV6QZFe2QvESKRptmUYU7cyJFjxOprTJnYo5QuiCmNVsSEHlTpZFVME9SoCeT7JVy78oAuzPjBZI4kxspOdM4CZOTuVN3N0TALb+rJAbdWfGDSMqJp7MkIuDRxWe9NYYdE0jO3OkGKXqcSC2V6QZzhFIyOK3phoDIm26MrILphgWtCOwLdrJcFNmiuP/xKndv05YXXHrqPL1ZkoBJS9ymM6YT8OiHGHpjuh0THltcbZLp8r8AhBQ/0uGFiYRzfoE5ResIw8zJOsUgoDKFdiOwRGsnYDPUbCMyV9C247Y1bcFbZTRwNGVb680yu0ZP31Z8u8i4DGHTiMvVNv29Vx3AfIXTjgxFzsavOTonbuAYUqeBRKR2GtwjFTw7UXmap82sWfYUDK546eOIn1rDqsEjShKo4oBKAyVrikZSnqzod2Fl4xWodhT/sj6wY3Yy/9M6NGjmR3Vs4JLP6RDgGV9CMVJzv4Hib31go2VKk64rA/hTchJcn2uCQXMcs6Z8NHBUJlhJcCnrgcHn6orG5c316Ne7G5ebBE7MPcSwQiW2j8Dr8unh6v7y8+D2fvTp8h+uGTcdqtK2+3Y1uR1eDZwTn5LqcrDsuzb1rnBzfj+8H93d3w4Hn7z0NfAAL3UDZySCtSle+jgnJVprU4NHlM5LFNemZFDqV3JsrKyP4hBweUcQRmLBKYQvNcWGy/oIjr91kg2VKfe7rpPgT8m3vn2uk86RTmq9CGeAqdlh3e32vGJyB5ctm5yeo7V2IlRKsoBSqZP7KopVK85SSlAvwXqK2RPZiypqLVlfZdLVVInDgeuXmNTV1A6blrxWt9m31cXsyxfiUrVV8hjLVByCvERte6Fj1XebfZtt8ilL3dXDDPoAZ2QLw3C56cKMkDDp9PM4n4puiRssHEfft8Fw8lEbvKOm3ll5uRmqO6FBH9iNYIeC5E5gMnGcXmClYXQDo4OUzns6eDmHPlRkete1QzP7rgM2DKZ6eGWPXobix0pxYcNhR9Fg7jFfbpkUs2/Z/Xj1lf6JmVbZI2YKwVnY0dotrxgdKOiMeOkjOlG1Kxp8Y++Js+LHfT6efM3y4bfNISevT+JWjt07LVSifmrwmSXLrtzTHWbUXF38eHX/mKkLVG9nkZiL18nR4uTBPrqJO37c3UuIWmanGR1R877RSyyiQDdPaYohYXQ7DBfMBteDj8NPw+t7bfxew7RmTaqHGJLjDe4H6jXZGvVaB5hIbZ1v7N8/58v10/PruhBlVes0dswUa25w7Hxr3Y7EG+GwBHOtzKHEfwVqDn1cz7+OnrJiNC6K7OXVPYqrRdPDTLn7suaPLtTpcqKBuTWjiTh53txAXY2my4XzGWmbEFjxAfiaLTahanLGgyFdzGzy9XU5WxSjkuzbeC5BxYz5wc2mo9VynU+y0co9Qs+GDA2qYi8XxWyxXq4Fb1PDhibcdFyMH8crwWtUs6AKlq1mT4sRNXgD4WsZUsVcTkYzZ8kOoduV14b6ns+KbPRlPJuvc/e9Dw7YsqUMuxrl2VjmxL0JdbRN5YtsIaQ7WNEEnC2m2R98sl1xdaQsH71K3oqmEU28l9lqNVs8jfLdKd7oy3K9EKCaDWpiL5ZTwRC9La0J9PosmjR2xVWRJD1Ov6e95stJtlqNVsW4kEz9LTvKkE95tpLh7SxoguXZ63w2Kfd3ovm1ZUcXssidv6KDsVXFdZF2w1C5uM1Ermub0kStFtx8vn15fSjZtsLbTmJVjPPNVmUpWI00bGjCFeP8KROs0/flVaEqwUjWnk0jqnjLYjwfbTf5AkBgRhWREIeOkFHDzruB1q/TsfQlaNhQhVtluQCrKq0J9G2WfecDbUsLgQ40iBprO/g5/FwixB4eTzt2qj2df9CEe+Rw5vS5sY42H3WgMGVhCdKHjnOli5vzy4vR3c2ty7lSB2KvYUxGW5m1MZ/ffHb5RI8b89aYV+aHzRGbInbDnj/yS6fvPHXxXhI/5kSl/O1y+HcFzK0ZZc7aYFBt9e6aO0Yqb92Iz8Fh+I/L+8vrj3qcvYNFqYsbjkTpPw5ufxp8HI7Ob66uhufKFUGN+6/T7cP19eCnq6FiTWom34ZftyEOFv3T3z3cfR5eXzjdVnLlr9v0X4O/D7Tf6INFT/TN6B0uOe/+IWEdNbgf/DS42wwInz4PzjdXs8SoPdyo0M/my2uX1xfDfzh9L7aD+2DIG+vu+6Uqfm4a88Z8Nxzcnv8yUnNzy5438s2ySLVntw3qsrcChGCAF2nHDAsrhg2R4lZtMIx4Vdwxxl290YWdW2xY8mh7/RaIdNtv8R496rQLkRly2mFWId7UHZwbbOr0BFGkKaEO5DBTKn1j9JpvrhGv/rbO8lm2us1W67m7BI+UVRu58tKc+9hlYukdDBE8inml04HuJ3m1MmoOGxfFKNumthvNCOnyWjQ9zBTLeT8U0xGimKwkhC6Ak+Xiy3w2keDVTejCTbPVhBgY2qJr2NDFmy0m8/U0o8X/tgCBFQ+Iq9m3bJQRYndwxpoZXcj57GXGGYy3cLviulCrr7NXPtO2tC5SdRhHOqJtgTVs6OJli+noa8afHHoHA7pgIihPQIIBY1taubtvoh1kzVc3IYZDlh6sRZvyaq0KIMiX36ntV1+pNYyQPdVapTWXkzI0P1DsgauOJhu57GvbxXj+4z+EgITt7xUFjPI/vMf3tmUJPtnV1zgYLF+/L/Ope08CRHUDIqzY3EZWlWL746MoJLtnS0SRticOOkjjk2aWnXibY1OSD9OldZxfDe7uLs+FaL2DGQliadBwHPtpcHklpdwZ8cT41+E//35z63RAZqM8mPHEeXf56bPbMaoNc2/FF+X94PpiIHdnzY4n0r//cnk/vPs8OBf7tGHJE+3gdvCT/IXfW/FG+Wl4fTlwOm6xc+7teCL9aXD3twdxy++t+KJ8uPo4uFVwaN2QL9bbwb8urzRYa4Y8sZ4P7gdXctKDGV+cv7okBLUz/krLBErj++Xyengnfo0OZnxx/mt4/ouYcmvEE+PF4PryTgy5t+KL8uFe7smdEV+rzuuPVwquPJjxxPnz5bVGkx/M+OK8HV7LG31vxRPlx+HtJ/mQvrfii/J2OBSP6TsjvhgHV5fnChN5zY4n0l8ury8upZg7I74YH6511nB1Q55YL68vbq6HdwqwDUu+aG8VRs+dEV+M9wONNfHBjCfOXwefBxpLuZodT6RXg/vfFDx6MOOJ8/rm9u/DjwqkdUOeWD8PbzVe+oMZX5w3Ggu7vRVvlLf3Dx8fFN6mhiVPtLc3nwYamk3Nji/ShzuNXnow40sD/ayylTuY8cX59+GFBufejCfO+18G4kXe1oYvwofbvyp48mDG3zj/8+XwSqzO1+xokmIHxefLxZfZ0zov06VQD0kbhY98hIyx8M+Tm27RPlxGWWUnzU7AX2bZXIl2b0oPtX1CjndOlyPrRsljnp03QRQO0k3eY5+qmwhlR+wGq1rn7Z3QosN3m3Wdk/hufv6xPJ2efkbfzS85sKfXgHx6310BwVE+g59+ru9QA8khP70OrBP/7loIj//p9SDHAnTXQRAYwOEnRwm41EAQMkCvAzl+oLsGgmACBj8jssChCqIwA0YtGDEHDrUQBSDQa0GPRnBYXQhCExg1IMUpONAzgxYY5OQIBgd6QTgDowbE2AYHfnagA52eHPXQjS8IgWDwE+MhHPDZwRGMXQE5UsJhXyAIm6DXgB5D0V0DSUAFowbU6AqHCvBDLej85LiLbn5BEAaDnxiR4YDPDs9g0NNjNRwqIAncoNeBGsXRXQF+SAeDnhHf4VADUbAHvRasyI/uagjDQBj1IMaEOFSBHSDCoCdHizjwC0JH6DVgxJF0V0EUVEKvAz3CpLsKknATeg04sSfddZAFotBrQY9K6a6DJESFUQNqvIpDBfjBKxx+RiSLSx1EYS30ejBiXLprIQp4YdSBHP3iUAVBKAzjDIEcF+NwhCAIkmHUgBwx41ADQfgMvQbEWJpufHZgDYOdHGXjgC8IuWHNaNT4G6cpjR+M41iHRmTO6+yv2Q9qjpB6IbU4nKX7F3Rbz++VhQkea1RbIf9Nm4ic0MUF6XW8Wm3CdgRcNRNyuEZX2qdbc6bbl1DrRJvvmGaLYkT6qkwTowdsELx08IApM9u4GHOxtmVVcWZP2YrbXL19aU2kMq9gNh3Ns8VT8cxFa1lRR6Qk18PgyIn1OrG+LOdzShYjQHUorgkla0YvzZdn316XbDftS2sirYr1IxdoW1aIUx/If1rPv14QcjPufq82iFMSQzYe3iMng9zX1RQcnH0fZdOZe57PJk+9uAgKts/HrChTv10QP1+NlVVrt3FRrEar2cL9o4tGnF7DFs11Ld+Yknw6L6PMmMRPflLw8uybnK8yogaIdEPa1qFRSK3jEZNBtyFYWaCbDnBwEvNlbRZWc1qW50vn1H1mlN7ODtNxXa+B+7bQwkjcHnYBGlv4ssheWLibgkebP9sUvIm06QatURei8YZcFKzejufj1/FkkyW/+hjr67q4XHxZ5i+ku0pWI3qb3HWeE4aRbqjewaK7Y+0OM6DTPuLrQM74qq8ruHPvOFdsj60ttb5S7B+ijtdr2Fby/86XjGa41+tblak/ayPU6Ly0wdaRhiYovwLtXI/y14oLPec1ce3J5FXwto42BxAl80YhNXfMx6uCkh66TdGrmaD6p0urpn2CAmF7ZXyAwgmNuF9A0Dj7BROasXNRVpOtgnqrDdrX43GQHufj8W1nmBa82TwrMueFpQHxYMUH4nIixSsteEBzX5EbyIgrcmcw7sh2IBMNbLbNQnVEVJsz72b/IbwjeHE9Ia78RqEGTW9viuBEg3NMOsQfRZYvxnMV3Joxb8BfZnMd324NaYI2O2m+4uxhm8X0OuXmfGk0ybNptihm4znhbWkD9TBrFEc2XWM86Rs/zrPRZJnLYJt21DGX+exptpAhHmxo4DW6YbWjk+kqFhvH3KV1YbG3Zzaf0d18r1qzwz+quf7flM8jEth6O8M6rq/50bizGLuvpgj12Np9q2p8z2eF+xxHqMfOsMeK1F+Ki3ExfhyvMsaQgxTV21LN16vC/btJJpTewY67PzGXGIOpXl5mRZFNR/QvUZmZcaO+KvA6nhSjfL1YEKQIGzuw5xM7m2o5vGHNC/L0cUTJo2aEPdjxgzlbfR1Vvxp9y/KVwnjQw236wV9ORpPl2v2owQxds+QNdZrNFXHr1rwgZ4un2ULehfdmvEC+5stX55W+kXFnxQviiiKFGBF3VrwgKs5n/mex9dpdoTNjrokqHaVPjvNitvlBNh3NFtPsD4Xmx21q4XesEc/F67OtBb0kpUosPfHctPONaSenBSp+nTpAtVq3J15+d4B+1wL9rg/a8R59Fk5WZXm1d6g2pKgw9ZoGRa6tPGVw7OPwGyG8ZPtzxQzJ1MV9A4C3pN9WWX4wBGDI07QdhHLNCJCQbxe1UWJjF7ElC97+VtI7uHmKd48WZCZue+GQi/i+3hrm25htik1BNkpnvuHb4eB+6HJN1ALWO1gRAJb2DLnPhldDOeXBih/Kh88XCr48WFGkbI7YD+WuwH3u2xU4WmhQk4AXFnSotk7cDWDixNxgSM2WKk+waMFcjULHicdvIzDi8JuVN0WHLL4sBVTb4spQhKvZCBP1arYJqdGRstXsaUG94dEspdaVRuP9HT/3l62N0gN2CB5resOEOVkuvsxnEyFk3Yo6IjG0DAXkBJbR8JQ8iVlTRyaIWRgjVcZyg5ovJ+M5ab7E2OpW1BEJsc8oHDUI2h1rtjnzkPW8uhUfiKsRaR4zIO6taCOO18WyEpIliA0r2ohfZvMic4+DwvgOJrThqKozAscSmZ3g5uPF03rsfmcCo6vZ0MZbvhbS1/dgQhvu23g+K89XNieA8jcEN6cOPcvc83CgmFsDCmDmNSonJsZkQO+cg6IzWmnon2Mzu8fSztXhlBJyw6AuuLkf3Eje/23ho2r0RiC+QI86yMWZv82y75f8HrEvrpgQaz4fF8t8F5rCbOcmWA+zynXvwWXKUVz2CggiuWj4sukfcCusAzqBNz8eF+tch7huzSMyJeTEjksOO6GhVquOXLU3t216xl+NiLc7HfDrNr3hfx/PitniaTSZz/jiGMBv2/SPXwbR6tLvTGrC2yfK1afx6202Xbvni7LZUJsyX8avajy9ypjEpzUvGY9VVH3Y29tTx270h+Vke9Hyduke41IvpLdIGq9X2XT06H6o0MLo1W0Q/NZwgsrJUBuNcTLkgpVn4xVh79jm2htQBiPctUaoqPesnZAIonebiCp5uwBRTtDaROQTNBekb+P52n0Ua0PtysuxjMPUb2zEsqReRBbxVAonYWU8QPwhT9ZiAiSfWdjgQKvSDmr/FEe0Soez+seyKgey2kexCoew/o5fVQ9eFY9cZYet+sesKgesmkerwkNV/eNUlYNU/SNUlcPTjvOM7Z+J0VuNUmoDOv0da4RJ8V60rjRX5G7dzHHF69t2KPd8rhgTMZGrGxJn+9ciY+//HACpG8AWHGsH6NTDiFtApJNx9oA4Gj42VOPhXTEu1uRBtVla8UoF69VEWAQvacMvJl1dz2u9vS1F2Ni1va23EtCiR7kfgZNIrkt0efBwewJ4zBJa30XJdGCnYfxOwOC3weXV4Kcrl88aUtB7dcN6lfjQfuMOdfl0eXd3ef1RuyYHs29UD8JtEko9WNdLyPXAppG753E+vWSsf/cF9UJkllPCWSeK0dvZoLvx4AjTzEZJD2zA29nQwau35/CPbLIutt3A2YvNUno3PnZmR8XsJRu9SHh6mDF3/wG/2O/vjPKsWOeEEB2MF7GljVssi/F8E+q3GmV/jF9mQmLcnB/or9kPTWhozg/0v9fLfP2i7XCDVYUqNAeG1/l4tqBJCY1CiiFb37KcEFvRpujVTFD8VHeB8S44JUQTQdsbUAb7MsvmU8II2gLbG1AGIwWIIlz0eFAnrPmMEEGCYO3KK2O95OP8SdKMewPKYMtXynqhhbUtrgzFCJdF2Lhhsk6Iq2yeTQp3+Qrhq5nQhvs6c471wcCq4nIo40z0KR9wX4eqqKJmRT7kMuP0eAddmGuMmf7ybEK522CBrdvyApstpiNCQIYF9WDJC+hsMZmvp+X1GY1eAMx5Qd4Pbgq8dVteYGmRfBZSRggfAXNVbPKZK2DuDfnCzAulF6tuywss7XKbhZRxrY2AWV5RoqQ9spDWbWnBxk7zqE2ER8od4ywAwxAcBNi9djgF2ITuOuZRshPuDKmgdp0BfBp81gXuVRaVoPe2cfrb4cXDucvxBaUCe6Me62Bctt5wN0ubgmoL1sfl8uvLOHcOOMBJejUzTF+W7vCyqj5QKqyobZgHeXlFU85R2LY1D8gCRehAKlWFbIB8CebAJ5RhbHiylfMBUWHVbMPkKQsHPIGsYMNiSwsHMpm8YIVb5tKOtzXhA46/u6jhCXcWHYAafL7wBDuJA590F2EFXGW0tAkmxpodHcz6gubn2WJKOw46lDjaEgYg8NYutZqbb1g5T6wQiSz2dOMwFyeQTLIq6Yb8Ps4pF74h3KG4EKrex8v7uhfZl9mCNNGDYorXmr6M1/NiNF6M5z/+456AH+PpIcbcPQcd0wFcrhJVaHeW1FFpq2GUkbEWdoQrR/HROM/HP0bzbPFUPMtIcXvq2OXKdjwfVYnNRtSjLhTdbFMDv/Xy/0zuuWUJxWMlSjxBC4Ce5alWa1MwC0HdbAOR9UwUKLa1kk02PPz8GKJl7ekCrRL1CDnNO8rCUyQxU7iU99PNzdVwcC3G6x0MyTAtydSvHz79NLyVo+7teCO9u791i4ruIN3b0SVtDaqM1HqwnObnOwj5EAwYvSk1K0LLD+YVlJitNKGPRp6YEDbe9ET75paUkRv+44pKnk8RRt6sisPF3S9r5xynlPtSNM/WGaSzLe4p3pyLcwlmXtQgPlP8enfjPPl2cPa2tjRgbXPb5+H55eBKC/pgzjP3/fAf91rQW1s+iFtzM03SqxVRnJHd74q3n0+9Kl6vtNZE1wTizXFdF4tlrdTbG5Bixdbu0zlIy/Vg0Ryxfbx0emh55TAzAId0jAQtHqZ/cGv4SOX+Aa5ORNZnuGxWceLhPy7v7u9UgPem1HlbI+t99kdx85rlm8TAF5WcSVeXTEbUxl6Wtmyl6vEVZqPLjIHCm1NNRY/2Dhb10Vs9JFtxd8aNkmp9obpgli/ds/UbYHoNS0RPNr1iU8jd7/2aODlfubBC1tv4U/bymOWr59kro5nRwnpv/Xw+Il2cNuP06rbcvYg7xxQUVn1pVw0Z2tPDrrf/jfMx9c1XtZZ1zye0fSg1h9DNV0N1P+90E0Zvx8rqCX607/UaWVif7kW9Yg4jGE2Wa/c0jBbUmil/sNNsrglcN+cHmhzDZwbmhfGxYLPpiDjfOWA3jPqpAOkzBGZk+jcIOiC7Rq1LubO3JhQvGwrfsjpQT+cl27lJZ4nWCa3VWzuwSVHIndD0eGQ3ZMcurNeTtTv0Khvnk2dlsN7eqoq/O3rK5r6WdgW2Nj3hd/WaO+mAXRrQ26VMitk30brtwNPbG5P5tnKRMfCyyPLFeK6EXDOnC432g2y67TAXWTGezbOpZB1vM3bsMaSTTTSMWN2oOZJ0V4M/mDhWwt6PVPqPj37DW0wZkSTLKdRZygsqM7hoSUVB5y2qzOCCZVUHdr1L32av89mk/MV5no2L7H6cP2XF53E+fskoX//tNKQXPaqL1KPtbrsdphe+41gBbjQPuyrOufwdK0DL7U/BNnT1i3ExfhyvnNddSFG9FeC6cJ7fTRy9rRGWE/fOMAA+Z+MpbyBoMh7seMHcwEkRKxtaeB2dbyBr+E1xvUtn49XMOWLUBtPbWRI5sXSNaYkwflEBrexoYjq0908Kfi5tqLX863i1+r7MOXMSDtWrWRR7t/KX+VJpTjn16EavWVRHd+gdl+KufTl+0ZuYXmeUTEodRL2DObFrN37qdizxe19IUTVXcj79ZeLhfwUMc44JmJyjxIzLS1NCgSV+JsyMyvliGANU07uy74hR4N1DWM20xEhWCh75Q2NmSt43xyiwhI/BmDGpH4IhAtI+SmbFZHyfjAhL+1SZFZbx1TIC7GS8mGSsnUoDdG/GD+RzNvn6upwtilEJ+M1d7zcTozb94C8Xiyp9a/llhOVavAjooSZ9wRezxXrp/hEmG/TBlB/YUoAZFaUCI+cF1vwjj143qpGCp3GjXiqwCSOaued1MDIf7HjBrLIZiCn3ZrxAPhfF6+jwbsudihj0Av7vdZb/0Oq9wJgX4Dwr8lm2Gr1m+SjP/r3OVvLxArfpBZ+a6MPIzMruQQGdLSaZyjK4bskP6nLyNStGy1edV69lzhP0OnfP122B3ZrxCDl6zZd/sPQbBHVvzAuw0gLC78phN7ureBUY8wK8yZb3uJ5/HWn4FhjzBnzYJ8iHhLY9X9j5aFI4Jze08e4MeQH9PltsMspVu9zlYi7vxphFP+jL/GuWjx7HxeR5tAmXlqMjFn2iv+bLSVZaVyKvG9QCb4rpZA1oW0Dx2jzz4T36zmZXWdOcuvkcBBNmV1aGA9pmdTH74pxJZ/d7tZZ5ma1WhNyWjef3DoVJHqlqbDrIXK5Ws8d5NtooY6tiSYlYqLOhdkSY9Xa7mzxnmwv8+cVysqIlpkCKHvFarImGey8Wc4xZAJFjknPS2gFNbUw6gmwV1EwJRgx5MrH0aoZ4znMQt+SQOzMeELM8X+a0O4FGzqYtD7AKvvTlR8qBjRmOelTjjDcfr4pRlRNd7kNgzAPu5p63GHNrxAMeTTYxAjJkEyIibXvfAcrY3rvjlp8n2xxGyWHrpvygun+dwEZJ/DyBMyBNfjISMuQnIqJS72SLTzbc2GEBZMte1Sp1jBRabQhBIi2btw7ptO4ab4c585MNrbShANiVWOvy+vL+cnB1+S+35LxuyD1gVYW/sm9ItnV7e+OSBdkRf2fOO/fn4fWFquMPBr2z3z5cX6uyHwx6Zz+/Hdz9ogpfs+if/ubT56uhWzo8V/yaSe/8Pw8urzTh9/b8kKNKwCVnr7MppHch9Hm8eCrPyhdTgm7Xhum1LTEcWTqkM/osm462C2nCgTaKbLKojL7RHb7nsyIbfRnP5uvcXexHqFFj+sCrUZ6N6VvcBufehg+8jQ+KzPnap4nwYEYZshRxBHS78spYW5H9EH87+rJcLyQNbbaojH54QPnmMgSYAzRmSxlXZYzyOSwVz/ly/fQsJGxakSOiM+Wvy0cy4q/Lx+Pr5DsIoUC+qb+uNn4AE4jiFqzn2eaUjC5K7LkOBnTBJL7y4CeW3n0AYgvdFiSWaLxH4qvFFqRXSau9emg2pnK9Z5JI1jYsvvx7QBPqvhY8pqK6R5NIqRasTYAVH2pbWoxkmviG3ziHxbuCalNgno1X7vmMcI7e3gjPW5UrTJ1r9pKtivGL89e2DYx1Oz4wCV9BMhFSP4JkgzN1O24cyqHonyEOBdCI41BqjjHA/u/yUY65NaIF2GjjMsXboPpUAbGN20UV2/hr5h5TaCLp7c0QXIc4xOY65reS0cJ6aRmIX7Mw0/C+YoG7xpbPTYGU/s33LkxDa5OE2mYxxdx9Ly8bqWpK2q8jMD1oieU+qz43W30lRWOjmHUr+ojUjPM4IivZPAGRnGfeiMlLMe+IuhX9xT2zaUcdczV7WoyLdS7rl3UrGojYmPNlyZmZD+X00ioSMimhEPSvwrV8YLx8ufndiDWZNBGBJRXUdqtyWvT4C2mIwV5B131gyje3XH59GefOH3Jpw9UsKKO5K5ltKKKI6YBTjuSCRtyX18XKyzNgPta+vDKWqMN76epP+XL9KoDalxdjmQaqz/nyNcuLGa89D6X/JIMXANIYxmoe8jCgQWDx0OaAyxrkWqD84a4bkT/wQUzhENiNyh8MIapwWHRAVXqp9F8n0+h0u3T+bgAopncmvHTO2Yoh9KryPF9tqm/MsJPN3e/HomR7E+pwz7On5/ns6Zn3Cu8BG2bUIQlnjRgc9bTRCNXs+5N1PisIA3T1ez2Bcfoyo+iztcf39mUpXtnW1xTGVH2OksdzKKwHtCvDI6qVVkRarifP08fRJg08Ka8DYEPMiCCxfn3z+L/ZhOy8qpSq2EHuUjWG3s4A3T3b+hvn57kMbGdAAazZevm3KoCL+LmbVkFFmbzsrTKQ3sEKxWPQGaYZOivlQ0KDoow1Mx4gv2WLKSF+FUfcG/ECmK/EPa53sOKxoUdf5uMnrebeG9MBbr/OvzFavipzJNUZAHAU51q9Td1tnM9I0zukOhhQBuO8Bw0w9ivQAmt2ptXG7CYzf7YotrmF3CmRwnpr2YNZQhC5EakH7VH8iDmpG3uTcZgyybmg722+Df7zeDGdk5bwrpWoWdarCtK1WeseWFKtUy8JKiMK0VtStcWWFzRinA1w9EhnZ7xNAOe5e54+E+HBjBJko8s9j/Mp58OSrYJqHW5VWpZx9PZGCD5ruQJ32X11MeV1XTDchhZWc93jfDn56uw6M0tvb8jdfbhbDKBlDmgFzp0dT5iUq4oWSvJtRRJkeWlTgXJnRw+z/tY8vDLelkYhxfRkqyxzH2EwiN7Ogruzmg6w5K5x/xQDTrYzIUeLO1rPltqkUeIYuVWaAIK8KibvNHOq1FrNnDPAxFQZEKJ1ZVP5NLi8vh9eD67Ph6NPNxdDHd4eYlZcge0D8Hpc31z9pMS+NeWX9+avSrSlIQ+szWF6kzVu9ZmWt6FZSm2YfpktZi9r568UIhS9gwmK4xo+MMWm5tmXLM/dN/oYXt2INmAZiSKB2xlQAGt0sc1+Zrkosj+cVa9aEc0kpc5CR/v5PaKiUa+0gjiJAJHVSQck0vkQwkQ/HsKhYmvnsa4CDr8/yiKk9njJEgT1ymEBcttoJ8ssg+KUpUVQXUuP2+HgYuiSA60LsLe3JOSsbOK0f7+9vNeh3VvySDu4+HR5rQG7M+SR9Xb4+eryfHDvlA/PoS/UrHmkvvhp9PD5YnA/vNOgbljzST28u/yo0jH2ljzS3v0yuL1Q8e/ekk/a4fnD7eX9P1V4D7a0iRurrvVsSrx6XSuituZarwkf2YAAvV1pgqNq1cYd89ss+/63dbb5tBvNPa2CiikRNuac3YSD9A5W3N3Vdobdac4a7r6A4vp9XBSjbDFZllf7KGdBEKaHWaI7zRgwx/geO4bI+gx7Jxz56+AtNN7HwDvBptlqQpMhWmQNE4pos8Vkvp5mI8q3QVpwwIg23mr2LRtl7hn4cL6aFUXA+exlRh5n92C70opAq68z5/QuLZ5tYUWc6tsNlGvPLaiGCUW0bDEdfc3Y437vUF4fakTLWWdiGzFS13Uilhfr2GS70tpAo3n2zf378DjW3oYinKSHqfeur9kP/ii/LayIk2fTtXuKuBbQvrjm8FmMH+d8pH1xXaS8EI1UdQs+wKSjFWJIfQoSTj9ipNiy47DprvtfH0P0PTxcIPli3jgIvg/N1jHLDxhLVViA1CX33t8+uJwud7D1tmZEgFuDOOfPg6s7DdCdHX+kV4N/uYhNXaBbM8qcUBigyyhHT0cCILi3+Gu1V13ZNzQw/sJeL5sFhNLxFN6RCFeyG4X0rn6N16tsOnLPYtDG6NVtcLxkuVZM+iAAgkb/IIATFi2vK8LFyOnqBEa4X49QUW/XOyHRVoGye+FOQMR1MyDirJk7kb6N52vSehRA7crLseLgLI5ODmS32ep1uagl8ccWh9WJ5eGXnRiWB56P5/PH8eRr9wNrv5Q8cPjy2rpKbXxm88eSx/66Wi5cn9r4reShH7Oida/x8zgfv9gX/yWEtawQ6lOVXOB59soDs5cXwpXHbASY5u+FDz8fv44ns+IHGo5OgHKzI4H9vEYecr5cfJk9rXMSLsGS0LsXj7uoPndPtsuIvLZcFefVZ8Cc3YMUUUIYrO6KPBu/MFBaRSVIv2Tj6cX24y+uLGgZYf8YzOcXj5TOAQpIm+XisbyzRWkOWESCcJHNsyKjNoShlPRV3drjDX+20sJBj+oerIj4Xdl+TJH0rsAy4s5KhEDLSCE2L+ByQhpLYRElBM5YaiqqhLSNfmEQwZK6QAJXmSxIAX9az79SO1KrjAbEx4z0QsEiSgiD1afZH9mUQQJLqgHdZvNN6ggWEiyrBkXvx6aiCvM2cTw2lJLO20QKrIgSArETW0qqARE7sbWsGhStE9uKSpdW1BUFUkS8tMo23y5gLbDwkgovNgvJWlbad1hE5oLSfsPCMRdU9Q5zA9NpQ7x83z2BtOZBSumBMNar5sJSrI1iTiFp/F7j4ZzVBVpOA4bRNFgxRRSue3zsIKoVeFF+KYv3vluLS722N87YLRvLakNx2rPThhpklYGaxQaKKiOJ3GYwoYZIHUPxgqo4In95GV731od/vM7HM/djE1tZNaifZwvSnhsvqIojakLUgBSP0XLaDUZtJ9Xm4baKemN8zIry83HZijcNWwpLfVSapjinWUC+jSQBYEWkHmh8RJbiCbygDg6dQ9sfjPfGw7xdhnvsvtRHihFpFZJKMLfZ63ybXJajw9iKS9H2n5DmgJkLq2H9unxkEdXLyUcaQQN2GxB2cgFbR2mhiCUA6ygtHRZq3ZYSG4GXU4ShNp6f969uePNheQ5Qo5wiDJNFb0KBmZtJE4uxsBir+mwLCQYUEb7sVASsiPhM/nX21+wHLToAFJHGD25/uKsaO3rQyY40MnOZMzcVppJS7y3zFdtjxrLSpchgn9uDshBBSsmXIXQUYzlpXCGZBC8k7DF0DLyQtI9cLSfjOWcFjReU9xQWkK2osL+weIzlhL2GBWMsJ521brNvq4vZly+UaatVRrqAgF9XoKwkjGWV4jkOD2BEdCCFpS/7A+eOh7mgdCSeFLNv2f149ZUU5o2Ukt4yYV598eeVzfWLfDz5muXDb5vUXFT/GMuLF6oSum4D0nXhOt8UEV/YcTEjQW0G0N4277UbyQyllEDsCTAggNNFzO4HE6uuU+dq4+T8aPBz0aP36zeH59Z/K3noLjS6+5G1X0of+DErym6ym8zcHo6UUgBxbWn4c7VHk53QKqaGcllkL0SMbRHZxWLLDUiX28b24t7QthOBkPBgxRvo/Th/yqSceyMizPJKogPJ7nfyhzkP5fDnao92e6uwIiKETaLmRkDq3ew/mcM4by4ow8nRD/5ZMGAB0eMtizYHFntpX2CHf5QhNuyINJj2ZU0H9QUtpIxxPl+viixn0RzKKkN9zpevLvKUuaQIaHcd3oGg9lPZI8tX1nXEhT+XyYP1MHwXTRD8Xu/htLfDUlQP6eZ1Y9JJKsWL6aFsIjPLaCUqTL2gLs7q0/j1tpnflMDUKC0C2+9h68nHzCTg52qP/q2R88jt+b+55jmyQ7i+vEqv7daM83gFf6/x8FLIvax/R6Dz+fUiEoThH9lkXS7winFHltHy+a3fyx5ehtW6+h7+XO3RN69uVW8XkSBs4mldq974reSh5eh5kX2ZLWZuk1O7gPjx99kfxc1rlo+LZX6RfRmv58XPs2w+dYSxFBejZbQNClpGAoHmyurmMBWToNw4ZHm7keZ3w25SORwT4KW0Qbaty+M5FPaEpUHnD9JRaLAVVUHKpts6XmTFeDbPpryO1mFGF1WIqIdWi1M9z7NxkVUCYHnClRVZ7tDALiaUEHd7aBJUrZAyxmBdPLNQtgU94Pw0Xs0mbKZdaQ9gl2MHddRaVgvKef+BF5JhfJut3Lbo9Z8KH1nG2jg9cfdLyQMbYeaui1+8kAqG26YL/lzl0b8uHwlPrn6t9eAyqIL29F0RLQR66zcKiTDqN9ScMdBCcgzyhsxUTAnF8Y1oFdB4vLtsjJSQA9Aerv7gjeCf5cXMZd1sLKcF4yQ/tgvIHl9dCHB57v6XGg90zfTd+r3s4SBdt8vz20XkCL9li+nS4dQM/Fr24PK20Gb1li2K7SrKhQAvpoBCbAekjAgChhk7MCBFJAjMU3Efx+G7DN7gE6xGhtbvRQ9HvlZtfnLjx5LHmr8FbXw4VkSKQHm28kOdJhz4c1k0ynryPH1sDyrIYDheF8+7kBRbKZxnU7p7CLpffs0Wn8aL8RMSw3AAwH9te/D/vH83K89M//J/3n3L8k3pd395F36IPpy9e//uy0Y6X737y+8Vzvt3k+VLuZn9n+3ffssmxTLf/KL6yX+fvHv/+8n7fvjh9PR//uf977sC5b+X/1D+Knj3/vcA+VXQ+FX47v3v4fs0+HB6Fjd+FjZ+Fr17/3v0Po0/xCf9xs+ixs/id+9/jzFrceNnybv3vyfv0/6Hfj9s/Cxp/Cx99/73FKlB2vhV/9373/vvk+RDEjWf2W/87PTd+99PEWOnjV+dvXv/+xlGdtb07cbVAdYGAWiEshXQZmi2Q7DxdxBijw6aTRFsXB5EmMlmYwQbpwcxarLZHsHG70GCmWy2SLBxfYC1SdBslKBv6jBBs1mCU1OXCZotE2xaIOijtWk2Tnhi6hFhs3HCwNTaIXhJysbBek/YbJuwbBvcZLNxwk0LhFgPCpttE25aIMR6UNhsm3DTAmGI/bDZNuGmBUKsA4XNtgk3LRCiHShsNk64aYEQ60Bhs22iTQuEWAeKmm0TbVog7GM/bLZNVI5gWNtEYAiLTN0iajZNVDYN2ohRs22iTQtEJ+gvm40TbZogCtBfNlsnKt+c8H0cfoijpPnLZvNEmzaIsHaMmq0TbdogQtsxajZPvGmECGvHuNk88aYRIqwd42bzxJtGiLB2jJvNE5dTDNaOMZhjNm0QnWE/bLZOvGmCGHvF4mbjxJsWiLFXLG62TbxpgBh7xeJm08TlqIY1Tdxsmnjj/zjGfthsmcQ4qCXNlkk2/o+xJkyaLZNs/B9jTZg0WyYxvjhJs2WScvrH2joB83/ZMlhbJ82WScqWQV/FpNk0yaYBkhNsIkmabZNsWiDBWjtptk2yaYEEa+2k2TapsW3SZtukmxZIsG6RNtsmNS7L0mbbpJsWSLD+kzbbJjUPammzcdJydYZ1oBQsz8xjWtpsnLRsHHQp12yb1DzjpM3GScvGwfpa2myc/qYJEqyv9ZuN0y8bBxtX+s3G6W+aIMXGlX6zcfqbJkhRB/WbrdOPTe3dbzZOf9MEKdYn+83G6ZeLZ6yr9cHyuW+cw/rNxulvWiBF12r9ZuP0N02QJugvm61zummDFOsZp83WOd20QYq192mzdU7L1jnF6nPabJ7TyLjkPm02z+mmEVKsa5w2m+d00wh9rGucNpvndNMIfWwQOm02z2m5vcEa/BTsbzZN0Mca/LTZOKdnptHqtNk2ZyfGwfes2ThngXHwPWu2ztmmCfrYeHXWbJyzctJBN4lnzcY52zRBH+tCZ83GOSsbB+tCZ83GOSsbBxsyzpqNc1Y2DtYvzpqNc3Zq8vkZ2H9umuAU60BncAe6aYJTdGd5AvagJ5s2OMX6UPWn+k83rXCKbi5PwDb0ZNMMp1hTVn+q/3TTEKfo/vIE7ERPNk1xiu4wT8Be9GTTGKdYe1Z/qv900xynWItWf6r/tBQKsDat/lT/aakW4CoAaK1SFjjDdQCoGJS7UrS1oGZQKgNnaGtB0aDUBs7Q1oKyQSkOnKGtBXWDUh44Q1sLKgelQHCGthbUDkqJ4AxtLagelCLBGdpaUD+oBIQTtLmAghCElb6DthcQEYJSKwhO0AYLochTCgknaIsBKSGotIQTtMmAmBCUmkFwgrYZ0BOCUjYITtBGA5JCUCoHwQnaakBVCErxIDhBmw0IC0EpHwQnaLsBaSEoFYQAF9uAuhCUIkKA621AYAiiSppD2w1oDEEpJQQG0Q3Kc2W7BWi7AaUhKPWEAFfegNYQlIpCgItvQG0ISk0hCNB2A3pDUKoKAapuBUBxCEphIQjQdgOiQ1BKCwEqcQVAdghKdSFAVa4AKA9BKTAEqNAVAPEhiCtVFW03oD8EcbUcRNsthspq2W6o4BUAFSIoxYYA1bwCIEQEpd4QoLJXALSIoJQcAlT5CoAcEZSqQxCi7QYUiaAUHoIIbTcgSgSl9hBEaLsBXSIo5YcgQtsNSBNBqUAEqLYVAHUiSCo9HG03IFAEpQ4RoAJXkEBNvGw3VOMKgEwRlGJEgMpcARAqglKOCFClKwBSRVAqEgEqdgVArQhKUSJA9a4ACBZBqUsEqOQVAM0iKKWJAFW9AiBbBKU6EaDCVwCUi6AUKAJU+wqAeBGk1VEG2m5AvghKlSJAha0ghccZZbuhklUANIyglCoCVLUKgIwRlGJFEKPtBoSMoNQrggRtN6BlBKVkEaDiVQDkjKBULQJUvwqAohGUwkWAKlMBEDWCUroIUM0pALJGUKoXASomBUDZCPrVIRTabkDcCEoNI0Dln6APT6LKdkMVoAAoHEGpYwSoCBQAjSMolYwA1YECoHIEpZgRpGi7AaEjKPWMANV4AqB1BKWiEaAyTwDUjqCSO1K03YDeEZSyRpCi7QYkj6BUNgJUwwmA6hGcVueHaLsB4SMo9Y0gRdsNaB9BKXEEqEITAPkjOK0OEtF2AwpIUOocAarTBEADCUqlI0ClmgCoIEEpdgSoWhMAISQo5Y4A1UwCIIUEpeIR9NF2A2pIUIoeQT9Fz16BIhKUwkeAiicBEEWCUvsIUP0kALpIUMofASqhBEAaCUoFJEDFkQCoI2EpgQSoPBICeSQsNRBcagqBPhKeVCfBqGgYAoUkLGWQ4BQ9Bg+BRhKWQkhwGr9Pzj6cnsIfgzPhUgoJUEUlBDJJWGohwWn6Pgo+nLQOxMHRcKmGBKfoMXsIpJKw1EPw4BEglYQnVduhsmwIxJKwiq44NZzMwzP88rU7QwXsEAgmYRVlYfAFkEzCKtDiDNXvQyCahFWwhckyaL4q3uIM70VAOAmrmIszvBcB6SQM+jYM0H6lQhKc4Qf8QD4JK/nEZBm0YKWfnOHvFIzCqASUsxT/MYzEsLUgjMbYhmPgvRkGZFQaytnp++T0QxgAP8OgjEpEOTtDGwUGZlQqCj7ShjA4o5RK8LOTEMZnVDKKyRmgAasYDVT/CoGOElY6isEXQEgJq1CNkwAduYCSElbhGich6jggpYSlXBKe4F0faClhFbZxEuM/Bu1XCibhCd5BgZoSlopJeJK+j+IPaZqCH4P2KyWT8ATvc0BPCUvNJDw5fZ+cfDg7AY0CBJUwqhrw7H0SfYjDAPwYtGCpmoQBPiwCSSUsZZMwCN7HyQcAARSVsFRNwiB8H8cfzmL4Y9B+pWwSBtH7OPrQP4vAj2FAVNl+QbzxRdD6MWi/SlQxdFCgqoSlchIGCdozgKwSVrKK4c0GukpYaidhkL6Pzz4kIegZQFgJS/EEj+wJgbASJlXz4b0IKCthqZ4YhgygrIRJ1X74RAyklbCSVgwDF9BWwqRqv7P3SfAh7YOeAcSVsBJXDCMXUFfCpIpsQ0cuoK6Elbpi6BhAXgmTU8vIBfSVMDmzjFxAYAlLEcU0cgGFJUwDy8gFJJawCg0J8VUJ0FjCNLKMXEBkCasQEcPIBVSWME0sIxeQWcI0tYxcQGcJSy3FNHIBoSWsAkbQkQvoLGGppZhGLiC0hP0Ty8gFlJawH1hGLiC1hJXUYuigQGsJ+5Fl5AJiS1iJLYaRC6gtYT+xjFxAbglLScUwcgG5Jez3LSMX0FvCKqQEH7mA3hL2zywjFxBcwkpwMYxcQHEJTwPLyAUkl/DUtgAFmktY6iohHpQLNJfw1Lb+BKJLeJpYRi6guoSnqWXkArJLeNq3jFxAdwlPTy0jFxBewlJcCcMIjycGDXh2Yhm5gPQSVtKLoU2A9hKeVQMovusB4kt4FllebaC+hKXCEoYJOswB+SUsFRbDOwXUl/CsmgBTZJQD4ktYCixh2McZQPOd2fYPQH4Jz6rmw98/oL9EpcYShugrFQEBJjqxNF8EFJioFFlCQ9A1UGCiE8v8FwEFJjqxbOEjoMBEpcoSGiK6gQQTnVg2EBGQYKITyxY+AhJMVEkwEaokRECEiU7ObBigBUudJYyi90n6oX8KfgxEmKjUWcIIHQciIMJENhEmAiJMVOosYYRu1CIgwkRBbKkgEGGioGpB5KWKgAQTlSpLGPWxxU4EJJgoqK5XnL5Pwg9JEIAfg/YLqvY7wyBA69kEmAgIMFGpsYQx/pYAASYKA4vbgAATlRpLGKMzTwQEmKjUWMI4RDsREGCi6kpMHL2P0w/9CDgOCDBRaNlARECAiaqrMehRYwT0l6i6HWNCBs23vSGTYHN2BASYqBJgYnRNEsF7MtVFmbiP/hjelakUmBhdOkTwvkylwBjc3LozUzUg1j/hrZlKf0nwLgcvzmz1F7zLwbszlf6CLfIjeHmmUl/wRX4E789U6gu+yI/gHZpKfcFXAhFQX6Kt+oKuriOgvkSV+pIE75P4QxzCC0eg9ar7NPj1ICC/RJX8gi0bIiC+RJX4koQ4A2i8Ul8xrHMiIL5ElfiSRLgrQPPFfcuyAYgvUSW+4EudCIgvUWwbPYH6ElXqS4LfmALqS5TYRk8gv0Rb+QXrykB8iZLI0pWB+BJtxRe8KwPxJUoSS1cG4ktUiS+GrgzUl6gUWExdGagvUSmwGLoyEF+iSnxBuzKQXqJKejF0ZSC9RJX0YujKQHqJKunF0JWB9BJV0ouhKwPpJaqkF0NXBtJLlNqmPiC9RJX0kuDrJyC9RJX0YujKQHqJKuklSdGFABBfotT2+gHxJarElwSVECIgvkR92+sHxJeoH1qYgfgSVYEuBmYgvkTVDZ4E3R1FQHyJ+rbZD4gvUb9qQVTWiYD6EvVtmwegvkSlwhKm+IwN5Jeob9s8APklOq2u+QbobVsgv0Rb+QUf6ID8Ep2aB1AgvkSV+GJYiAP1JSoFljAN0TcQqC/Rqe0NBOpLVKkvKSp7REB9iU5tbyBQX6JKfTF5GbTfqUX+jID6ElXqC+ploL1EZ4HFy0B7iSrtxeBloL1EZ7b3D2gvUaW9pIZLzqD9zmzvHxBfokp8MXgZyC/RmW39CeSX6MwoXkdAfIkq8cXkZXiJ+8Ts5RiIL7FNfImB+BJX4kuKziYxEF9im/gSA/ElPonNXo6B+BJX4gvu5RiIL/GJcfcQA+klPrFs3WMgvcSV9GLyMrjmfWKZ/2IgvcSV9JKiARExkF7iwDL/xUB6iYPQpHnEQHiJK+ElRZckMRBe4sCydY+B8BJvhRdkTxkD4SUOLLFLMRBe4kp4QQMGY6C7xJXuYgIGjRecmTbBMdBd4kp3SdHQpRjoLrFNd4mB7hKH5qYDqktcqS64XBUD1SWuVBfDuwRUl3ibjAR7l4DmEleaC74jiYHoEleiS/8EEzBiILrElehieEuB6BJXoks/wOScGIgucSW69EMUA4gucSW6oN0YSC5xZJn2YiC5xJXk0o9wCNB6kUWzjoHoEleiSx+dI2MgusS2oJcYyC5xJbugnROILnEluhg6JxBd4siyaIlh7pLYuGiJYfaSbcAL3jlhBpMq5MXQOWEWk9iy6IxbmUxiS+eE2Uwq1cXQOWFGk0p1QTsnzGlSaS6GzgnzmlSai6FzwtwmNs0lBppLXGkueBhuDDSX2Ka5xEBziRPzyAk0lzixjZxAc4kT28gJNJc4MY+cQHGJE9vICRSXOLGNnEBxiRPbyAkklzixjZxAdIlT28gJRJc4NY+cQHKJU9vICSSXOLWNnEByiVPbyAkkl7iKdunjKzIgucSpbeQEkkucmkdOILjEqW3kBIJLbIt2iYHgEvfNIyeQW+K+beQEckvct42cQG6J+7aRE8gtcd82cgK5Je7bRk4gt8R988gJxJa4bxs5gdgS920jJxBb4r5t5ARiS1yJLX1ULouB2BKf2kZOILbEp+aRE4gtcSW24MeCMRBb4kpswc/YYiC2xFWoi2EjAsSWuBJbDOt6ILbEldjSP8WUtRiILfGp8aQ2BlJLfGprPSC1xJXUgt6AiYHWEldai8FvQGuJK60FP5uMgdYSV3Eu+NlkDLSWuNJa8LPJGGgtcaW14GeTMdBa4jNb8wGtJa60FnRbBpSWuFJaTlGlMwZaS3xmUTpjoLUkldZyGryP+x9CQJwArSU5CcwjeAK0luTEEiaRAK0lqbQW/F5SArSW5MQSJpEArSWptBZTBUG6tkprwd/VBKgtSaW24I2dALUlOTG+fgnQWhKb1pIArSWptBY0400CpJakkloMwEBqSSqpBeudCZBakkpqOUX3ZQmQWhJbjEsCpJYksDUeEFsSW5RLAsSWJLAInQlQW5LAKHQmQGtJKq0FX18kQG1JKrUFX18kQG1JQotQnQC1JanUFnx9kQC9Jan0Fnx9kQC9Jan0FrQjA7UlqdQWfH2RAL0lqfQWfH2RAL0lCS3HRAnQW5JKbznFEzYDvSUJLYNnAvSWJLINnkBvSSq95TTFZusEKC7JVnHBByKguCTbIBf8vQaKS1KFueCLhgQoLklklDoToLckkUXqTIDeklR6C5r7KgGCSxJZpM4ECC5JZJQ6EyC3JJXcgl/pTIDgksSWZWcCBJekElwM3QIILklsOSVKgOCSVIILfrM0AYJLEltOiRIguCSx8ZQhAYJLEtuGTiC4JLElRikBgksSW2KUEphQNrHEKCUwqWxiiVFKYGLZxByjlMDcsokxRimB2WUTS4xS0sowa4lRSmCW2cQSo5TARLOJJUYpgblmE0uMUgLzzVaKy9kJOukAxSWpUrgY+j1QXJJKcUHzzyVAckkqycVAASSXpJJc8E1GAiSXpIpywbcCCZBckkpywe9IJ0BySWySSwIkl6SSXPAgkASILkklupi8ARrQFuWSANElqUQXNHtfAlSXpFJdDBRAdUn6lo1fAlSXpFJdDG0CVJekUl3wC+MJUF0SW5BLAlSXpFJdDEM+0F2S7RUj/A0EukvSN689geqS9C2aWQJUl+TUckMsAapLcmq5IZYA1SXZhrjgAzPQXZJKdzEMzEB3SUppxTAwA9klqWQXdGAGoktSiS6GgRmILkkluhgGZiC6JJXocoZeEEuA7JJUES5n+HsNZJekkl3OUA0jAbpLUukuhvkB6C7J9n4R3juB7pJUusvm0heSXR3oLkmlu5ydoTsYoLskle5imHmA7pKU0kp0gqdPB7pLclZljA7Q1wQoL4ntilEClJekFFciNJVmAoSXtNRWDBQpEF7SUluJTiLMcykQXtJSW9l8Hwj9Mci/Xmor0UmC/xjkYC+1legEPUZIgfCSnljGzxQIL+mJZfxMgfCSnljGzxQIL+mJcfxMgfCSnljGzxQIL2lgGT9ToLykgWX8TIHykgaW8TMF2ksaWMbPFGgvaWAeP1MgvaSBcfxMgfCSBpbxMwXCSxpYxs8UCC9pYBk/UyC9pIFl/EyB9JKGlvEzBdJLGlrGzxRIL2loGT9TIL2koWX8TIH0koaW8TMF4ksaWsbPFIgvaWgZP1MgvqShZfxMgfiS2lK8pEB8ScNq/ES/igC0lzSyjZ9Ae0kj2/gJtJc0so2fQHtJI9v4CbSXNKrGT1RySIH2ktquGKVAfUkj2/gJ1Jc0so2fQH5JI0uYfArklzSybCBSIMCk1cd6Tgzf9AAtaBNgUiDApDYBJgUCTLpN8oJ7Awgw6faeEe4NIMCksSXMOgUCTBpXXyNBj3hSIMGksSXMOgUSTFqqLFEQoCMBkGBSW8xLCiSYtFRZIvwTFCmQYFJbzEsKJJi0kmAMzECDSbc3jbApHmgwqS3mJQUaTLqNecGneKDBpNuoF3yKBxpMWmkwhikeaDBppcEYpnigwaSJOUlPCj/7UwW9oFM8/PBPJcAYpnj48Z9tihd8iocfAKoUGMPcCj8CtL1nhL+r8DtAqW0GbH0LyCJfp/BzQKXIEgXolYgUfhKoUmAM/R5+FagUWUz9HigwqTnsJQUCTNq33FFJgQCTVgKMod8DASbtWzJMpECASSsBxtDvgQCTVgKMod8DASa1pHhJgf6SVvoL2u+B+pJW6ouh3wP9Ja30F0O/B/pLWukvhn4P9Je00l8M/R7oL2mlvxj6PdBf0lPL8UMK9Je00l/wT3KmQIBJT23rFyDBpKeppd8DCSatJBjD9A4kmPS0mv3wRgESTHpavX4ppiamQIJJz6rZr4/2fCDBpKXKEm2y/yArbCDBpGfV7HeG/xi0YKmyRCG+dgcSTHpW7QAD/MegBbcpXvDvuAEJJj2z3LNNgQSTVhLMJpUOZhm04Jn5nm0KFJi0UmDC+H18+iEKYJvAL6uVDbh5X9svdx9IMH3bPaM+kGD6lQSDfjOhDxSYfqXAmCjAd9aq0BfsfLMP9Jf+SdV6aFhdH+gvfVuGlz7QX/onffPL2gf6S7/SX/CXtQ8UmP7Jmfll7QMFph+cmF/WPlBg+kFgfln7QIHpB6H5Ze0DBaZfiiyGl7UPFJj+VoFBX9Y+kGD6QWJ+WftAhOkHqfll7QMRph9Y1p99IML0g1Pzy9oHIkw/MK8/+0CD6Ycn5pe1DzSYfimzmF4ToMH0bVl2+0CD6YfVC4h+YhFIMP0wtlGA9qskGPRlBQJMvxJg8O9b9oEA0w8tu78+EGD6oWX31wcCTL+KfjG8rECB6VfRL/jGuQ8UmH5kTNHaB/pLP7KkaO0D/aUfWVK09oH+0o8sKVr7QH/5/zp71+U2ciR/+17680QscQb2Dt5r2NhQ0BItcyyLGpJyd8/G3vsbhUMW8sdM2Pv/NJ4GKlUsAInEkwckt6gwmIC/pMZfZFs1AX9JiyuSE+CX1PCLZKsmgC+pxb7ItmoC+JJa9ItsqyaAL6nBFxnDJoAvqcEXGcMmgC+pwRcZwyaAL6nDF9FkTgBfUi/yIs9OgC+pRb/IGDYBfEl+UaIuAXxJDb7IZDUBfEmtwq7MNBPAlxQWARQJ4EuqfMWJlyIlYC+psRflLYC9pOB0spqAvqTgdbKagL6kClgUspqAvqQKWJxczi4BfUlhpT+BvqSw0p9AX1JY6U/ALymu9CcAmBR1/Qn4JcWV/gT8kuJKfwJ+SXGlPwG/pLjSn4BfUlzpT8AvKS70J9CXFHX9CewlxZX+xFuZ00p/4s3MaaU/8XbmtNKfeENzWulPvKQ5rfQnXtScVvoTL2tOK/35cGHzSn/inc1ppT/x2ua00p8AYFJe6U8AMCk3/SleXA38JeWV/gT+kvJKfwJ/SXmlP4G/pLzSn8BfUuMvTiSaCfhLWhV5ScBfUl7pT+AvKS+uCEjAX9KKvyTgL6ks8v4S8JfU+Ivz4nQG/pJaCIxcSTwBf0lF98AnwC+pqB74BPAltfgX5SQF8CW1vCPZjZwAvqQGX5TJDPQlNfrixMi9BPQlHxbrLwN9yS0ARrzMMAN8yR2+iB8jA33Jjb5sSSOPr5yBvuQW/+LEYMMM/CU3/iJ/uQz8JR+ivrIz8Jfc+IusMzLwl3zIuhrIwF9y4y9OPIZm4C/ZLEpcZ+AvufMXUQ1k4C+5RcDIaiADf8mdv4hqIAN/yWZRZzADf8mNv8hqIAN/yS0IRlYDGfhLNroFkwG/ZKNaMBngSzYL+pmBvuQeASOqgQz0JTf6okxmoC/ZWl0NZKAv2S4cEBnwS274RbwjNAN9yTYsPgbwl9z4i6IGgL/kFgCjqAHgL9kuFGgG/pJ7AIysBoC/5B4BI6sB4C+5R8DIagAITG4RMF48TWUgMNktymRlIDC5RcAoagAITO4RMLIaAAKTXVyoASAwuUfAyGoAEEyunEVTAwBhcr/kSFYDAGFyi4CR1QAwmNwYjKgGgMBkv9oAgcDkTmBkNQAEJnu/mMxAYLIPCzUABCb7hf89A4HJFbI48UrfDAAmNwCjfQwYvQZgFDUAACa36BdFDQCAyWGlQIHA5LCIQMtAYPKKwGQgMLkTGFkNAIHJjcB48VCQgcDksPAgZSAwuRMYeWUDgcmdwMgrGwhMDov82wwEJsfDYmUDgcn9liN5ZQODyVFPIcuAYHJUU8gyAJgc/WIyA4DJPQNJXtkAYHKMi/kJACY3AKOsbCAwuWIW58WLQTMwmLzKQMrAYHLFLE68VTsDgsnJLL4cIJic7EINAILJyS3UACCYnFYKFBBMTmGhBgDB5BYAo6gBQDA5pYUaAASTG4LxYtR/BgSTV2V2MyCY3GJgFDUACCbnhQc3A4PJeRHClIHB5MZgFDUADCa32i+KGgAGk7N+SU4GBJOzeklOBgCTc1pMZgAwuecgyWoAAEzOC4KWAcDkBmAUNQAAJrcAGEUNAIDJZeG/zQBgcguA8VLUeAb+kstKgQKAyS3+RVEDgGByQzCKGgAEk1cpSBkQTO4IRlYDgGByT0GS1QAgmNJzkEQ1UADBlIZgvBi8XoDBlFZoV1YDBRhM6YV2RTVQgMGUxmBkNVCAwZTDIoK3AIMpjcHIaqAAgyktB0lWAwUYTDnoEUwFEEw5qDcFFAAwxSziJwoAmNJSkGQ1UADAFLNA2AUATGkARlYDBQBMaQEwshooAGCKWQTQFwAwpQXAeKkQVQH+UsxCgRYAMKXFv8hqoACCKQ3ByGqgAIIpdpHDUgDBlI5gRDVQAMGUhmBkNVAAwRS7yGEpgGBKQzDyNTkFGEyxixjQAgym2MURsACDKY3BBBFRFGAwxS5CsAswmGIXMWgFGExZVYApwGBKYzCbg/HRpVaAwZQWBSPfX1aAwZSWhRScqI2AwZRVzd0CDKZUzOKCdPVUAQRTGoLR3gIGsAXBBPFq0AIIpjQEE8TaOQUQTKmUxQXRJ1oAwZSGYOR7LwowmLJKQipAYcoqCakAhSl+NYBAYUqjMMoMBQpTVklIBShMaUlIQdShAGFKgzDaK8MANgqjjDZQmNIojDLaQGFKozDKaAOFKY3CyDeGFKAwpVGYraS/oMqBwpRGYbTXgAEMqxUIFKY0ChMl2FUAwpQWBqO9Mgxg5SwuijelFoAwpUGYKN6QWADClJaEFOXRBghTGoSJ8mgDhCmxDWCSO8MANggTxVJXBShMqajFRfGamgIcpjQOkw5yZxjAilpcMnJnGMHGYZJ4120BDlMah0nyCAKHKY3DJHkEgcOUloeU5BEEDlMah0nyCAKIKQ3EJHkEAcSUBmLkYmUFQExpICbJIwggpjQQk+URBBBTGojJ8ggCiCkNxGR5BAHElAZisjyCAGJKAzFZHkEAMaXFwmR5BAHElMpanFybrgCIKQ3EZHkEAcSUFgyT5REEEFMaiMnyCAKIKS0YpsgjCCCmNBBT5BEEElNaMEyRRxBYTGkspsgjCCymtGCYIo8gsJjSWEyRRxBYTGkspsgjCCymNBZT5BEEFlNaMEyRRxBYTGksRr7DvQCMKZW3+IM8ggBjSuUt/iCPIMCYUnmLl28MLwBjSuUt/iC6OQrAmFJWRwmAMaUswkELwBhzaDRGNut6K+veeKiY/tJbWXerc5Peyrq3qAoxBaa3su7NJBWTYHor6964qBjV11tZ9xbeJCbC9FbWvZ3uxVSY3sq6Zz1Qtbey7i3IQkyH6a1zd6P7eHsj671wU/RW1r25mcR0lN7Kurs607386gYH1bT1KRZO7a2se1uhop+gt7LubY2K+Wm9lXVvq1Q8qPVW1j3X7sqENDioq8upe+vcvbIZb6Q4lN7Iei9Sl3or665WXu5trHMdUiNykN7Kui+qL/dW1n1Rf7m3su5xpcEsDmljOJoGszikduEH7q2se1lpMItD2qJpNA3mcEwby9E0mMMxbRE1mgZzOKqN52gazOGoukVafW9l3cNKgzkcVaen1vdG1nuBVnsr655Xa8PhoFZ8o2owh4NaAY6qwTwOakU4qgbzOKgV4qgazOOgerfSYB4H1fuVBvM4qCvO01tZ96p9jUQVeiPrnVaj5HFQW9FfWYN5HNIKdLxcTKO3zt3DIuq0t7LuZqXBAg5przujaLCAQxoWwYu9lXWvQyrXT+itrHurvi24gnob67yoft9bWfdFBfXeyrrX7dQoCyngmLYoHOXNcURXlYB7K+teF6lRFmnEEa2cxxtlkUYc0bgc0YgjGtuIKms64ojGxYhGHNG4uIyit7Lui+soeivrrl5I0dtY56V5FHFEUzOPJIzcG1nvxbUUvZV1X5hHCYezYh9vReDbW1l3r49PwsFsGVLaiks4nC1HSk7L662se9IS/nob67yost5bWfd2NZp470Rvnbu3MB355oneyrrX8ZTvnuitrHu7qkK8faK3su5On7cZx3N1K3ZvZd3bRVviHRS9lXVfOCx7K+teTzBWMdUzjmm/sEmcixlHtOIgb0Xg0Vvn7q16sKZaCo5oWa7QgiPaKgjL1La3su6LES04omXhOumtrHs9k1qpSHlvZL0X1zf1VtZdvcCpt7HOdQe1yt5fcECLXkejN069zUGt5NbbWOe6gVp5LzcIjszqHqfeyro3jStlavVG1tsv38Vj9zac8mZukBuZSoa8FdNSeyvrvo1ZlM8WBrGRObQBFVFnb2Xd6wp18k5kEBuZSoa8nNDeW1n3OqZOrMTYW1n3ahTJ6Z69lXV3qioySI2MWa1Qg9TINGrk5HVhkBoZsziMGoRGxqiV3nob67woVdtbWfc2oMrURWRkOjJSpi4yI2MX5aZ6K+veBlQ2ig1SI7NKuuqtrHtdpU57dxzSVdRPb2XdV9uoQWpkKhfyTja5DVIjs4r96a2sextVZVUjNTKVC3kvujB6K+tel6l8y2RvZd3rqHplVSM1Mm45qkiNTOVC3ot7o0FoZCoW0l8dB7VyIe9FT1dvZd3roHrR19VbWfeqe73o7eqtrHsdVC/6u3rr3L1RIy/bLwapkWnUyCtTBqmRadQoyOTQIDUyjRoF5bsjNTKNGgVlyiA1MktqZJAamUaNgrJvIDYyqzLFvZV1z6sphuDI+OVSRXBkwnKpIjgywazWHoIjE5ZWEoIjE9qoSmF1vZH19qsPg9zIhLBae0iOTIirtYfkyIS0WntIjkwjR9raQ3JkQlmtPWRHJh5Waw/ZkWnsSFt7yI5MY0fa2kN2ZGIbVMUiQHZkVjd491bWvY5qULZ4pEcmtqWq7NlIj0zlQz5IRfB6I+tdB1WME+yNrPeKHhmkR6bRIzlIr7ey7ougzN7KulvdlkV8ZBo+irLbxiA+Mg0fKcdqgwDJLAGSQYBk9Ju9exvrvOK7BgGSqYjIR0XbIUAyqyyv3jp37wBJ/OaIj0wFROo3R3xkGj7SvjniI7PARwbxken3fMs8wCA+Mnm5mSI+MhUQ+SjbX0iPTF7hXYP0yGTdBWOQHplGj6JyBkN6ZMrKBWOQHplGj+TRR3ZkKh1SRx/Zken3T4kXy/VW1n25QJEembJcoIiPTIs6ior+R3xkGj6SpyLiI7O6h6q3su5tRJXNAvmRPaxG1CJBsgd9RC3yI3tYjahFfmQbP5IjfHsr696WqHilfG9l3cNiAlgESPagq1yL+MgeVirXIj+yjR9F+RxrkR/Zw0rlWuRH1ugq1yI9si03TJnnFumRNStb1yI9si3qKIpFhXor674KUbHIj6zRXWoW6ZE1K8BrER9ZsxxRBEi2xRwlMSrIIj+y7boq9V1wQFu5HlGhW6RHtvIhn2R6aJEeWbvI1uytrLuOAy2yI9svrZI1tEV2ZO1K5VpkR9aunGoW2ZG1ulPNIjmyjRwpfiyL5MjalZVrkRzZRo6SGIBhERzZVj5Z+4oIjmxLHpOvUO2trHsd0O1IJ6loBEe2hRt5Mdelt7LurQy2mBLZW1n3uosmmTFYJEfWrRiDRXJkne5Vs8iNbL9NXD7/WeRGttVU1vYi5EbWr7xqFrmR9Uuti9zINm6URMJgERtZv9xGERvZVlxZm1+IjWwrr6zNL8RGtmEjbX4hNrI92kiZX4iNrF/qXcRGNiz0LkIj26BRki1Ai9DIhqXeRWhkGzRKomvNIjSyqySz3sq6V7yQZF5gERrZVbmf3sq6L3dShEa2QaOk2EYIjWxY2kYIjWxc2EaIjGxcOWIsIiPbkFFSjB1ERnYZbmQRGdkWbpRlNGIRGdm4OpBaREa2IaOsWA2IjGxcjikyI9uYUZYRg0VoZJfQyCI0sg0aZWXXQGhkKxbyWfb1WoRGNi11L2Ij27BRlgoT9UbW2y/fBQe1ciGf5aOdRWpkUxtU5TyF3MhWMuSzsvKQG9m0OpZa5Ea2kiGfldWB3MhWNuSLbFAjOLINHBUj98YhrWTIF9n+QmxkKxryRZleCI5sRUNevmi+t7LudUiLsm0gOLKtUtBBMUuQHNkWdySnhvVW1r2u0yKV0+mNrHcdUTk7rLfO3UsbUWUCIDqyFQ+Fg6LvEB7ZiofCQVFgCI9sS1ZTgn0twiNb8VAQb/fujax3qL2VGYPsyFY6FA6yz8YiO7KVDwUlsN0iPbKVDwUlsN0iPbKVDwXxHt7eOPV2FQ+Fg+g6cMiO3KENqeg6cAiPXMVDCiNxyI5cpUNBvkO1t7LudUCNTKYcsiNX6VCQbzvtrax7HVEj4l2H8MhVPBSMWBent7LudUCVeGyH8MhVPBSMaDk6ZEeupazJlR16K+teR9SIs8UhPHIVDwUlYtohPHIt9Ei+JKO3su5+scE4hEfOtCEtYkqRQ3zkTFysOof4yFVAFKy4fTmkR64ComDF7cshPXKVDwUrKiOH8MhVQBSsrIwc4iPX7jvXPjriI1cBUbDiUdMhPXKVEAUrGkcO8ZGrgCjI4YQO6ZGrfChYeSoiPHI2LiL4HMIjZ9twynoO6ZGzbThlPYfwyLVkNW3JITxylQ8F8Tqf3sh61wXq5JmF7MhVOhTEqy56I+tdR9PJWg7JkatsKDh5piA4chUNBSXCziE4cg0cKXa0Q3DkKhrSpeN4urxSFYiOXAs5Ul8GB7SFHClGvUN05FrIkWLUO0RHzrch1aTjmPo2pknei5AdOd8GVdHoyI6cb6OqqGhkR86vCK9DduT8orJ3b2XdW+KEeKNRb2Xdq9ZVYogcsiNX+VCQ66j3Vtbd6LGtDuGRa/BIjG11iI5cpUNh43vSkCI7cpUOBS8WteitrHvFgfLFQr2VdW+VTpXtBdmRq3QoKOFMDtmRq3QoeGVdIztyoQ1pFMmnQ3bkYhtSmU06pEeu8iH1uyM9cnFRcqq3su5OLyjXW1n3NqrKQkV65FrdIvVlcFRjXClIpEeu1S5S3x1HtVcvEst/9FbWfVG/qLfO3VsFI7lKTW9l3Y1ebKW3su6LCiq9lXVvecJyLo9DfORaJSO5jFdvZd2DXsirt7LuUS/l1VtZ96TX5+qtrHvWa3/1Vta96AW9euvcvVU1kqt09VbW3egVwHor6271Sl29lXV3eq2u3sq6e71aV29l3YNegqu3su5RL8LVW1n3pJfh6q2se9Zra/VW1r3o1bV669y9VTqSy3z1Vtbd6OW4eivrbvWCXL2VdXd6Sa7eyrp7vShXb2Xdg16Wq7ey7lEvzNVbWfekV9vqrax71utt9VbWvegVt3rr1N234kdyza3eyrobvepWb2XdrV53q7ey7k6vvNVbWXevl9Pqrax70Gtk9VbWvdXJkb+7R5DkD61OjvzdPYIk30CSl61xjyDJN5AkV//trXP3TpLkTd4jSfKNJCkGikeU5Ps1YWIN7t7KurvVuyNK8sYv7BmPKMm3y8LUn4qj2vLYFHvGI0ryrWC1Ys94ZEm+laxW7BmPMMm3otWKPeORJvlWtlqxZzzSJN+CkRR7xiNN8q10tWLPeMRJvhWvVuwZjzzJt/LVij3jESj5domYYs94JEq+FUBS7BmPRMm3AkiKPeMRKflWAEmxZzwyJd+YkmLPeGRKvhVAUuwZj1DJtwJIij3jkSr5VgBJsWc8YiXfCiAp9oxHruTbtWKKPeMRLPlWAEmxZzyCJd8KICn2jEew5FsFJMWe8QiWfKuApNgzHsGSb9WtFXvGI1jyrb61Ys94BEvem4U94xEs+XbTmGLPeARLvlW5VuwZj2DJtzrXij3jESz5dt+YYs94BEu+1bpW7BmPYMm3EkiKPeMRLPlW8FqzZxAs+VbyWrNnECz5VvRas2cQLPkGljR7BsmSb0WQNHsG2ZIPi5qfvZV1X1T97K2s+6LuZ29l3ePKnkG25Btbkq8R6K2su55V4ZEs+RaVpFAxj2TJt1Q2kSt55Eq+JbJp+xJyJV/JUQgi0/eIlXzLY9PWHWIl37BSEF0AHqmSr9woyJmPHqGSb1ApiM4ij0zJxzaaorPII1LyFRqFIDqLPBIlH5vlK3p/PAIlX5FRkBPkPPIk31LYgrKCkCf5lsK2gTmhrIVHnuQrMQpRdBZ5xEm+AqMQlRWBOMlXYBTE6vS9kfWuwxmdGHHhkSb5pGfIeGRJvtKioCQxeWRJvtIizcnhkSX5SouCktvjkSX5FoukVB7xyJJ81mtaeSRJPrfxlL05HkmS7zWQlNmCJMnnsBoiJEk+txGVw0Y9kiRfWVGI8ipCkORzXgRFeARJvqKioCSaeARJvqKioJnTCJJ8i0VScio8giTfYpFU6TioFRWFJAeXeARJviWyySsDMZJvoUhKRL1HjORbKFJSFhJiJF8WVXM8UiTfIpG0ZYcUybdIJCWg2iNFCi0USY6QDgiRQgtFSrIvJyBECoc2onJB2YAQKbRgJGUhBYRIoQUjKYHDASFSaMFISiRwQIgUWjCSEtobECKFFo2kxOoGhEihQaQsWgABGVJoDCnL8ysgQwqVEgU5mDYgQgoNIWV5BiBBCq0OkpIkH5AghUaQstYdh7QRJEUFBCRIoQUjKaG3AQlSaARJqZ4ckCCFFowkVz4ICJBCC0ZS4qgCAqTQopGKMhsRIIUWjiRH6gbkR6ESoiBH6gbER6EFIymRugHxUWjRSEU0RwPSo9CikZSDVEB6FFo4UpEnI8KjUPFQUI5dAeFRaOFICoULCI9Ci0cqokUakB2FSofiQbQZA6KjUOFQVM5oAdFRcCuneEB0FCocinLcbUByFCobikrcbUByFCobigdFGSE5CpUNRSUCMCA5Cq7lD8vn9IDkKDRyJF+O2FtZ91xfRp5eCI6Ca0OqKC8ER6Els8n3z/VW1t1U6YryQnAUWkSStpAQHIUWkaRtjgiOQgNHSjRdQHAUfFi+Ow6qXwU6BARHYXVPWm9l3dugaj8VR7VFJGk2DIKjUNFQlC8uCMiNQiVDUblcICA3CsEuDMeA3CiEVZhZQG4UKhmKSvh1QG4UGjdSTmABuVGoZCgauSZ+QG4U2gX2CtsJyI1C40YK+AxIjkJlQ9EoagPJUYhtUJXFhOwoxDaqyssgOwoVD0WjbEsIj0LFQ9Eo2xLCoxDbqMroIyA9ChUQRauYVIiPQiVE0SobE/KjUBFRVKroBgRIoTKiKBeXDQiQQmVEUY6SDgiQQmVEcSuMKs1HJEihMqJoZSYQkCCFls+m6BgESKEyoihHVQcESKEioiiHSQfkRyG1AdVeBQe0hSMpXtaAAClUSBTlOOmABClURhSVmqsBCVJoRZC0HRIJUqiMKColWgMSpFAZUZQDqwMCpJCXVi8ipJDdarogQgoVEkWlRmtAhBRyWJmDiJBChUTRyQc8JEghtyGVjR4kSCG3IZWnLgKkUBFRdPLURX4UShtQZeoiPwqVEEWvnJGQH4VWRLso+xfyo1AJUVRCjQPyo1AZUfSKpkOCFMpyM0WCFCojil7ZTJEghZbMpoEVREihISQNrCBCCmXlhgmIkGKlRNHLcz0iQ4qHNqrygSAiQ4qdIcnmWkSGFA96tbKIBCn2UkhyWmhEghQrI9KMjIgEKR7iwsiISJBiq6WtGBkRCVKskEgzMiIipHgoCyMjIkKK5rAwMiIypGjMwsiICJFixUSakRERIkXjFkZGRIgUTVupsqqOCJGiWeH7iBApGr3AVUSEFI1e7z4iQYqVEWkaJiJBiq2atqJhIhKkaA8LDRMRIUXbVql89o3IkGKrhyR/FSRIsdfSlg/tERFStH75KjiedpWhGJEhxV5LW3sZHFHb2L244UVESNG2IZU3vIgMKdrV0TQiRIoNIinheREhUqyYKAaRIUZkSLFV0lbcdxEhUmzhR87LsxEhUmwQSXavR2RIsTEk2V8eESHFComi7C+PSJBiZURR9pdHBEixASTZXx4RIMUGkBRYHhEgRd/GU55byI9i40eywzwiPop+FfkZER9Fv0r0j4iPYsNHch5WRHoUGz2S3esR4VGseChGedoiO4otm005YkRkR7Flsx2K8jtxQFslJDGDLCI5io0cKRViI6Kj2O5dU/LwIqKjWOFQlGuhRiRHsWezydFSEclR7Nlsyn6O5CiGNqCKYYTkKLZsNsVQj0iOYiNHpYiXKUUkR7Fns2kvg0Na2ZA7GDFbMiI5io0cRVldIDiKDRxpUwDBUWxBR9rWheAoNnAUZWWE3Cg2bqScpiJyo9guXtMGCblRbNxIiWqIyI1iy2VTbiaNyI1iXN3WFREcxQaOlCIYEclRTIeVbkRyFNMi6TQiOIrJrtYGkqNY4ZDm0IiIjmKrny0rJCRHsSWyKReNRiRHsVXP1tYdkqOYVjdeRkRHsSWyaesO0VFMbUjl3Q7JUWzkKClzHclRbHls2mxEdBTzKposIjqKDR1psxHRUWzoKMn7HZKj2MiREgUTkRzFRo6SvGsgOYqNHMkVESOSo9gKaGvLCNFRbOgoyZoU0VFs6EiOU4lIjmIjR0ppvojkKLYUNoWRRiRHsaWwKf6piOQoNnKkvgyOaFmeX5AcxZbCpr4MDmmLPUqyjYngKFY0FJO86pAbxUqGYpbtOsRGqWEjJcAmITZKrYK2ci1tQmyUehkk8YCRkBqlwyotPCE3So0bKUZmQm6UWvqaMkQJuVFq3Ej9MBG7p8V8SciNUiVD+stk7N7KrMgQKyE3Sj19TYZYCblRqmTIBfnAm5AbpcaNsszsE3KjZFbxZAm5UTJ+NQmQGyXTSkXKJnVCbpRMXL47jqpZjiqyo9RvYtNeBkfVlIXLPCE7So0dZXEfSIiOUkNHWSYHCdFRsqsKDgnhUap4KMrhagnZUWrsSIk/S8iOUmNHSmmLhOwo2bhwOSZkR6mxIyVcLSE8Sg0eZVH5JmRHqcUfyZUfE6Kj5PQavQnBUWqltJXOOJwt9qgo2gu5UWrVkJSwloTcKLVySErEV0JwlFo9JCXiKyE5So0cKbZ6QnSUGjpSAqcSsqPUg49k6p0QHqUGj4ps2SWER6nyIaPkQyWkR6nRI23qIj5KLW1NPvMkpEep8qGo+FYT0qNUAVFUan8mxEepldJWaq0l5Eep8SOlVGhCgJR8WsT9JgRIyedF3G9CgJR8G1TZN5EQIaWGkLQvgwgphVUVuoQIKTWEVBTliAwpVUqkzjBkSKlFH2kzDBlSCmExwxAhpRZ8VBRViggphbQIQkyIkFILPtLsO0RIqaWtKTGLCRFSaghJqeiakCGlVk5bmQKIkFJc1V1OiJBSpURJjlpNiJBShURJqRabECGlComSHIaakCClyojSQTyaJgRIqSKipEShJgRIqZXSlqci4qPUSiHJo4nwKFU8lLSphfAoVT6U5AjUhPAoVTykXVKeEB6lFnakOKgTwqPU4o4UB3VCfJRa4JHioE6Ij1KKCwd1QnyUWuCR4qBOiI9SizxSHNQJ8VFq+EhxUCfkR6nxI8VBnZAfpRZ5pA0T8qOUW3ygPGMQH6VeSFuZ6YiPUm5rVIzfSYiPUgVEWmHshPgo5bZGRXqQEB+l3NaobMAiPkoVECU50DYhPUoVEFlt7iI+SpUQJSNCtYT4KFVAlIysuJAepcqHkly2OCE8Su3+NcXjlBAepYqHkpGPXsiOUqVDyYhMLSE6Si1tTanmnBAdpUqHklFsF2RHqaxSERPCo1T5UFJu+05Ij/KhDag4EzPCo3xoAyrOxIzsKFc8lOQqxBnZUa50KMlViDOio1zhUJKrEGckR7myoSTHy2YER7mioWRlTZERHOUGjpQSxxnBUW7gSBOesXcdTitvixm5UW7xRkqgREZulCsZSnKN44zYKJs2nvLUyoiNcsNGCgTIiI2yWWULZ8RG2bQhlS3XjNgoVzCkXUWQERtlkxaXC2TERrmCoSSXXM5IjXLLWVN4WkZqlBs1UhIEMmKjXMFQkiOPM1Kj3JLWlOr/GalRbklriqrLiI2y9QtVlxEb5QqGkhIGnREb5QqGkhLXnBEbZbsqdJ8RG2WbF4o0IzfKtqzmI4Kj3OpoK1wyIzrKzqx+KsKj3IKOtJWK8ChXPKSFwGWER7kFHcmngIzsKLuwqHWekR3lVkvbyS7HjOwoVzrktSmD7ChXOuTV74iDWulQcopqR3aUWy1thddkZEe51dJWiEpGdpS9XdxgkhEe5Za5ptxgkhEe5VZLWzmTZoRH2a/isjPCo9wy1xTElxEe5QaPlOs0MsKj3OCRkqCVER7llrmmXGGRER7lioeStmMjPMrtJjZtp0F4lINd7TQIj3LFQ0lOWcjIjnKLP9J2GmRHucUfaTsNwqMcVjfHZIRHuVU8Uq6CyQiPcos/0rYahEc5lNXegfAot2ra2maA8Ci3atrK3SEZ6VGufCgpZe8z0qPcApCUmOKM+Cg3fCSnlmSkRzmuvKYZ8VFu+EipqZ+RH+VW+Egz8pAf5cqIkpMNJQRIuUKipIRaZURIuSEkL58gkCDlRpC8ojQQIeW0cq9lREg5rQI/MyKkXCFR8op+RISUKyRKXjzNZiRIuTKi5GWdgQApp7RwDWUESLkVP9L0FwKknNqQyicO5Ee5Z64pqhf5Uc5tSBWzB/lRzqtwlYwAKVdElOSQ9Yz8KDd+pJ3EECDlvPKYZgRIuZXRViKtMhKk3AiSEuGeESHldhHbQbHwkCHldhPb5gUXu+OgltVFBhkhUm4QSQ63zwiRcoNIQVnVSJFyWZ5RkSLlVkVb++yIkXLDSNpnR46US1x9duRIuaTVZ0eOlBtHUj87DmrjSEHRSMiRSq9/JGfSFQRJpUUhKTFuBUlSaSRJTkUoSJLKsv5RQZRUKi3yQWa3BVlSqbjIO/k8UxAmlVZEWwkBLwiTSiuiraTSFYRJpfKiJGddFIRJpcGkIJslBWFSqbgoyWUKC7Kk0lhSkDeCgjCpNJgUZP1YECaViouSnOtQkCWVSouSnOtQECWVhpLkSoIFSVKprChFeWEUJEmlsqIU5amLIKk0kKRkCxUkSaWVz1Z2sIIkqVRWlORA94IgqTSQpP1QJEmlsqKkRK4XJEnFtgEVd9OCIKk0kCSHLRfkSKVxpCRPFsRIpWEkpbxeQYxUrJ6LWBAilRZ7pJyoCkKk0iBSkmciMqRSKVFSqusVZEilUiKvFOIqyJBKpURJqalSkCEV16IaFN2CDKm0utlKDbGCEKm0ACTt1XFEXVzUECvIkEqlREkp9VeQIZVKiZIcQl0QIZUKibS8yIIIqfjD6l0QIRVvFhixIEIq3q5eBhFSqZAoJXkDQIJUKiNKckh0QYBUWvSRvIwQHxXflqgyoIiPSgVESQ6gLkiPSuVDKcubBcKjUvFQkgOiC7Kj0thRVpYosqPSAo+U6+QLsqMSVgeYguyoNHak7dAIj0rFQ/q744CGVbx9QXhUKh7SXwaHNDS7SGZNBeFRqXjIe9mtXRAelYqHvJeZXUF4VFrBbC8fkQvCo9JKZnvlpyI8KhUPea8YmAiPSquZrelGhEclLq1dpEelxR4pJTML0qPS6JFcMrMgPCot+Ei5e7IgPCpxVcG1ID0qjR4pMcsF6VFphbOVoioF8VFplbOV2yEL4qPSKmcrmXcF8VGpgEi7HbIgPipplWdaEB+VVjpbKdlSkB+VVvpIDiksyI9KK50tptIVpEel0SOlIGNBelRa6Wwl/bYgPiq5aV95R0J6VCofsiXK74L0qFQ+lOSw8oLwqFQ+pNWCKUiPSiudrVxUWZAelbxKMi1Ij0peZSQWpEclr67BLEiPSgtAkiPoC8Kjkld5wwXhUWkBSNqiRnhUytI+QnpUWgKb9jJIj0pLYDs4+TsiPSqNHh280h0Htd3BdghKdxzUyoeSkjBQkB6VsgL3BelRKcuFivSotOrZCmwqQI/soUUhyTH6vZV1N3qFl97KulvdV9lbWfeFN6a3su5eJ1+9lXVflMnprax71PVGb2Xdk15Dqrey7i3dSfvuGbu3s4y4+Hrr3L0iIiPn6fRW1r0GaMuntt7KurdKgiJc7a2sezufisujt7LuvnZXvozBUW1JbHJwaW9l3WuxHNnz31tZ91S7K9/d4KialkCsScdRNa0Yh/ZlcFQrJ7JyuFtvZd3rrioH0/VW1r3aSXIYTW9l3VuZMmUSWBxV2xJOlZ9qcVQrKrJytEhvZd1bSSvlu1sc1Q6StHfHUa2wyMrOhN7Kurfic9p3x1FtiWxBeXeHo9pS2eSKPL2Vda+jGpRRdTiqlRbZqPxUh6PqWuSgMiMdjmrFRVa+rqW3su51VGUk21tZ9zqq8h0pvZV1r6Mq3xzSW1n3OqoylOutc/dWSlumSb2Vda+jmpR39ziqrRaSnJDfW1n3OqryxRG9lXWvo6rtTR5HtfEk+aDaW1n3Oqpycm1vZd3rqGpbmcdRbeWQtK3M46i2ckjaZuNxVCs2stpmE3BU2x1sctxNb2Xdmw2s/NSAo9ruYJNToHsr6964rzIJAo5qy2aTI7t6K+ve3OKKJgg4qqFVz9E+JI5qxUZOjqrsrax7PdnIBYZ769y9YiOn7U0RR7ViIyeHJvZW1r2Oqkw3eivr3srnaC+Do1qxkZPDV3or615HVa4s2VtZ9zqq8uW8vZV1b2XvlSkWcVRjK+Sg/VQc1ZbUpm1lEUe1ciOnbWUJR7VyIy/HSfZW1r2ebOQy+b2Vda+oUFseCUe1ciOvLY+Eo1q5kZfDKnsr614d43JseG9l3SsAliPweivrXgGw1b47jmpqRUC1D4mjWtmR14zajKPa7mTT1mrGUa3wyMtRT72Vda+jqpmdGUe1wiMvxyb2Vta9hTsoSi/jqOYWvq0MU8ZRrfDIy+E6vZV1r6MqB6X0Vta9jqpm1GYc1UqPvBwe0VtZ93YTpjLFCo5qaYVAlZ9acFQrPfKalVpwVCs98prZWXBUW1ltuZZWb2Xd66hqVmrBUW2RSbJHvbey7nVUZT92b2Xd66hqRi2yJVPpkVesVINsyVR65JP8ZQyyJdPYkuyZ7K2se7vgVJ4zBtmSaaFJchGF3sq611FVTGaDbMm00KQsf3eDbMm00CTFBjbIlky7mk3RMwbZkml3symKwyBbMu1uNrn6eW9l3SsHVjZ5g2zJtNvZ5Etueyvr7vRbVHsr67646LS3su5Bv160t7LuUb8vtLey7km/07O3su5Zv3Wzt7Lui4sxe+vcvV3PpigOg2zJtPvZ5KJ9vZV1t/ptlL2VdXf6DZC9lXX3+r2IvZV1D/pdhL2VdY/6BYC9lXVP+o1+vZV1z/oter2VdW9lr7R3x1Htl7Qp745sybjF3U+9lXVvVQCUSYBsyTS2JF+I1FtZd6/fEtNbWfegX+TSW1n3qN/M0ltZ96Tf+9FbWfes38zRW1n3ol8o0Vvn7o0tyZGqvZV1N/ptAr2Vdbd6Tfbeyrovyqb3Vtbd6wXFeyvrHvSivL2VdY961dTeyronvfRob2Xds14Wrrey7kWv3NZb5+6tUpKmOJAtmaCWNOttrPOipFlvZd2dXrirt7LuXi+W1VtZ96CXs+qtrHvUC071VtY96SWheivrnvUyTL2VdS965aPeOnePB73cUG9l3Y1eEqi3su5WL9zTW1l3p5fi6a2su9drMfRW1j3o5RJ6K+se9YoGvZV1T3o6cG9l3bOeONpbWfeiJw321rl7y3bTDGYkS6anuylKCcmSqexIyY7rray70/PXeivr7vVErd7Kugc9l6q3su5RzwHqrax70jNdeivrnvUAut7Kui9yLnrr3L2FLMlpEb2VdTd6vkBvZd0XMfq9lXV3emR8b2XdvR6P3ltZ96AHmPdW1n0RA9xbWfekBy72VtY966GIvZV1L3qwTW+du5dVfItBsmRa1JLSGce0kiO5TEVv/O///u9//HF+/3m63k8v/9/7y+mvP/7zv/7rj6en+98fpz/+8T9/PJ3bf7T/qEL/+M//+cP+8Z//87//+CP2/02+/a895O0f//uP8Tfq/9v+5tPxfj8+f9v+222WuZVRI6n1CtEqqN7z1f61FVRTZD5f3r++nZ9RYpglxgNJjCTRaxJfTm+n++mFy4tMniF5ieSFX8jT3jQxyZYkZ5IcNclneMnMRDkSVUhU0kS9XZ6Pb0+307+4xMIk+iHRHEiiOthvl9fX03UWl6aPWNTPfz39ZO9gD+wdAr2DoXcoC1nn2/nyzj+5NUxiJInj429l53SJt6fz+9cLl2iZxEQSHUk0msT79fh++3q5/pgl+mlWBO1THZ+fTx93tjrL9LFoIdGs2u59bf9I4+OZMl7R2jG81mkve3y+n38yfbCVb51++r6+vDbVmoz78fad/eA8TzWbxpR1Rv/19/PP8/3v+/X4/P10Pf1EtRLcrAScGzPHOfXVXn6c39lb+Xndb+fh/tXCGOIStMlXhbEX2jJCJ2l2/MbtiNWlHTQtcnx7e3q/vJz4TGYfbStUrT78cnm+/evzdD2fbtfT7fPtzr/U/DOd79OlIthfSvybS8pMkidJ6mdqkoSX8mz4Qh6ijLY4j29vlz+fnq+nl9P7/Xx847Mhsy1hLUSR4cP860xU59H78e3vf3Plt9WF2LVf6J94y2Lps5JUvyMdt5Vkb//aqkes/9a2u5xfP6/H+/nC5nAIswL1tBl4o+2px4/z0/cTG9etjOo005KqID7O309/S6MZZj3hx/qpYF0T9fF2fq4/5+mfN/6b7Dw3nO1TwxfSc27oufEBraN/eXWNTX/x8nw/3Z9u9+vp+IP/5WkKOGfGXw7jL/vxl0mvkuKxXl1O1+OX8zOfLm6eLkPduGFlGW/VGXH9cXo/H9+5OD+LyyQukDh1Ntz4i7lpa9qKLtbnt1Jq7R9Dl+Xx6fP4NltusvYn/n5/Pt9P1+P9wi2GadJkzQw63u9Pp/fny8v5/fVhaw5M5zo/fu+WraOK60YqW/pxttPs+N3GD1uw+nx+JbEKYFLnVWFozpi87880bw+/ls+01ZZ5tBvrpNRjH6C+Df7jDxf6n3Xjr7o8+pTexw9T3A8rwbvex4fxX4bkYPpTwY9/jP2cbNE4norDFEljhSbShIc0tKO1pCf9+FfRtdD9PiYEzgdrzPxRxuANw8i5OD6KHd9i/KMcxj+GvhnWjrfj6/jD+Cjjv6TD+CjD9ho/IKQ8Psr4xxiJOJ5KQ8MkOnMcUqKPom5A9/vt6XZ+f+a2WpzNVK+eWI6f92/zc+x4NvRPfyHl8f94vnw+f3v5cjvdNvt7+0/bfvqMC3zamtT1uInrcu6X76f3H8f3I5ws+HFvIai/BPsshq3B33iYnbq2+gT740VXo7uAbX95+cKFFCZEtXm5kG/H95e305Wt+q2mwSzqN77G9mHhmG/crDUXIrYHn/pgP/VRYibqLkfV35/3y+fHC4xKtPMr9JOL9PTP4/nt+OWNPzzv0vWyYPnhL8fb6eX0duQ27DQWqor5crzxDXsrvj9ZSFH77l+Om9XM9+Yw78108iHl59X58OV4f/7GzRM3G0Z+aLWuw/xYvn5oI5+HDitDLQ2mEcYJO7hhTtEB6EBn3AMdJbd4pvGv8eob0hv/IrVlSKub8WNJExvrtZNC/bFPt/O/OZCa7TFth/zydnn+zpbJVoZi3wfs+OvFaZP9y+Xy/cfxyg6tboY3cewPaXy3NP5LHhwgj+0lDxMsjz13qyLUv96B9r9h2dZ7Ovu/yDTIY+hqWSn1rd9O3BTcbqSb1kZR18b1+O/z24MdOTMc4mpubGXGW22Zf/l8ez1eH+SlWZ4heYnkqQvp8+370+vpvlHF048Pbvv4GYQYq/IcErKdQbkAwwSoeuDz7Ts+a2cNMi3jtJuK6iz7fPv+errXc/XL5fkTzdDADEZPzNWomKRLFE5kkW3raT9fr744iZLfbt6HfT6QyMWk2EWe76cfXFxk4hyJU+csP7Syk28mBdRPJMLzz8e3ty/HZ7bIt2TGXVMM5VhzGTUh78+nN85Rpx1lR4KatmoCqq3DgcikbLQJ9Hz8OD5vVOzb9fL5+u3j875ZwNcfj1iAHWhoG6gBWv8Pop8/r9eH2VDYXyj0F/Qvt/gL9+P19cT/QGKLodDystpyfz7ej2+ogfKsgQjCEIH0qvXwfPy8nV6e+KTbco4nu6XszDzTzNGUyfO34/srN9kTM9kLLQG7lsHRV2Lei4P6ddqjTy+Xd35KLZbpQnXe9uc/Tu/b0YuLcEzEWATZ/+Jlvl42HsetfTvNXBVV9+c/jtfjj9u309sHl+En1aACoS5D0J3JsWEJNCy/+DaKoktMbxZaKepp4kHcI6ma0XX43de6bpa0RGLCNAVU5P0oDaS42TpV9cy30/P3j8v5/f50fr+frj+Pb3wqeTaV6ECa9Y81BJ5enm6Xz+vzCT1dW4n1WWig+anPr/P76QaGfJlVyZjjhFWMt+qX+yc3LOdDXCG/mxs7qvEq639+O97gaOJmPVmILrtIRpu6Pz+/nUGr29m2GQxHMz6e3y7vp7YEuSNkWnz6D7l8vhyBwnl2VndEyYixGr/7aMZnKwdVg/e/8R9fT8f75/V0+4+V2pneWt8TNImaIpr5pF98R1nqUgFMUzqo0/iXkh9VwTQG4Vejt8t9fMF5b8u//KA/DXt25tmqdnv7vN355w7Mrg+6pdAeFXxu7GSR9BV9eXvbvtzTz9P10QXtGNxQTxfb/z/fq9ri+mor7D2ZtirK2wU0woJyAtvag25VXH58HJ/vT9fP93fY2gPb2gO5rIJuJzRhj78qMNUe9N3v8uPjIUZju+Fj0g0UopBVd+9wmXHyxWydP/qx/VcSbqfrzzOnrSYxpqcuFCkqxM78zfph9Q0q7AaHccTeBx/3A6T44VmkY2cYtCUMHRnGfkIBHXFw6zjcN2nAnzQ2tDQM7TxoUh6uhDzoVR7UvFAMz4EYgfMEMwJF0tBmVFRX5/Pl/f30XMnn/fzjdPlke8N2Ed+0MLOqSy/vt/sRYwVYpIsze6wAvTTFiRBEM4TyTbQUl7KH8BTy4+5hQoYOoW5M0ELsqwRyTxV9Jb7f7tfPZ/SUTSfMPltosvTBHo6I4WMYcKoP2WqG3k/v94dQsBDY2SQuhm17fjrKbQwPnPMsyOew29OLUdyEPoSnzacvZ4djyw431rAW6bBoLHE3O5w3xuob8WX7IZ+XT75cD7NTaVgllkIWyJy0hOxS1lX29aad2TPTj4f9nKALq2Se+xqYg0BFUQPqb5T/6fL+BmhltpeLGifShWwyUIRnB2VD/nmj2yq/51OazZ7xgRbLSZV5+bjjvj3vMLpAbrOaeX/c2Xei2ZbCYgje7y+XPzm/nT7bYt//BA23XRqwv/yBItMOw49bb20YgEw9D1x+nq5gAEQWFRP1E/31ePuGXMDNk9FQcEoH5aKU02bHPNKg7a7UWf//loCnx8PJdovqLEe1HqqcRzv80c6dY6K8OtZVHA/oZG9Cu7ZJOkCrQq6nf32ebnwSzmF6VidAEsWbP6vXP0d79NfcMbOAV7MTLXXAFpL3/8j/BouENft2or79v0/ckebmw0mhvZ+iAYx32kd8Ob6fbyBsDuYhV44jDOZVjPVyvB95nCSLQ0l7WARBBpUNb7I2jycHHzMbtDsjJ0WVVX085D11gx5Hmq1tt/heTYw2YdiBi4zYmnP62wKFk2BkCjE4cqWoRzpB7sf18sFPdswKDY7eVv/5X7gpMfslh7vQDtvbUhDKiEByIwjFDeXphn3qhluTYl/dsLfdmIRunA4oFIzItxuTwQ1D1o8/6oeL048/4cer+vEn/Fg0fvAvApth2FxhvGqwdDYZp5URqkUB2mG8IeUFxPG74ngqjqMFnSzoYBGHFZbGF0vDLEwjvi6Nn5zHgSgP8zmP81Qe36cMP20Zxn8Z/loy6UshjzmFVx+GJW4MnRoMeXoNHY7MHqRNzghTyEY97P8iLzqdTKzdAx/J7x7ov1HUqaVwg6Iv8y9PGLcWGC4Ndj8QUQi96kh/+dJZBDdPWMSGIePI7C+oBhy9fKnB33wZsh2AlGNQWf/LF/yRcXbjmqiS4JcvzV5/8BJExhJCIA2jxim8fBE+TWQBSmFMbGv0TePlwgCwnXf/MCYOHbNogwzjTErjGMYGQ5kzcSz0OPrEsWjSiGNLYzWnMXplSC7jqTKUgTnQKjgQDkiqj+zl9JV9nMzCbtQYyZfT1+Pn2/1JCs2OzJsTVctxyPh6Pr1xQ22mkSaqNtIQ0GnRw7JKzBX5m0I+r8w9kuaACnWy15QkOdLVsPOhmluDIkSs4ucoZmMWX5YLE1wGLHbRULTCQYW/QhpXSGxzPuxaYU85I3qjmwFNsGBMMbasZhjw5x9/qp3tJjdeqJaqXQqUSeLsSfLEQcYqpEB8P3hfGNzIHH4x9i+n2/n1XYoDMUzx6WpKECNOI5unaaSnbkjyhM87a4wwLJpaLnQpVvqdB+Y1/D0B8i+cT1lejW/hkoTfNkfM+GHD1JqyK4HtaRb+ybMSf/20+KvcvIMW/xtiHn+Sm+lC8fST4npy1nxGccxY2JNK9gUpsoZj4bZWDZ4R5ElKjiXB0dn4sNgMNrHXEyWuiD+ZZVKpzlpVlvzDGTE/qOkUqlTh57ME1sNwe9uDmrb6csLklElCHqeMbMk9Maz6EYWVR6RqUZnK9jceA1rsHBRvKc+NQvxGpI4bJ0A32D5tNmGciyiVNQ67PI73S+NYmvYgAL97SvTZu+lAbl+z3EMyiA3FcBYV4DdpT9LU8oXhiKxPf22v2Oos7eqYPPphz/fTTxJMqIIPomUQLRELcvo6mMUKFDgyT2PYIyedbm/NIn+eT38+qNytxNPsEqbYSZWEPgq9/Th+XE8vn9wRGVkKVCi7ZHVZnV+BH4bAAp50HXK+nh5AUGRWYFSDkV7Ot+9PbRCH15wfOlkYm+rzqGIwTDwxHZjVnHo4OQUWLB3IOgwjMapeXNvV1EH9Kpfnpwe/QGBLJ1CCEy35epO2LvDl9CYJZe9rye9IATJZzdjfhPKKAp5Js5no/O7F1AezSuNk3bCTha4sLs9Pf17P99PT1+P5bfOu85dimyQBkewXr8J/l53zncnZ64e73w944gc78QOd+EieRArSD/vxlY60FGR1oITNA7lXDDlfDOWnGgrtMpNrkv5F0QyWXNN2eDeNJSe1jeo2vH2Dp+fLB091YaUQnG691KdvlyufbKw0g9Ot1u1pcJjOMdXjK1tdrWCE/RxRTVFxbnxhN3Z1T85dOt8Y8gGbSGOY1fD57S8/XU9Hfo48MKOPBiyr3p0qZpvTd4jpPrA0A0r2zPpphJLlr5c/mZZlsXFhDxVWAy2ZqJ/Ht0/IoWJW42HHTqqlJG3v81s5Wlh5n7v70Zv4mOpCHH9BmMj8xPmrVxRgHSv1EM3+MurxlWQJRUY8i7m2qov3Qcj9eOfBBXGuBWIipSpF/bzZZd6+Ha8vD7VKWFJEdGQNLNTn+0lK6N/FqMluL9fzVt6BO7A9OzUfiFkf9GH/vKN3bg7/o9AhR0vbq4j19ON4fuOy5vS7kcNsHP1LP45vaUd/X7788/QMztZp2yQ6X6+zUuS8b2HXT1vkB3djMoNHzU1tj+PTnuFroyZQtqc5z2R/OKngqSZZn16e3k7vrzxlOASWXKROkJGmzZ9l0fBRM9VO7y9YpiJ4lrdKEcCUWF1vgFyKe3o0gxJzJxc1mez0/gLvY+30U+zIBaEqBG4kvAU6HA6WHoeJRfFkcTiBKHIkqYfu9iaPds/stgljt6TMlDROhXp9j9OWUQ+uIHa6UJ2yp/fXtwe3+JxMOIIbjaNwKa8e/U7XKw/68Zb5j6gOETkfDX1jEygwL1ICKvn5TB6jYw+qN6H++UfrO7GzZlbNqfr4/fJ2uh4hRX8+WZKjRV0AteRRzWfgxtVc92HEVZGnz6oU/vTX6fmzhlduuxDfhFgUSCTdGFWAtgvbYjWfOOmJLHQwqkdxEvLwQlsh3z0MathNeVjHeZjEmcIch8lRaG5ERzaSarid/jrf4FOwILykRpCf/jrfUbNZVtJI16t/fbwdz++CkRKYLbBHF6jmIhP143q8vsK4soEgz3RUna1M4OUDpwl7v+G5rwWQVXFwqmDbMRHQxetcT/fr369YPmCyctSA4tNf99P1nacXBeZQDHvkrpqosh1SMRSdOauoUl1WTfGvxzfIJZqjU8grFalGytja0jB58pjWeThf8zi05gG98ohGKHvCu5o6PhI3eOzofMYo6qlpPPv09e34ChI8k6CZVl9P/JOaGUVQqTpL5ispbaosNQ58Vo0Er35cOJfOf2XoEDtO82nMR4qOymMJ5rGV5zEghaYOgQVDPnNDFV5MJC5Q1Fn+9fwGVfdYzoUafvv1/AZRT3YulWJH/LqdspI1+6jJgkqKLIRKdcl8Pb+/CMqMuU7iTjxVR9HX8/uZL3NuX+mPPUbkzW5yCrRxFJ/t1T2ppYZxQz2wRHW1LtzX6+kdDzKzd4sYBYVeGa8y5dfj2/kZyynMOSeFBpVKFxmvaqDX4/XL8XU7hLy9bQgXdy5WIVA9er6erj/glebQ/kI0jFiN8Srgfj3d92KRPA6bZX4XbQvmAgSHE0s7sORwMgdtZx4SV3UnDQsnUeMTNFHSa7KcpEj+BrVa5Cb77e3lCxPDikWqKoMeFbzL83InVlVv6NVlKTEm8/ipByr2vOQundWPoQIDh7IYvt8ukMBUrHoS+JXEx7c2c5Kb3asCqGU3tj+h54QYZhKqfo1HIcL3ZAdvQzGnB3VP2KT+Zty3YTnuqtXxC4nS4mA+ilE4pt42pf6JX4QcF26+/Z/kSPE886GOcpsOCyV6FwMBWQVT1dk0Py3Hmsz02qq75ixHmsUzwbe7nb766ouAIcZtFovtt3y+htWDU3fylTgpbmiaaGEPRFELHT+Il2ROumDPhTiox6VNphiIxGnzr58+3n6c/wITm4Wuq+kYj0KE3zXzWe9oyquuAyb0enrDVBhz4Kv8/yBGertpeviwj+RiH9rFPub3GJanoxIwQYr0bnMEV6Qvp3ohJqlSPNhcXcDSL9WtwF1a9R7c0H1gWIiS6sIV5QjKm7nX94RJo56EXk/3+uxJ3Q9Z1W+1drooR4o+m61XOnYeVBP/9XRfhJ6xGITFq/1O3BmzCdXsEhQmjQFzQQ4yUC/hVGX+OP34crrevp0/NOtpFqrmm2mSpP1mTmDbNaWavvp62n7r/byJ06YKcxquVpgkSZgsc3xDpLP1YTUJfxm6x7ySC8X+exF2zGN/SPQZ1aCQ19P99vzt9PL5drqiF97wKpuL6cJEyPOZHTCXBzAmTPqNLNG1kIG9OmbMMoVBYIkgv/mptCFgpT+MoVOUWgRklvvPC8sWM6yquuoOAgnSSzHLn3LsDireB5F8XnAX82LPZyKk12IHPMrjPKilRTaZp+N1K84E+xaLjlDDZNjzUoQqOxR6+k5qJGYV+Px5Pd//5p9oFqQC6ulp6evM9prZNye1tEAVd60Z3LLSnje71bChEElfz4cMQ5uKWiS9iq1J+OpBl2X6rFbLgxzp4zF9Y/dluFDWuykjvR9zkak5QJIYaVNmtnigqNXVVioURTFMjhpG/nq6f2o7uWGWhlpIAUVIJ3VmaOzOodVR9vMTQscYC1uZifVJaWLO3tFdpai+jNfT/efx7fxSf9Wj33k+FKrr7no68fpu86codAkD1d03Xo3Nfb1ePj+4U38OoB4SyLOdhsshEV0u+lazCX96O/3k9UtT5qWM1DW8Pf6QHefZ4fRAAYyLM80m5+Et7IwcKIw5jlNNGmWS9MvCmtzzjzOPYWfn3gMlvh/UiKgqh7u12Eac9VVSnwSPp2eH2wMF1x5Ur/S30/FFIauBV6/4LQESWmV1ORKdHNVftkmUcuIYnlOZ3Py0BJ7nEio751V971XcgjaxqNffFyIBnDm9brc1lyMnvROrfKYeauanJdA434qzn5FUlLOJA5eemUO/7IF0NF0JRT4SAq1jOGgPHbns+7Y1Am0pVNaOT+VGXKkb4Z9u+E3d+KNu/Ak3MoXdsLzoriQK13PjUEM1xCmeyA33rR9/lG5D8mPV+xF978ef8MMt5EcAFpUypnwAKsVEEfdhRO+EoZboFsJA96SMjxDHF6OIjjj82XG8BgVTxBHIksavoGui0mBZaThT88hOyAPR5nEuzeM18vDklKGay0hGKONrlPE+hWLqDhQ7daBbdQ4UZ3egK4sOlGF0oJKoBwogOpDH9UClkg2lWRgKDjXDUWIMxS4YioA3lD1hKI7L0FsZKnxgKIvK0BsYqjVvKPDMUNkGKvhtaA0YmvvG0h1udL+OsfSFKBbBWKpsT5U8DEUVGBv3fiRvv7mK6uYlNUNrW8gL7DSfNdTN+0GGtCswXHcgdacmmm9Cf4k4WAjSan/5zSxCdv6nqgsH9cbPTfQvAABLYFp9wd8hAMw7cSDoeVCreTHBiABYJVC19g+KkF6LmWl0r9VB9SluMhfHBlZ8XztNPsiQzkIMr0failSn7LfT8Xr/cjpCHbZJjB07ifUUL6ROj/Prt7fz67f7Y7yQmzNW49jcEmmKA90TdlD9bCT+/XMjoVx8mcUPLb/XbtvvDNGtmCH+43K7348sqsPNODCO3THtEfl78U41iX+Xfz09iDez+BGxth8AKBLzoLr8SDyY2yyKTJ8I9DSkA7oZ/VKhzrTb/qT2D2oM8rfz+8uZn+rmmmF7aS7KD/Kq/+vb+Xa/8Ks0E2NyWc0g+Xa/fzztpVEh447xQTVQ5tvnu3A3yxwBUWiXdJSk5FWH2RkKPR8Y7VIDmnm0emD7lt/vUaFtmqo3GDKlTKTpta+TvId5T0XByT5Ww2gAPQTLvdSUeagea85ffzzc0DSHyPrxivSb6AbdQAUxD3E3kShJkAKpDCWxGTKgrP6Lvr5f3k+PL+XYlQp0rd14uxEJ6Yd95+km4WGEhn3tUHWpA5ENs/+Lgu+JChqreqzPW+W2l9PD9TzBs9TDvX7LPr6qPu8yH3IK5/3PjiR7S2XRhsffjZ8XqKLuGAK6QToOyy+OcYojJZEqAFNKbtqTRenS74MatNDfXtiL5tkZR35yIrv5QGXCDmpMYRV+O/88PZ3e+Vpk+NxRnHhRbRYSBZLsTEqoaqEbH4zKW4VxzKFLtOOwlOIYkzQOWQuVUv8q21PnxLURhZjGxynDoi9+3wXpAGP3OU7mOV2gHT3pG5VA1Zd4Ol6vx7971hQPqGVBUlG1mmr3bRK8nx+S7RmupaJ31qhxKs0PzkvosgoHTt38+6NPH6C52V14Vg326h549vosRSJQlHTa8+OpdkVSHavrEIHIamgmcpwY9eq5+qBQ9otlO9A2H9c/WH0r7sujX35Yzm0hrppFLu7GaFJv+agP3k9/3S8f7bqHXmPs8RezELREsQJGTY44v2/po7cH02LO39wLw9Na8iobPm9Frl6/8V88/WD1tPKQCMt8eYE2rbzv63s5djWop67A49v531jY2DLnHBnSWbV0z1eMUZ8/dqESkI62ea8C6vP9+HBz3wz2ClUboNqexqvM8p/Hj+PDXTfzGiqUZEeZ98arKUn/vHyBMhOGAXgqoK/f44Ue58RKnGTVRY/3iLvAko3SUP1EXNRL3jZJUubvfMbc62+pMaSYLzq7hemmY7oaniZpGLqG0sHj4EqUR5HGBpb2oHua0J5KVQSCVIEqMpa828bactqueeeMfr4YaGgvuurB0ZXstNOPc0Qc+DIOOkd3XKbB8NLuI6OFWlRX7ffT339eri98vs6JFmQzO9pgvJqt+XZ8f/08vsLttCw1mxJIghow8Xa83R/uO2F1I+kGVhPUqipVSgvK5SnKrNZyViPyt+drmgEkBs+RS3QPglVDerbASl4gyM6Vt5wh9D5g/JiwbkwyP07YfsBvP+wnPww9P1h+IOarR/G8He8/H3TenA5DNSfoVnPj1UDbt+O/2cp0c9GCOM6OlEGaxspKw+DKw5bPo6YVnT3zOEtT7aBCJLuoKFVKsmdXOKpa78HjOacnUvEVCmYZB21b6OgzHDFjYMIwf8PIdqOCGXFolkilY8fZPJFPevzRNMh3GpsalRbKYxbmof3y+LRlPyZRXZyD2w/JRPbpSOr2e2bIrKeL503aqxbvO75qR7ydb1DEZdYFKoeraB3Wv51DL/04efjxiqSk6Z7X/XalQ94Pz+q4X17hnvQ5T01f3Jf314/LG/e9zwTHUt70cO1YNdxlCJNu7JnBv3o6+XHc7u173xLln35cXnhRLx7dohow7cZ4pPqeVbmw+w6jYq0fRxZ5ERmECLv9r9Yx6sGu7C2YEEO3Apn9jK3uwb+Mwo3M+071zm0XLork9w3Y+Tjpx9v5sS/7MQP8+HyBVJkepffj/P7UbhYUp8W8KNSffn4///jklJFl8xV9Rp1vN7zChEd4UjH2rJZs6UKeqG7P09fLJzATRj1Jm5qs/yiY3yzfjsrYaw8Lyf0sDlPd635sV5dsIc5PDzkhdo4/dqSh6JxGqsBY/VeReCGxw87VjRzNrx1lUjU8qw4on/KsulCgune9xr/0+JFX4XZzoGGhipRuv9CT/LVUYtd4ws5UMt2Qx8YkAtW7c4WuSDOF8HRRDb/tfcAFwnSfOlHfT38+nV7OcN0ZmxlexVXvpz8fnrVzzoYficp0f4bRK3K/b2Uvt9BvXq+E5yyrz/4Ft/3sD6nxru+wngK78sOW/chPddfUWsePF0GykK+oMrL3yxu/f4vlvBT1mPy+KXTYhGd9QBeWkKdWzcZ5v1z/PL2icTxH6BaqnOXIk+LVFf3oqYzMRxvVu+Qu3/nin8+MQ5V4Q2pmTK7BsOg+lTQ8n2m/PGC3jej8fqAoigPZ/IYyzy2RHkubLZ09zF7hkWoxmUTbcyK9UKjIJgXJWP0OM+lSsZkZkENLjQl/rLnC5qE6aJfr+fUMReqYDjHkZwpqlLaQ9DIXq6fTuv74RsueWi2Jp9tpKzVwgZnEMl5UlyWl5PBvwYIhyJqn2yxNUqsNkEDYoNid1UPfF/LOUSaoCYTo6BYaQ/PUJPWq3OkPP0lEnJkRgTbcpIYITwK7vJfTvRap0cxEVlk30UlQr/z++CdU0Yy1j3OjNep2/KusrchuWUhul7iYtA8SpQ/N0r7TXlxJdb0vBIvyGZenW131JEVJ/sPdmZHdxZMo7cyo4egkFuijm6MF4lCiMRCeGyf7EbNH95qmYZ2moT7T0LJ5eHmz6tL8ON5uyOvm/OGxNw/FTAGFSTWGPx4rts+qgTwOZi/SQxvE4kWb1MfLmOflk9UKgx+n64NHJbCThyey4fWlt1XGxq18Tieg8AhibcartvPHN4jXDvxOC/oqTvUePTj/2LGazImsr/jLQ2XAeSmWvSgPOcW86nDayol9vn6iu2Jee2WvrkMVlr3q+/u43G7nrTznZrduUTrcDGcgOKugf4u++o3KMSysSVU7miw5s5L57Kxq66tSpUwedrKl7ACjkooqfCsFy2Mu2L6jFkCZHpbS7ws3Yn5fiBBBP8eVub0ygBq8N0mVpM22EdnrBxXYTdL+9Xm6nrmiZ8XY1TobjzLEb8Zqw/7++6w+3XyQ3xNG1HPRo3BJ6JzRQBljerRjFfpxRueUCXyP/PXTUnUcVhWGrvw4qOxzE/fl8+37Q940Kx+u1qqeH5c+zexwSfQ2qn95iINrcw2vQL76sP1psXQIC/hYDTkXIpWsmO3tvA/5atBIqFg6hCmr3/g8q9IhsxVBnnirR1QxsVLpEEYkVroZpEjvNpc12e8N0088u1RJ2qy89vvW1HDYTVq/DXmWwyC7Gpc4PSx9pswDBH5fiFwAaQ7+tarHVhAnpabNdSkoNv2wXNVdqvJysytWtwJ3McJLzTac3cvvLBV9v8aS7RKsWsTqF/WHpe8zV9QcBqk9LNchZd1xtckSFJYrbhcgf+PZXg5qygmXJCX/Tbto2DeEhW06CxS2eMMiYZYL90GO8kvnm/PUAhGiQOEHz2Z5mIoTLaeGlO3Iyk2sNPv61rw598WpaY6zHOFHzQ44t9dIUotMbeJ6FWQ2dvwCp9Wk6k/Ld+bN127k5Yh1MQKTm/OVKIrNHlS/5CZtK9LKfw/jTqv1uj0q7m6sfoeOUUCE8l1mN8HSzJ9lSR9njgSia00OagjxEKm81rRi8/LItsmQXifO4037rFrrZxPVnmVfmsUj/fJZ5brGOSpzqWDrE1K5rBlEkLv5oHOay20vriQcEA1LuVDjHSUx4oRktYHUeIGVOKns0xx4H+lHL/duFC+JnVOU9rPocnB3LisoKHY7wXKTQjHydJnnXFZLcUjyhF87a5u0m/3LzZnEPuou5t9cbU9MhqzE2L1KK4UsylLUxjS4WadzmlBJj0yvmYmKH9SM0AfZyovOjla1ZOmDMGmEyzxdyBJU02mZzFaViU9ndk3Mb71ZkyJrBlbC+7fWGJcmf77Z/NUv0lmIFT7kHFqe9nqyuoPpUbrysnEW/H8YF0l7zfcXZLKNFxB4krpdZslHh0c6/q4MeaRnjvZ7S2+WpehCO6uv31Jas1BpuUzrOYVdIf6WAtpkKy86X4yxtFKZMGkalnlq79UOV9r2evp5ezl//coGhF0aot5OMz8uJYkzyh3IrFPrmG3yBK3CL0tdLam+Tt+Pb3/z5GLj2CWcqxnGZMgDNt/QUpabPxMmDNhMdMr+hZZnjIXGhOjH3xaiXCfN6notl/ivFKRnWc+HvTi1GlOxS1VejoGQJSTVFKKfMWQpZCWqhew2YQ96kN2QrQcA9EfFYWP3dquFgFGEPDfnyllx6ST5hbKbfYb7RZCHpX7SddxMo8NSAciqzc7VmMLO1pfG3yZKQjr8ktRfvczCZ2PYZa1qkLIiSfroc3WJvaD58pw+SZYkzuUwdoeXDg+up6+n6xVyWVgiZNEPKtfL8+l2e3q8MjPwSub6DGgSBAHsnOh0WHm9vF5PN/jjbI2qBRs/rpcf59tpM7u/nvllK/OqWrw7L0EXmVcp6Kvxk/vaZ64yzAw96upTvdFj1t+6AfT5ixs9mEN4x8VqRu3Hp3D/Rvukn9fHAqesNJA6z38pUyorOSP3nSLqoOrz/vx2+XzZlFcv8aq+tmH3C6kp978SKe9trJTKAtL9QrjkMGWVjvd62Gqcav3M19viO7B0BnX7E8RIr8fm2k6zV5NfqnDIwrr0yMn9Yaly35yRtdfVUutibNIW9Q2Z9lqMKJchM/bZ9xZ0kwOFSe6S+fZRKhK4sPU+5csumDW20HO/cB7MIct+Oej6T5oTkDzdYKZXDv34XF0PwEKJFkP/O9cDML+yTjo/f309AHOfO1rFaoz3x+evq9rzayL/T4KU8vGsMLeaRCmLlIrIsyNE3s31xXSTC32z20IX4zBpVeH3sQp0+pU2kxyp5jWLINrxvHrm5tmKszfHUfEeqnRpknoIFOxiO6tfN8oJuRGoHQZHj6P2UFQR3yYdAlnn48So1pn2ZFEK+ztQ8P5ev6ioX7f+oafHD5vY4TWpNXJ5cbfZeZnHB8gji7BQolAY2bImqvPnukUCcEuKuVgp1SWq8UHXh9ANz+61OeyVhPyew0SFtdTMnevpCPGh89lq/FgaBUqmUP1P11q1lq8OXj2XioHu6bwqhbmejlAUIrK1FvZPtxcG2a9GU43I6+nlE+5lngP4wkihiwNPUOR2ogQyKpFgIlU9iFQtqqhbxKTi2JdnHmqnz4T98SeM7WXwQPX5TBKer6fj/XQ/XkeU0enhFlEW2LijTp2+zSpcMMgii25MlKSsQypB4PGTJ9snFieX9rsiVSCrCP1yvJ2fuWS2RZADUa+Fqkh+qLrHgh73KF3V4/KLbduz+3IOtPapsrzV648O0VA9nxkCZqRcGENZWGXxef/1ebrd75fvkI0/B2TpK+Rfn+fr6UVIx5rDDMbPUqXcPjYXCNvw5yKQdo/CUy/cfCzgZObwajulju6VDdfCOI9g14Q4KlJG5awN1S03geo3F9Vl3//E0/V0/7xCslRkR764UOH3zR54+jhdn/o48v2UZcqoCaX15m/29ydNstd4UT1Z7Sdw1TG7ZdXHfnK7aM5iHLskJQT7kSnoh4L3I2OTalr6kS0TxtkvjKpkewbzIdIGTKVMDpSJbWjXMNRqKHuDKrkbn/aMFyqFQXMsmn23079aT3lnQ8aIWd4Lx6sxR3vm/PO30/N3PpECO+M5ej/dVX49/fy48InPaIFXSdrmVGLjOaMsN1yXVPaUklAoWccPb7sfeX9+BILS1w57nupqXj04xxLzcu9uc/0usE0KBnLa+RDnKdF2pHj5Yc/4RNOPyqnoVsblDVPSWWYznRDKrlXUmJjr5cfx/SGtaY5H2i+MpvLwXgXyV7yh2/PASrLkyv4v2nJUXnz9hNu2p4+qrpbP9/fjF7i+nbmznb5Lfb6/P9SVY5kblC/maMCyrnU/b4+ZY3MBtP36GVpwXnXB3I4/T3XzfZhs8waojTe7xO1xC0zsC+X9+gkVFiwLuCfm88+0kWaVHpE4/HWJhUXmPUtUraejVW5PLDoyh90+07beWVLNzeLiGD7ay6Srio/dviaMAcMFeb+vSXUYP7rTI7vXhErSmaSu3CajPz+/DbtsMKtR+/PzWNSUlW9WuShzowufhfm96RYNq19JNm6UU2u2JnYFQh6Fqax+Mdwk8mGCsuNrJu+lDp/2G++kX8sWYt5fTdvFmjRJEr85dn8vTV/NkjZ31+l6P+OOwz4cXUmv34M+y7xe/uTC2Icr+8CqK1sAfp6VBTFkbhsqa1moJkDZT5HqTU3jbzwWm0zMgVF200BllLfTideMTqzYQlGjAaRCDfbA6laMvz7URBqbCSnvPCzZPLBPHsS87AboXntTDaZ+qKLIQnbo6waVet9O/9qKil1/Qn2VOfuCSoLYxfAv7lJM7CKusu9gagHDJu7n6f2Ff+jEUF4ZBwyre1n7BYgbE9hKPT6SoMRCrordX05XOKu7GRO7Q5iuD7JmoaarvGpAtPJs7DezPBia2OpBUJAmFVphlUVUUVu1uS9vp9d/nz+eLz8+rk02P6CzSmP6crsLN2yx/C5didZLNs/Pp8/rG/8wzMZWp2a9YpLrJZZ0SiUPDV1NtJe6KirGWd6AmZirqDgyaNQTz+YwPN4/rxzf8ayRvMNmdeWcf3y8Qb7/XO2YjHxHNR+9mqB3O0N9qnn5DWZiyXlCcXS6Bt8EPtSMYD7apMY3PJb7YBwyUEGiQGUfkq7Gv5/51ZFzwC+VwyJE5Eb9ScJC9Efolo04jlJxnHTTcNikwSvSKH2Xh+7Ko4Y7kfQ8Qv5pHzOGqj0Y8go4qrsf9zsfqL5x0VX15fn76f4kKIXEbmNKqucQL210M/CIw1hIdBvl+Jp5nFbpEpI8UEAeizCPTS8Pg4BswDxcj3nQmkI1iPaLIumofZh8Rfov+bzyGR7gQkSy0qcKaURgVCrf5D59XC9/8YtsmN5Ne50VXfs1SbjPMy+b20uqqxFit4/j+0Nlkblu+X4zD/1mrwar3T5Oz2duMbjZBCtj4heamkkty3e7IxSws9cijNGOgwPSd6P69Hms0zxcQnkwkp290E0khurxmqL6e7eKDHBP0qz8xoKkcoZ0AwBdomAO++VXe9Fmt7sO99dR1+r9+P5yhPLds4+okFuM3MXGq0G5t/sRVi5L4R+TSOXz9fknKJUUmMfR7R95d1yoZSFI4HarDTjYEku5LmqkVJOxFU/lJ3Z2Cy0hx6w6vqqc08sTOAoZf3dqwn19GkvYz+SGyge5oeHc0HCBakmP3SFa2lPGPwbDT2PapNWsqe/ycnnmn9TNcZHkzY3DRk3jzZK+gW+iL++nC0ezjpVb0J+9wxixI+uE7VRrfhMB0SnMuU/RDPpN2o8hrmaOhbSk/sgdbegLmUKrpKiYs/2BO1TpNHPIl34r1e1+YXbJTLLUi0C2hz7A/cQSEhfPbdXGgA+zoF26JtSrBZ0e47Nn63excK9Yl4wdJqJ+mrh/MnwY2AHT61Du/jdsNHMSgaWKfDo1+HzeoqQ3ZXO7H3/wEthz9rP6qT5vW+U08PAwJOvUbPvbVoEW9/DZR7vfGUMWgVejWFscAtd1TJPv9eDyDiKohBlFC2XVLd3+gmQFsUKIVJotq9WgcDG5OS6c1mQZnGL3siR10t6/HdmNhX7WjWW/WGb3Fqq1CXtk9KORFtjnpE+nJuHuIdYc6vAMXir8Rnt/UOtG7BLVgyqvs7bjD01DCWXKDWdnI3yY2McYDqtqoi60JwJwVD2dLdTBlBZkcjyZTv1GCniZHeirR2snpuknnaJtEvVJCcyw9KrVw/zoxi6l02tl3C93branOUbDFH1qbg8+CUWNAi9Fo5bGaQI2F9fT6a/jj/NDuAS/u1ezs5qYrSyZIobdGqfGaDcx//q8XD9/rF6KYTIVJjRpj45WXqSHTkK7Mbpfy0l11OlqD5NJnRcVbt2vx/fbdnvA6Xq9XG+fHxKjm33R+sy4fvLjzpykF4ddFQcYS2NNpxFikcd+kQeIyaNPHuct8iQQZzVFZdv3z+t32O78THzKfl/XvlWpWaH3vz+gtP2chDjiAMoImCzjRFnomEYVjw1V/zdU6siE/Ti3X4NI0IBy003a9wE1bmF7V6gyyWLYCd3Z/T4rivR0amJduyyJD/Jc/WmcUOI43MaxyccxpFQQmcoXp8EBE51QhpGQx4/O4/ibLVGvQXcC4a8xR8ZvoojaPF6MXAeF4k/pjh0T037eJCNdxeTtWzxs2cz76MiMcESGw06G97+nxv8L11NFpuGD6vztjz4cR1m4hGrdtKevT0LYRGSXKQcVgDQRW2DaY/1gXmJHPd53EXDTz+yodGMeUBxKGFdDhYFBKRArjlGgoabK1En17Pd3EH5FYs6ysleLXnwS1Ypifikij0U9DIMvI7GMxaQ6HT5vp6etTuETmO6JZUNnNdNye77GmH1czpBXkVg2tF7EZhPxEJIQI7v0QD1Afd5OD886x7wKhIaJCA8tEon/EvZdfCce8MCzxQnMZdWk3CQ8Pd954AVLYM5qMOX27PPlHU8tidUKLvutRurJogqCd2CX2hY1amd7FC3TuZzo2I7G/+oL6JNDpMgKnAY1dH57jk8wVn25qOFL9UEhaILtgYWSFI2qfn4e385Vy29w8XHziyywKqgxIUOMkEU0l2bXvt/P4xu3rCIDprTZ2oN6d/rPeiE9/xosQ66oyFfyobMJpJaa/rkVV0dfOZvAe5qQGhaOVRssu+FjqHo7YmlCIhOELI/xj2GQ0cUjlM1gHNnRjkA73Zdp9NIu29s9bY7trdg3JojwxFFthVYRj+qQFd0KKqmtT6NlGlmQQ1TxylR/QFotbH7smRQqjhviOKph5WZL3A2r1VsJr8Nuqihl32vVZUNyMDapsKwCWj5m+UrccWx5VZrV4D6ODjsTqjv1n1xnMoNJPUj+eTzfwUoJLMrVqYisP9ovk+M/l4GQoM4AEnH5AbdkRl7GRx20P4/XB3OTxcNENf7hz2/nzUw7cnesnzcbmjbGJSKdqur581xN3+1autvT5f2Nz2uW1JrV1LU/L9fvp+vTl+P9+dvTFoDAhTD/hepx6EJ6iQ0I22PZuln1C/x5PfPdK2QW6kUZiUVFJ1UE5Bwx5wmZrWa/WFh2cf/3P/74OH+c3s7vpz/+87/++3//9/8H6VKwGnwlCAA="; \ No newline at end of file diff --git a/docs/0.8.1/assets/style.css b/docs/0.8.1/assets/style.css new file mode 100644 index 000000000..98a437794 --- /dev/null +++ b/docs/0.8.1/assets/style.css @@ -0,0 +1,1414 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/0.8.1/classes/auth_couchdbSessionAuthenticator.CouchdbSessionAuthenticator.html b/docs/0.8.1/classes/auth_couchdbSessionAuthenticator.CouchdbSessionAuthenticator.html new file mode 100644 index 000000000..df628d72a --- /dev/null +++ b/docs/0.8.1/classes/auth_couchdbSessionAuthenticator.CouchdbSessionAuthenticator.html @@ -0,0 +1,28 @@ +CouchdbSessionAuthenticator | @ibm-cloud/cloudant - v0.8.1

The CouchdbSessionAuthenticator is used to get CouchDB session authentication information to + requests.

+

CouchDB Session Authenticator stores Authentication data in a Cookie Jar and +that will be used during a request. +The following token information are stored in the CookieJar.

+
Cookie-Content: AuthSession=<sessionToken>; Expires=<expirationDate>; Max-Age=<refreshmentTimeInSeconds>
Version=1; Path=/; HttpOnly; Secure +
+

Hierarchy

  • Authenticator
    • CouchdbSessionAuthenticator

Constructors

Properties

requiredOptions: ["username", "password"]
tokenManager: SessionTokenManager
AUTHTYPE_COUCHDB_SESSION: "COUCHDB_SESSION" = 'COUCHDB_SESSION'

Methods

  • Acquire a session token that will be stored in a Cookie Jar. +The same jar will be in use in the request.

    +

    Parameters

    • requestOptions: object

      The request to augment with authentication + information.

      +

    Returns Promise<void>

  • Returns the authenticator's type ('COUCHDB_SESSION').

    +

    Returns string

    a string that indicates the authenticator's type

    +
  • Configure the TokenManager to use all the request settings +together with the basic credentials.

    +

    Parameters

    • userOptions: UserOptions

      Configuration values for a request service.

      +

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/classes/auth_sessionTokenManager.SessionTokenManager.html b/docs/0.8.1/classes/auth_sessionTokenManager.SessionTokenManager.html new file mode 100644 index 000000000..e42e4bf87 --- /dev/null +++ b/docs/0.8.1/classes/auth_sessionTokenManager.SessionTokenManager.html @@ -0,0 +1,21 @@ +SessionTokenManager | @ibm-cloud/cloudant - v0.8.1

Token Manager of CouchDB session token.

+

The Token Manager performs basic auth with username and password +to acquire session tokens.

+

Hierarchy

  • TokenManager
    • SessionTokenManager

Constructors

Properties

requiredOptions: string[] = ...
tokenName: string

Methods

  • Request a session token using basic credentials.

    +

    Returns Promise<any>

  • Private

    From the response parse and save session token into field accessToken. +Calculate expiration and refresh time from the received response +and store them in fields expireTime and refreshTime.

    +

    Parameters

    • tokenResponse: any

      Response object from session token request

      +

    Returns void

  • Only base service specific headers are in use.

    +

    Parameters

    • headers: OutgoingHttpHeaders

      the new set of headers as an object

      +

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/classes/cloudant_features_changesFollower.ChangesFollower.html b/docs/0.8.1/classes/cloudant_features_changesFollower.ChangesFollower.html new file mode 100644 index 000000000..feb667aea --- /dev/null +++ b/docs/0.8.1/classes/cloudant_features_changesFollower.ChangesFollower.html @@ -0,0 +1,104 @@ +ChangesFollower | @ibm-cloud/cloudant - v0.8.1

A helper for using the changes feed.

+

There are two modes of operation:

+
    +
  • #startOneOff() to fetch the changes from the supplied since sequence +until there are no further pending changes.
  • +
  • #start() to fetch the changes from the supplied since sequence and +then continuing to listen indefinitely for further new changes.
  • +
+

The starting sequence ID can be changed for either mode by using +CloudantV1.PostChangesParams.since. By default when using:

+
    +
  • #startOneOff() the feed will start from the beginning.
  • +
  • #start() the feed will start from "now".
  • +
+

In either mode the Stream of changes can be terminated early by calling +#stop().

+

By default ChangesFollower will suppress transient errors indefinitely and +endeavour to run to completion or listen forever. For applications where that +behaviour is not desirable an alternate constructor is available where a +errorTolerance may be specified to limit the time since the last successful +response that transient errors will be suppressed.

+

It should be noted that errors considered terminal, for example, the database not +existing or invalid credentials are never suppressed and will throw an exception +immediately.

+

The CloudantV1.PostChangesParams model of changes feed options is used to configure +the behaviour of the ChangesFollower. However, a subset of the options are +invalid as they are configured internally by the implementation and will cause +an Error to be thrown if supplied. These invalid +options are:

+ +

Only the value of _selector is permitted for +the CloudantV1.PostChangesParams.filter option. +Selector based filters perform better than JS based filters and using one +of the alternative JS based +filter types will cause ChangesFollower to throw an Error.

+

It should also be noted that the CloudantV1.PostChangesParams.limit +parameter will truncate the stream at the given number of changes in either +operating mode.

+

The ChangesFollower requires the CloudantV1 client to have +HTTP call and read timeouts of at least 1 minute. The default client +configuration has sufficiently long timeouts.

+

Constructors

Properties

changesResultIterator: ChangesResultIterableIterator
client: export=
errorTolerance?: number
limit: number
BATCH_SIZE: number = 10_000

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/classes/cloudant_features_changesParamsHelper.ChangesParamsHelper.html b/docs/0.8.1/classes/cloudant_features_changesParamsHelper.ChangesParamsHelper.html new file mode 100644 index 000000000..c1bd0f0a4 --- /dev/null +++ b/docs/0.8.1/classes/cloudant_features_changesParamsHelper.ChangesParamsHelper.html @@ -0,0 +1,12 @@ +ChangesParamsHelper | @ibm-cloud/cloudant - v0.8.1

Constructors

Properties

LONGPOLL_TIMEOUT: number = ...

Set longpoll timeout to MIN_CLIENT_TIMEOUT - 3 second (= 3000 ms). +To give the changes request a chance to be answered before the client timeout +it is set to 3 seconds less.

+
MIN_CLIENT_TIMEOUT: number = 60_000

Set minimum client timeout to 1 minute (= 60 000 ms). +1 minute is the sort of number that very likely to be used as a client timeout, +so it makes sense to set as our minimum client timeout.

+

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/classes/cloudant_features_changesResultItemStream.ChangesResultItemStream.html b/docs/0.8.1/classes/cloudant_features_changesResultItemStream.ChangesResultItemStream.html new file mode 100644 index 000000000..0d8a28335 --- /dev/null +++ b/docs/0.8.1/classes/cloudant_features_changesResultItemStream.ChangesResultItemStream.html @@ -0,0 +1,6 @@ +ChangesResultItemStream | @ibm-cloud/cloudant - v0.8.1

Hierarchy (view full)

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/classes/cloudant_features_changesResultIterator.ChangesResultIterableIterator.html b/docs/0.8.1/classes/cloudant_features_changesResultIterator.ChangesResultIterableIterator.html new file mode 100644 index 000000000..9395682d5 --- /dev/null +++ b/docs/0.8.1/classes/cloudant_features_changesResultIterator.ChangesResultIterableIterator.html @@ -0,0 +1,31 @@ +ChangesResultIterableIterator | @ibm-cloud/cloudant - v0.8.1

Implements

Constructors

Properties

baseDelay: number = 100
cancel: ((error?) => void)

Type declaration

    • (error?): void
    • Parameters

      • Optional error: Error

      Returns void

cancelToken: "CloudantChangesIteratorCancel" = 'CloudantChangesIteratorCancel'
client: export=
countDown: number
doneResult: IteratorResult<ChangesResult, any> = ...
errorTolerance?: number
expRetryGate: number = ...
inflight: Promise<any> = null
logger: SDKLogger = ...
mode: Mode
pending: number = Number.MAX_VALUE
promisedConfig: Promise<void>
retry: number = 0
since: string
stopped: boolean = false
successTimestamp: number
timeoutPromise: (<T>(delay?, value?, options?) => Promise<T>) = ...

Type declaration

    • <T>(delay?, value?, options?): Promise<T>
    • import {
      setTimeout,
      } from 'timers/promises';

      const res = await setTimeout(100, 'result');

      console.log(res); // Prints 'result' +
      +

      Type Parameters

      • T = void

      Parameters

      • Optional delay: number

        The number of milliseconds to wait before fulfilling the promise.

        +
      • Optional value: T

        A value with which the promise is fulfilled.

        +
      • Optional options: TimerOptions

      Returns Promise<T>

      Since

      v15.0.0

      +
transientErrorSuppression: TransientErrorSuppression

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/classes/cloudant_features_stream.Stream.html b/docs/0.8.1/classes/cloudant_features_stream.Stream.html new file mode 100644 index 000000000..5f9887de1 --- /dev/null +++ b/docs/0.8.1/classes/cloudant_features_stream.Stream.html @@ -0,0 +1,4 @@ +Stream | @ibm-cloud/cloudant - v0.8.1

Type Parameters

  • T

Hierarchy (view full)

Constructors

Methods

Constructors

Methods

  • Parameters

    • chunk: T
    • Optional encoding: BufferEncoding

    Returns boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/classes/cloudant_v1.export_-1.html b/docs/0.8.1/classes/cloudant_v1.export_-1.html new file mode 100644 index 000000000..78962848d --- /dev/null +++ b/docs/0.8.1/classes/cloudant_v1.export_-1.html @@ -0,0 +1,584 @@ +export= | @ibm-cloud/cloudant - v0.8.1

NoSQL database based on Apache CouchDB

+

See: https://cloud.ibm.com/docs/services/Cloudant/

+

Hierarchy

  • default
    • export=

Constructors

Properties

Methods

configureService +createRequest +deleteAttachment +deleteDatabase +deleteDesignDocument +deleteDocument +deleteIndex +deleteLocalDocument +deleteReplicationDocument +getActiveTasks +getActivityTrackerEvents +getAllDbs +getAttachment +getCapacityThroughputInformation +getCorsInformation +getCurrentThroughputInformation +getDatabaseInformation +getDbUpdates +getDesignDocument +getDesignDocumentInformation +getDocument +getDocumentAsMixed +getDocumentAsRelated +getDocumentAsStream +getDocumentShardsInfo +getIndexesInformation +getLocalDocument +getMembershipInformation +getPartitionInformation +getReplicationDocument +getSchedulerDocs +getSchedulerDocument +getSchedulerJob +getSchedulerJobs +getSearchInfo +getSecurity +getServerInformation +getSessionInformation +getShardsInformation +getTimeout +getUpInformation +getUuids +headAttachment +headDatabase +headDesignDocument +headDocument +headLocalDocument +headReplicationDocument +headSchedulerDocument +headSchedulerJob +headUpInformation +postActivityTrackerEvents +postAllDocs +postAllDocsAsStream +postAllDocsQueries +postAllDocsQueriesAsStream +postApiKeys +postBulkDocs +postBulkGet +postBulkGetAsMixed +postBulkGetAsRelated +postBulkGetAsStream +postChanges +postChangesAsStream +postDbsInfo +postDesignDocs +postDesignDocsQueries +postDocument +postExplain +postFind +postFindAsStream +postIndex +postPartitionAllDocs +postPartitionAllDocsAsStream +postPartitionExplain +postPartitionFind +postPartitionFindAsStream +postPartitionSearch +postPartitionSearchAsStream +postPartitionView +postPartitionViewAsStream +postRevsDiff +postSearch +postSearchAnalyze +postSearchAsStream +postView +postViewAsStream +postViewQueries +postViewQueriesAsStream +putAttachment +putCapacityThroughputConfiguration +putCloudantSecurityConfiguration +putCorsConfiguration +putDatabase +putDesignDocument +putDocument +putLocalDocument +putReplicationDocument +putSecurity +setEnableGzipCompression +setServiceUrl +newInstance +

Constructors

  • Construct a CloudantV1 object.

    +

    Parameters

    • options: UserOptions

      Options for the service.

      +

    Returns export=

Properties

timeout: number
DEFAULT_SERVICE_NAME: string = 'cloudant'
DEFAULT_SERVICE_URL: string = 'http://localhost:5984'
_logger: SDKLogger = ...

Methods

  • Configure the service using external configuration +Cloudant specific extensions:

    +
      +
    • Apply the new base service options on CouchdbSessionAuthenticator.
    • +
    +

    Parameters

    • serviceName: string

      The name of the service. Will be used to read from external +configuration.

      +

    Returns void

  • Extend createRequest to handle document and attachment validation.

    +

    Parameters

    • parameters: any

    Returns Promise<any>

  • Delete an attachment.

    +

    Deletes the attachment with the filename, {attachment_name}, from the specified doc. You must supply the rev +query parameter or If-Match header with the current revision to delete the attachment.

    +

    Parameters

    Returns Promise<Response<DocumentResult>>

  • Delete a database.

    +

    Deletes the specified database and all documents and attachments contained within it. To avoid deleting a database, +the server responds with a 400 HTTP status code when the request URL includes a ?rev= parameter. This response +suggests that a user wanted to delete a document but forgot to add the document ID to the URL.

    +

    Parameters

    Returns Promise<Response<Ok>>

  • Delete a design document.

    +

    Marks the specified design document as deleted by adding a _deleted field with the value true. Documents with +this field are not returned with requests but stay in the database. You must supply the current (latest) revision, +either by using the rev parameter or by using the If-Match header to specify the revision.

    +

    Parameters

    Returns Promise<Response<DocumentResult>>

  • Delete a document.

    +

    Marks the specified document as deleted by adding a _deleted field with the value true. Documents with this +field are not returned within requests anymore but stay in the database. You must supply the current (latest) +revision, either by using the rev parameter or by using the If-Match header to specify the revision.

    +

    Parameters

    Returns Promise<Response<DocumentResult>>

  • Retrieve list of running tasks.

    +

    Lists running tasks, including the task type, name, status, and process ID. The result includes a JSON array of the +currently running tasks, with each task described as a single object. Depending on the operation type, the set of +response object fields might be different.

    +

    Parameters

    Returns Promise<Response<ActiveTask[]>>

  • Query a list of all database names in the instance.

    +

    Parameters

    Returns Promise<Response<string[]>>

  • Retrieve an attachment.

    +

    Returns the file attachment that is associated with the document. The raw data of the associated attachment is +returned, just as if you were accessing a static file. The returned Content-Type header is the same as the content +type set when the document attachment was submitted to the database.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Retrieve CORS configuration information.

    +

    Lists all Cross-origin resource sharing (CORS) configuration. CORS defines a way in which the browser and the +server interact to determine whether or not to allow the request.

    +

    Parameters

    Returns Promise<Response<CorsInformation>>

  • Retrieve change events for all databases.

    +

    This endpoint is not available in IBM Cloudant.

    +

    Lists changes to databases, like a global changes feed. Types of changes include updating the database and creating +or deleting a database. Like the changes feed, the feed is not guaranteed to return changes in the correct order +and might repeat changes. Polling modes for this method work like polling modes for the changes feed.

    +

    Parameters

    Returns Promise<Response<DbUpdates>>

    Deprecated

    this method is deprecated and may be removed in a future release

    +
  • Retrieve a document.

    +

    Returns document with the specified doc_id from the specified database. Unless you request a specific revision, +the latest revision of the document is always returned.

    +

    Parameters

    Returns Promise<Response<Document>>

  • Retrieve a document as mixed.

    +

    Returns document with the specified doc_id from the specified database. Unless you request a specific revision, +the latest revision of the document is always returned.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Retrieve a document as related.

    +

    Returns document with the specified doc_id from the specified database. Unless you request a specific revision, +the latest revision of the document is always returned.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Retrieve a document as stream.

    +

    Returns document with the specified doc_id from the specified database. Unless you request a specific revision, +the latest revision of the document is always returned.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Retrieve information about all indexes.

    +

    When you make a GET request to /db/_index, you get a list of all indexes used by Cloudant Query in the database, +including the primary index. In addition to the information available through this API, indexes are also stored in +the indexes property of design documents.

    +

    Parameters

    Returns Promise<Response<IndexesInformation>>

  • Retrieve a local document.

    +

    Retrieves the specified local document. The semantics are identical to accessing a standard document in the +specified database, except that the document is not replicated.

    +

    Parameters

    Returns Promise<Response<Document>>

  • Retrieve replication scheduler documents.

    +

    Lists replication documents, including information about all documents, even the ones in a completed or failed +state. For each document, the endpoint returns the document ID, database, replication ID, source and target, and +other information.

    +

    Parameters

    Returns Promise<Response<SchedulerDocsResult>>

  • Retrieve replication scheduler jobs.

    +

    Retrieves information about replications that were created via /_replicate endpoint, as well as those created +from replication documents. It doesn't include replications that completed or failed to start because replication +documents were malformed. Each job description includes source and target information, replication ID, history of +recent events, and other information.

    +

    Parameters

    Returns Promise<Response<SchedulerJobsResult>>

  • Retrieve database permissions information.

    +

    See who has permission to read, write, and manage the database. The credentials you use to log in to the dashboard +automatically include _admin permissions to all databases you create. Everyone and everything else, including +users you share databases with and API keys you create, must be given a permission level explicitly.

    +

    Parameters

    Returns Promise<Response<Security>>

  • Retrieve server instance information.

    +

    When you access the root of an instance, IBM Cloudant returns meta-information about the instance. The response +includes a JSON structure that contains information about the server, including a welcome message and the server's +version.

    +

    Tip: The authentication for this endpoint is only enforced when using IAM.

    +

    Parameters

    Returns Promise<Response<ServerInformation>>

  • Retrieve information about whether the server is up.

    +

    Confirms that the server is up, running, and ready to respond to requests. If maintenance_mode is true or +nolb, the endpoint returns a 404 response.

    +

    Tip: The authentication for this endpoint is only enforced when using IAM.

    +

    Parameters

    Returns Promise<Response<UpInformation>>

  • Retrieve one or more UUIDs.

    +

    Requests one or more Universally Unique Identifiers (UUIDs) from the instance. The response is a JSON object that +provides a list of UUIDs.

    +

    Tip: The authentication for this endpoint is only enforced when using IAM.

    +

    Parameters

    • Optional params: GetUuidsParams

      The parameters to send to the service.

      +

    Returns Promise<Response<UuidsResult>>

  • Retrieve the HTTP headers for an attachment.

    +

    Returns the HTTP headers that contain a minimal amount of information about the specified attachment. This method +supports the same query arguments as the GET /{db}/{doc_id}/{attachment_name} method, but only the header +information (including attachment size, encoding, and the MD5 hash as an ETag), is returned.

    +

    Parameters

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for a database.

    +

    Returns the HTTP headers that contain a minimal amount of information about the specified database. Since the +response body is empty, using the HEAD method is a lightweight way to check if the database exists or not.

    +

    Parameters

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for a design document.

    +

    This method supports the same query arguments as the GET /{db}/_design/{ddoc} method, but the results include +only the header information (including design document size, and the revision as an ETag). The ETag header shows +the current revision for the requested design document, and if you requested the design document in full, the +Content-Length specifies the length of the data. If you add any of the query arguments, then the resulting HTTP +headers correspond to what is returned for the equivalent GET request.

    +

    Parameters

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for the document.

    +

    This method supports the same query arguments as the GET /{db}/{docid} method, but only the header information +(including document size and the revision as an ETag) is returned. The ETag header shows the current revision for +the requested document, and the Content-Length specifies the length of the data if the document was requested in +full. Add any of the query arguments, then the resulting HTTP headers that correspond to it are returned.

    +

    Parameters

    Returns Promise<Response<EmptyObject>>

  • Retrieve HTTP headers for a local document.

    +

    Retrieves the HTTP headers containing minimal amount of information about the specified local document. Since the +response body is empty, using the HEAD method is a lightweight way to check if the local document exists or not.

    +

    Parameters

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for a replication document.

    +

    Retrieves the HTTP headers containing minimal amount of information about the specified replication document from +the _replicator database. The method supports the same query arguments as the GET /_replicator/{doc_id} +method, but only headers like content length and the revision (ETag header) are returned.

    +

    Parameters

    Returns Promise<Response<EmptyObject>>

  • Retrieve HTTP headers for a replication scheduler document.

    +

    Retrieves the HTTP headers containing minimal amount of information about the specified replication scheduler +document. Since the response body is empty, using the HEAD method is a lightweight way to check if the replication +scheduler document exists or not.

    +

    Parameters

    Returns Promise<Response<EmptyObject>>

  • Retrieve the HTTP headers for a replication scheduler job.

    +

    Returns the HTTP headers that contain a minimal amount of information about the specified replication task. Only +the header information is returned.

    +

    Parameters

    Returns Promise<Response<EmptyObject>>

  • Modify Activity Tracker events configuration.

    +

    Configure event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.

    +

    Parameters

    Returns Promise<Response<Ok>>

  • Query a list of all documents in a database.

    +

    Queries the primary index (all document IDs). The results that match the request body parameters are returned in a +JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no +request body parameters are specified, results for all documents in the database are returned. Optionally, document +content or additional metadata can be included in the response.

    +

    Parameters

    Returns Promise<Response<AllDocsResult>>

  • Query a list of all documents in a database as stream.

    +

    Queries the primary index (all document IDs). The results that match the request body parameters are returned in a +JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no +request body parameters are specified, results for all documents in the database are returned. Optionally, document +content or additional metadata can be included in the response.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Multi-query the list of all documents in a database.

    +

    Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of +result objects, one for each query, with a structure equivalent to that of a single _all_docs request. This +enables you to request multiple queries in a single request, in place of multiple POST /{db}/_all_docs requests.

    +

    Parameters

    Returns Promise<Response<AllDocsQueriesResult>>

  • Multi-query the list of all documents in a database as stream.

    +

    Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of +result objects, one for each query, with a structure equivalent to that of a single _all_docs request. This +enables you to request multiple queries in a single request, in place of multiple POST /{db}/_all_docs requests.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Generates API keys for apps or persons to enable database access.

    +

    Generates API keys to enable database access for a person or application, but without creating a new IBM Cloudant +account for that person or application. An API key is a randomly generated username and password. The key is given +the wanted access permissions for a database.

    +

    Parameters

    Returns Promise<Response<ApiKeysResult>>

  • Bulk modify multiple documents in a database.

    +

    The bulk document API allows you to create, update, and delete multiple documents at the same time within a single +request. The basic operation is similar to creating, updating, or deleting a single document, except that you batch +the document structure and information.

    +

    Parameters

    Returns Promise<Response<DocumentResult[]>>

  • Bulk query revision information for multiple documents as mixed.

    +

    Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Bulk query revision information for multiple documents as related.

    +

    Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Bulk query revision information for multiple documents as stream.

    +

    Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Query the database document changes feed.

    +

    Requests the database changes feed in the same way as GET /{db}/_changes does. It is widely used with the +filter query parameter because it allows one to pass more information to the filter.

    +

    Note

    Before using the changes feed we recommend reading the +FAQs to understand the limitations and +appropriate use cases.

    +

    Parameters

    Returns Promise<Response<ChangesResult>>

  • Query the database document changes feed as stream.

    +

    Requests the database changes feed in the same way as GET /{db}/_changes does. It is widely used with the +filter query parameter because it allows one to pass more information to the filter.

    +

    Note

    Before using the changes feed we recommend reading the +FAQs to understand the limitations and +appropriate use cases.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Query information about multiple databases.

    +

    This operation enables you to request information about multiple databases in a single request, instead of issuing +multiple GET /{db} requests. It returns a list that contains an information object for each database specified in +the request.

    +

    Parameters

    Returns Promise<Response<DbsInfoResult[]>>

  • Query a list of all design documents in a database.

    +

    Queries the index of all design document IDs. The results matching the request body parameters are returned in a +JSON object, including a list of matching design documents with basic contents, such as the ID and revision. When +no request body parameters are specified, results for all design documents in the database are returned. +Optionally, the design document content or additional metadata can be included in the response.

    +

    Parameters

    Returns Promise<Response<AllDocsResult>>

  • Create or modify a document in a database.

    +

    Creates or modifies a document in the specified database by using the supplied JSON document.

    +

    For creation, you may specify the document ID but you should not specify the revision. If you don't specify the +document ID, then the server generates an ID for your document.

    +

    For modification, you must specify the document ID and a revision identifier in the JSON document.

    +

    If your document ID includes the _local/ or _design/ prefix, then this operation creates or modifies a local or +a design document respectively.

    +

    Parameters

    Returns Promise<Response<DocumentResult>>

  • Query an index by using selector syntax.

    +

    Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for +all fields in selector by using the _index endpoint.

    +

    Queries without an appropriate backing index will fallback to using the built-in _all_docs index. This is not +recommended because it has a significant performance impact causing a full scan of the database with each request. +In this case the response body will include a warning field recommending that an index is created.

    +

    Parameters

    Returns Promise<Response<FindResult>>

  • Query an index by using selector syntax as stream.

    +

    Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for +all fields in selector by using the _index endpoint.

    +

    Queries without an appropriate backing index will fallback to using the built-in _all_docs index. This is not +recommended because it has a significant performance impact causing a full scan of the database with each request. +In this case the response body will include a warning field recommending that an index is created.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Query a list of all documents in a database partition.

    +

    Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON +object, including a list of matching documents with basic contents, such as the ID and revision. When no query +parameters are specified, results for all documents in the database partition are returned. Optionally, document +content or additional metadata can be included in the response.

    +

    Parameters

    Returns Promise<Response<AllDocsResult>>

  • Query a list of all documents in a database partition as stream.

    +

    Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON +object, including a list of matching documents with basic contents, such as the ID and revision. When no query +parameters are specified, results for all documents in the database partition are returned. Optionally, document +content or additional metadata can be included in the response.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Query a database partition index by using selector syntax.

    +

    Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for +all fields in selector by using the _index endpoint.

    +

    Queries without an appropriate backing index will fallback to using the built-in _all_docs index. This is not +recommended because it has a noticeable performance impact causing a full scan of the partition with each request. +In this case the response body will include a warning field recommending that an index is created.

    +

    Parameters

    Returns Promise<Response<FindResult>>

  • Query a database partition index by using selector syntax as stream.

    +

    Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for +all fields in selector by using the _index endpoint.

    +

    Queries without an appropriate backing index will fallback to using the built-in _all_docs index. This is not +recommended because it has a noticeable performance impact causing a full scan of the partition with each request. +In this case the response body will include a warning field recommending that an index is created.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Query a database partition search index.

    +

    Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using +Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce +views. The index function decides what data to index and store in the index.

    +

    Parameters

    Returns Promise<Response<SearchResult>>

  • Query a database partition search index as stream.

    +

    Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using +Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce +views. The index function decides what data to index and store in the index.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Query a database partition MapReduce view function.

    +

    Runs the specified view function from the specified design document. Unlike GET /{db}/_design/{ddoc}/_view/{view} +for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view +results. The remainder of the POST view functionality is identical to the GET /{db}/_design/{ddoc}/_view/{view} +API.

    +

    Parameters

    Returns Promise<Response<ViewResult>>

  • Query a database partition MapReduce view function as stream.

    +

    Runs the specified view function from the specified design document. Unlike GET /{db}/_design/{ddoc}/_view/{view} +for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view +results. The remainder of the POST view functionality is identical to the GET /{db}/_design/{ddoc}/_view/{view} +API.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Query the document revisions and possible ancestors missing from the database.

    +

    The replicator is the primary user of this operation. After receiving a set of new revision IDs from the source +database, the replicator sends this set to the destination database's _revs_diff to find out which of them +already exists there. It can then avoid fetching and sending already-known document bodies.

    +

    Parameters

    Returns Promise<Response<JsonObject>>

  • Query a search index.

    +

    Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser +Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function +decides what data to index and what data to store in the index. The advantage of using the HTTP POST method is +that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query +options as URL query parameters of a GET request.

    +

    Parameters

    Returns Promise<Response<SearchResult>>

  • Query a search index as stream.

    +

    Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser +Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function +decides what data to index and what data to store in the index. The advantage of using the HTTP POST method is +that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query +options as URL query parameters of a GET request.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Query a MapReduce view.

    +

    This operation queries the specified MapReduce view of the specified design document. By default, the map and +reduce functions of the view are run to update the view before returning the response. The advantage of using the +HTTP POST method is that the query is submitted as a JSON object in the request body. This avoids the limitations +of passing query options as URL query parameters of a GET request.

    +

    Parameters

    Returns Promise<Response<ViewResult>>

  • Query a MapReduce view as stream.

    +

    This operation queries the specified MapReduce view of the specified design document. By default, the map and +reduce functions of the view are run to update the view before returning the response. The advantage of using the +HTTP POST method is that the query is submitted as a JSON object in the request body. This avoids the limitations +of passing query options as URL query parameters of a GET request.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Multi-query a MapReduce view as stream.

    +

    This operation runs multiple specified view queries against the view function from the specified design document.

    +

    Parameters

    Returns Promise<Response<ReadableStream>>

  • Create or modify an attachment.

    +

    Uploads the supplied content as an attachment to the specified document. The attachment name that you provide must +be a URL encoded string. You must supply the Content-Type header, and for an existing document, you must also +supply either the rev query argument or the If-Match HTTP header. If you omit the revision, a new, otherwise +empty, document is created with the provided attachment, or a conflict occurs. If the uploaded attachment uses an +existing attachment name in the remote database, it updates the corresponding stored content of the database. Since +you must supply the revision information to add an attachment to the document, this serves as validation to update +the existing attachment.

    +

    Parameters

    Returns Promise<Response<DocumentResult>>

  • Modify only Cloudant related database permissions.

    +

    Modify only Cloudant related permissions to database. Be careful: by removing an API key from the list, you remove +the API key from the list of users that have access to the database.

    +

    Note about nobody role

    The nobody username applies to all unauthenticated connection attempts. For example, if an application tries to +read data from a database, but did not identify itself, the task can continue only if the nobody user has the +role _reader.

    +

    Parameters

    Returns Promise<Response<Ok>>

  • Modify CORS configuration.

    +

    Sets the CORS configuration. The configuration applies to all databases and all account level endpoints in your +account.

    +

    Parameters

    Returns Promise<Response<Ok>>

  • Create or modify a document.

    +

    Creates or modifies a document in the specified database.

    +

    For creation, you must specify the document ID but you should not specify the revision.

    +

    For modification, you must specify the document ID and a revision identifier.

    +

    Parameters

    Returns Promise<Response<DocumentResult>>

  • Modify database permissions.

    +

    Modify who has permission to read, write, or manage a database. This endpoint can be used to modify both Cloudant +and CouchDB related permissions. Be careful: by removing a Cloudant API key, a member or an admin from the list of +users that have access permissions, you remove it from the list of users that have access to the database.

    +

    Note about nobody role

    The nobody username applies to all unauthenticated connection attempts. For example, if an application tries to +read data from a database, but did not identify itself, the task can continue only if the nobody user has the +role _reader.

    +

    Parameters

    Returns Promise<Response<Ok>>

  • Turn request body compression on or off. +Cloudant specific extensions:

    +
      +
    • Apply the gzip compression option on CouchdbSessionAuthenticator.
    • +
    +

    Parameters

    • setting: boolean

      Will turn it on if 'true', off if 'false'.

      +

    Returns void

  • Set the service URL to send requests to and +use the new service URL for CouchDB Session Authentication +to claim session token from.

    +

    Parameters

    • url: string

      The base URL for the service.

      +

    Returns void

  • Constructs an instance of CloudantV1 with passed in options and external configuration.

    +

    Parameters

    • Optional options: UserOptions

      The parameters to send to the service.

      +

    Returns export=

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_features_changesFollower.Mode.html b/docs/0.8.1/enums/cloudant_features_changesFollower.Mode.html new file mode 100644 index 000000000..bdd2a09c4 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_features_changesFollower.Mode.html @@ -0,0 +1,3 @@ +Mode | @ibm-cloud/cloudant - v0.8.1

Enumeration Members

Enumeration Members

FINITE: 0
LISTEN: 1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.ActiveTask.Constants.Phase.html b/docs/0.8.1/enums/cloudant_v1.export_.ActiveTask.Constants.Phase.html new file mode 100644 index 000000000..10ce06df4 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.ActiveTask.Constants.Phase.html @@ -0,0 +1,7 @@ +Phase | @ibm-cloud/cloudant - v0.8.1

The phase the active task is in. docid_sort, docid_copy, document_copy phases are available for database_compaction, while ids and view phases are available for view_compaction type tasks.

+

Enumeration Members

Enumeration Members

DOCID_COPY: "docid_copy"
DOCID_SORT: "docid_sort"
DOCUMENT_COPY: "document_copy"
IDS: "ids"
VIEW: "view"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.ActiveTask.Constants.ProcessStatus.html b/docs/0.8.1/enums/cloudant_v1.export_.ActiveTask.Constants.ProcessStatus.html new file mode 100644 index 000000000..d1ef3e294 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.ActiveTask.Constants.ProcessStatus.html @@ -0,0 +1,8 @@ +ProcessStatus | @ibm-cloud/cloudant - v0.8.1

Process status.

+

Enumeration Members

EXITING: "exiting"
GARBAGE_COLLECTING: "garbage_collecting"
RUNNABLE: "runnable"
RUNNING: "running"
SUSPENDED: "suspended"
WAITING: "waiting"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.ActiveTask.Constants.Type.html b/docs/0.8.1/enums/cloudant_v1.export_.ActiveTask.Constants.Type.html new file mode 100644 index 000000000..3c1cf4a14 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.ActiveTask.Constants.Type.html @@ -0,0 +1,7 @@ +Type | @ibm-cloud/cloudant - v0.8.1

Operation type.

+

Enumeration Members

DATABASE_COMPACTION: "database_compaction"
INDEXER: "indexer"
REPLICATION: "replication"
SEARCH_INDEXER: "search_indexer"
VIEW_COMPACTION: "view_compaction"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.ActivityTrackerEvents.Constants.Types.html b/docs/0.8.1/enums/cloudant_v1.export_.ActivityTrackerEvents.Constants.Types.html new file mode 100644 index 000000000..8d33f7d19 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.ActivityTrackerEvents.Constants.Types.html @@ -0,0 +1,4 @@ +Types | @ibm-cloud/cloudant - v0.8.1

An array of event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance. "management" is a required element of this array.

+

Enumeration Members

Enumeration Members

DATA: "data"
MANAGEMENT: "management"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.Analyzer.Constants.Name.html b/docs/0.8.1/enums/cloudant_v1.export_.Analyzer.Constants.Name.html new file mode 100644 index 000000000..52a88c0a9 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.Analyzer.Constants.Name.html @@ -0,0 +1,43 @@ +Name | @ibm-cloud/cloudant - v0.8.1

Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies depending on the analyzer usage: * For search indexes the default is standard * For query text indexes the default is keyword * For a query text index default_field the default is standard.

+

Enumeration Members

ARABIC: "arabic"
ARMENIAN: "armenian"
BASQUE: "basque"
BRAZILIAN: "brazilian"
BULGARIAN: "bulgarian"
CATALAN: "catalan"
CHINESE: "chinese"
CJK: "cjk"
CLASSIC: "classic"
CZECH: "czech"
DANISH: "danish"
DUTCH: "dutch"
EMAIL: "email"
ENGLISH: "english"
FINNISH: "finnish"
FRENCH: "french"
GALICIAN: "galician"
GERMAN: "german"
GREEK: "greek"
HINDI: "hindi"
HUNGARIAN: "hungarian"
INDONESIAN: "indonesian"
IRISH: "irish"
ITALIAN: "italian"
JAPANESE: "japanese"
KEYWORD: "keyword"
LATVIAN: "latvian"
NORWEGIAN: "norwegian"
PERFIELD: "perfield"
PERSIAN: "persian"
POLISH: "polish"
PORTUGUESE: "portuguese"
ROMANIAN: "romanian"
RUSSIAN: "russian"
SIMPLE: "simple"
SPANISH: "spanish"
STANDARD: "standard"
SWEDISH: "swedish"
THAI: "thai"
TURKISH: "turkish"
WHITESPACE: "whitespace"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.AnalyzerConfiguration.Constants.Name.html b/docs/0.8.1/enums/cloudant_v1.export_.AnalyzerConfiguration.Constants.Name.html new file mode 100644 index 000000000..4755125ad --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.AnalyzerConfiguration.Constants.Name.html @@ -0,0 +1,43 @@ +Name | @ibm-cloud/cloudant - v0.8.1

Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies depending on the analyzer usage: * For search indexes the default is standard * For query text indexes the default is keyword * For a query text index default_field the default is standard.

+

Enumeration Members

ARABIC: "arabic"
ARMENIAN: "armenian"
BASQUE: "basque"
BRAZILIAN: "brazilian"
BULGARIAN: "bulgarian"
CATALAN: "catalan"
CHINESE: "chinese"
CJK: "cjk"
CLASSIC: "classic"
CZECH: "czech"
DANISH: "danish"
DUTCH: "dutch"
EMAIL: "email"
ENGLISH: "english"
FINNISH: "finnish"
FRENCH: "french"
GALICIAN: "galician"
GERMAN: "german"
GREEK: "greek"
HINDI: "hindi"
HUNGARIAN: "hungarian"
INDONESIAN: "indonesian"
IRISH: "irish"
ITALIAN: "italian"
JAPANESE: "japanese"
KEYWORD: "keyword"
LATVIAN: "latvian"
NORWEGIAN: "norwegian"
PERFIELD: "perfield"
PERSIAN: "persian"
POLISH: "polish"
PORTUGUESE: "portuguese"
ROMANIAN: "romanian"
RUSSIAN: "russian"
SIMPLE: "simple"
SPANISH: "spanish"
STANDARD: "standard"
SWEDISH: "swedish"
THAI: "thai"
TURKISH: "turkish"
WHITESPACE: "whitespace"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.DbEvent.Constants.Type.html b/docs/0.8.1/enums/cloudant_v1.export_.DbEvent.Constants.Type.html new file mode 100644 index 000000000..afcbfbd84 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.DbEvent.Constants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.8.1

A database event.

+

Enumeration Members

Enumeration Members

CREATED: "created"
DELETED: "deleted"
UPDATED: "updated"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.DeleteAttachmentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.DeleteAttachmentConstants.Batch.html new file mode 100644 index 000000000..c14b91f5d --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.DeleteAttachmentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.DeleteDesignDocumentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.DeleteDesignDocumentConstants.Batch.html new file mode 100644 index 000000000..5b2f1a3de --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.DeleteDesignDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.DeleteDocumentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.DeleteDocumentConstants.Batch.html new file mode 100644 index 000000000..6378f0cb2 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.DeleteDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.DeleteIndexConstants.Type.html b/docs/0.8.1/enums/cloudant_v1.export_.DeleteIndexConstants.Type.html new file mode 100644 index 000000000..015043c62 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.DeleteIndexConstants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.8.1

Path parameter to specify the index type.

+

Enumeration Members

Enumeration Members

JSON: "json"
SPECIAL: "special"
TEXT: "text"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.DeleteLocalDocumentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.DeleteLocalDocumentConstants.Batch.html new file mode 100644 index 000000000..2a025d3f5 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.DeleteLocalDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.DeleteReplicationDocumentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.DeleteReplicationDocumentConstants.Batch.html new file mode 100644 index 000000000..3fd5fd6a3 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.DeleteReplicationDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.DocumentRevisionStatus.Constants.Status.html b/docs/0.8.1/enums/cloudant_v1.export_.DocumentRevisionStatus.Constants.Status.html new file mode 100644 index 000000000..b0340a7bc --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.DocumentRevisionStatus.Constants.Status.html @@ -0,0 +1,5 @@ +Status | @ibm-cloud/cloudant - v0.8.1

Status of the revision. May be one of: - available: Revision is available for retrieving with rev query parameter - missing: Revision is not available - deleted: Revision belongs to deleted document.

+

Enumeration Members

Enumeration Members

AVAILABLE: "available"
DELETED: "deleted"
MISSING: "missing"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.ExplainResultMrArgs.Constants.ViewType.html b/docs/0.8.1/enums/cloudant_v1.export_.ExplainResultMrArgs.Constants.ViewType.html new file mode 100644 index 000000000..09545af05 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.ExplainResultMrArgs.Constants.ViewType.html @@ -0,0 +1,4 @@ +ViewType | @ibm-cloud/cloudant - v0.8.1

The type of the underlying view.

+

Enumeration Members

Enumeration Members

MAP: "map"
REDUCE: "reduce"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.GetDbUpdatesConstants.Feed.html b/docs/0.8.1/enums/cloudant_v1.export_.GetDbUpdatesConstants.Feed.html new file mode 100644 index 000000000..b63970014 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.GetDbUpdatesConstants.Feed.html @@ -0,0 +1,6 @@ +Feed | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify the changes feed type.

+

Enumeration Members

Enumeration Members

CONTINUOUS: "continuous"
EVENTSOURCE: "eventsource"
LONGPOLL: "longpoll"
NORMAL: "normal"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.GetLocalDocumentConstants.Accept.html b/docs/0.8.1/enums/cloudant_v1.export_.GetLocalDocumentConstants.Accept.html new file mode 100644 index 000000000..76ab31638 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.GetLocalDocumentConstants.Accept.html @@ -0,0 +1,6 @@ +Accept | @ibm-cloud/cloudant - v0.8.1

The type of the response: application/json, multipart/mixed, multipart/related, or application/octet-stream.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"
MULTIPART_MIXED: "multipart/mixed"
MULTIPART_RELATED: "multipart/related"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.GetSchedulerDocsConstants.States.html b/docs/0.8.1/enums/cloudant_v1.export_.GetSchedulerDocsConstants.States.html new file mode 100644 index 000000000..6cbe4ce8c --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.GetSchedulerDocsConstants.States.html @@ -0,0 +1,9 @@ +States | @ibm-cloud/cloudant - v0.8.1

Query parameter to include only replication documents in the specified states. String must be a comma-delimited string.

+

Enumeration Members

COMPLETED: "completed"
CRASHING: "crashing"
ERROR: "error"
FAILED: "failed"
INITIALIZING: "initializing"
PENDING: "pending"
RUNNING: "running"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.IndexField.Constants.Type.html b/docs/0.8.1/enums/cloudant_v1.export_.IndexField.Constants.Type.html new file mode 100644 index 000000000..5a75b0f91 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.IndexField.Constants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.8.1

The type of the named field.

+

Enumeration Members

Enumeration Members

BOOLEAN: "boolean"
NUMBER: "number"
STRING: "string"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.IndexInformation.Constants.Type.html b/docs/0.8.1/enums/cloudant_v1.export_.IndexInformation.Constants.Type.html new file mode 100644 index 000000000..eae34fb21 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.IndexInformation.Constants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.8.1

Schema for the type of an index.

+

Enumeration Members

Enumeration Members

JSON: "json"
SPECIAL: "special"
TEXT: "text"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.IndexResult.Constants.Result.html b/docs/0.8.1/enums/cloudant_v1.export_.IndexResult.Constants.Result.html new file mode 100644 index 000000000..6d07e90d6 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.IndexResult.Constants.Result.html @@ -0,0 +1,4 @@ +Result | @ibm-cloud/cloudant - v0.8.1

Flag to show whether the index was created or one already exists.

+

Enumeration Members

Enumeration Members

CREATED: "created"
EXISTS: "exists"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostActivityTrackerEventsConstants.Types.html b/docs/0.8.1/enums/cloudant_v1.export_.PostActivityTrackerEventsConstants.Types.html new file mode 100644 index 000000000..a1d649bc0 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostActivityTrackerEventsConstants.Types.html @@ -0,0 +1,4 @@ +Types | @ibm-cloud/cloudant - v0.8.1

Types

+

Enumeration Members

Enumeration Members

DATA: "data"
MANAGEMENT: "management"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostChangesAsStreamConstants.Feed.html b/docs/0.8.1/enums/cloudant_v1.export_.PostChangesAsStreamConstants.Feed.html new file mode 100644 index 000000000..dc4c9883f --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostChangesAsStreamConstants.Feed.html @@ -0,0 +1,6 @@ +Feed | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify the changes feed type.

+

Enumeration Members

Enumeration Members

CONTINUOUS: "continuous"
EVENTSOURCE: "eventsource"
LONGPOLL: "longpoll"
NORMAL: "normal"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostChangesConstants.Feed.html b/docs/0.8.1/enums/cloudant_v1.export_.PostChangesConstants.Feed.html new file mode 100644 index 000000000..ee497dfba --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostChangesConstants.Feed.html @@ -0,0 +1,6 @@ +Feed | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify the changes feed type.

+

Enumeration Members

Enumeration Members

CONTINUOUS: "continuous"
EVENTSOURCE: "eventsource"
LONGPOLL: "longpoll"
NORMAL: "normal"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostDesignDocsConstants.Accept.html b/docs/0.8.1/enums/cloudant_v1.export_.PostDesignDocsConstants.Accept.html new file mode 100644 index 000000000..3cde5b290 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostDesignDocsConstants.Accept.html @@ -0,0 +1,4 @@ +Accept | @ibm-cloud/cloudant - v0.8.1

The type of the response: application/json or application/octet-stream.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostDesignDocsQueriesConstants.Accept.html b/docs/0.8.1/enums/cloudant_v1.export_.PostDesignDocsQueriesConstants.Accept.html new file mode 100644 index 000000000..60dcf7d21 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostDesignDocsQueriesConstants.Accept.html @@ -0,0 +1,4 @@ +Accept | @ibm-cloud/cloudant - v0.8.1

The type of the response: application/json or application/octet-stream.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostDocumentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.PostDocumentConstants.Batch.html new file mode 100644 index 000000000..cb77f1237 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostDocumentConstants.ContentType.html b/docs/0.8.1/enums/cloudant_v1.export_.PostDocumentConstants.ContentType.html new file mode 100644 index 000000000..9f8235866 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostDocumentConstants.ContentType.html @@ -0,0 +1,6 @@ +ContentType | @ibm-cloud/cloudant - v0.8.1

The type of the input.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"
MULTIPART_MIXED: "multipart/mixed"
MULTIPART_RELATED: "multipart/related"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostExplainConstants.Sort.html b/docs/0.8.1/enums/cloudant_v1.export_.PostExplainConstants.Sort.html new file mode 100644 index 000000000..9160a62c3 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostExplainConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.8.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostExplainConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostExplainConstants.Update.html new file mode 100644 index 000000000..f8808b56a --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostExplainConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostFindAsStreamConstants.Sort.html b/docs/0.8.1/enums/cloudant_v1.export_.PostFindAsStreamConstants.Sort.html new file mode 100644 index 000000000..69f357a84 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostFindAsStreamConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.8.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostFindAsStreamConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostFindAsStreamConstants.Update.html new file mode 100644 index 000000000..419bed0c2 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostFindAsStreamConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostFindConstants.Sort.html b/docs/0.8.1/enums/cloudant_v1.export_.PostFindConstants.Sort.html new file mode 100644 index 000000000..f9cc9bed6 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostFindConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.8.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostFindConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostFindConstants.Update.html new file mode 100644 index 000000000..f9ac04ed3 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostFindConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostIndexConstants.Type.html b/docs/0.8.1/enums/cloudant_v1.export_.PostIndexConstants.Type.html new file mode 100644 index 000000000..607e54b53 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostIndexConstants.Type.html @@ -0,0 +1,5 @@ +Type | @ibm-cloud/cloudant - v0.8.1

Schema for the type of an index.

+

Enumeration Members

Enumeration Members

JSON: "json"
SPECIAL: "special"
TEXT: "text"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionExplainConstants.Sort.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionExplainConstants.Sort.html new file mode 100644 index 000000000..8af6a874a --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionExplainConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.8.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionExplainConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionExplainConstants.Update.html new file mode 100644 index 000000000..cb7cc75e3 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionExplainConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindAsStreamConstants.Sort.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindAsStreamConstants.Sort.html new file mode 100644 index 000000000..5cc462712 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindAsStreamConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.8.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindAsStreamConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindAsStreamConstants.Update.html new file mode 100644 index 000000000..f09b2ed84 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindAsStreamConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindConstants.Sort.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindConstants.Sort.html new file mode 100644 index 000000000..0a29d1be5 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindConstants.Sort.html @@ -0,0 +1,4 @@ +Sort | @ibm-cloud/cloudant - v0.8.1

Schema for a mapping of field name to sort direction.

+

Enumeration Members

Enumeration Members

ASC: "asc"
DESC: "desc"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindConstants.Update.html new file mode 100644 index 000000000..f681ce7f2 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionFindConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Whether to update the index prior to returning the result.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionSearchAsStreamConstants.Stale.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionSearchAsStreamConstants.Stale.html new file mode 100644 index 000000000..384025572 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionSearchAsStreamConstants.Stale.html @@ -0,0 +1,3 @@ +Stale | @ibm-cloud/cloudant - v0.8.1

Do not wait for the index to finish building to return results.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionSearchConstants.Stale.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionSearchConstants.Stale.html new file mode 100644 index 000000000..dcd051f7d --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionSearchConstants.Stale.html @@ -0,0 +1,3 @@ +Stale | @ibm-cloud/cloudant - v0.8.1

Do not wait for the index to finish building to return results.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionViewAsStreamConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionViewAsStreamConstants.Update.html new file mode 100644 index 000000000..c2ad0175e --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionViewAsStreamConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionViewConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionViewConstants.Update.html new file mode 100644 index 000000000..388109193 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostPartitionViewConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostSearchAnalyzeConstants.Analyzer.html b/docs/0.8.1/enums/cloudant_v1.export_.PostSearchAnalyzeConstants.Analyzer.html new file mode 100644 index 000000000..64ed036b1 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostSearchAnalyzeConstants.Analyzer.html @@ -0,0 +1,42 @@ +Analyzer | @ibm-cloud/cloudant - v0.8.1

The analyzer type that is being used at the tokenization.

+

Enumeration Members

ARABIC: "arabic"
ARMENIAN: "armenian"
BASQUE: "basque"
BRAZILIAN: "brazilian"
BULGARIAN: "bulgarian"
CATALAN: "catalan"
CHINESE: "chinese"
CJK: "cjk"
CLASSIC: "classic"
CZECH: "czech"
DANISH: "danish"
DUTCH: "dutch"
EMAIL: "email"
ENGLISH: "english"
FINNISH: "finnish"
FRENCH: "french"
GALICIAN: "galician"
GERMAN: "german"
GREEK: "greek"
HINDI: "hindi"
HUNGARIAN: "hungarian"
INDONESIAN: "indonesian"
IRISH: "irish"
ITALIAN: "italian"
JAPANESE: "japanese"
KEYWORD: "keyword"
LATVIAN: "latvian"
NORWEGIAN: "norwegian"
PERSIAN: "persian"
POLISH: "polish"
PORTUGUESE: "portuguese"
ROMANIAN: "romanian"
RUSSIAN: "russian"
SIMPLE: "simple"
SPANISH: "spanish"
STANDARD: "standard"
SWEDISH: "swedish"
THAI: "thai"
TURKISH: "turkish"
WHITESPACE: "whitespace"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostSearchAsStreamConstants.Stale.html b/docs/0.8.1/enums/cloudant_v1.export_.PostSearchAsStreamConstants.Stale.html new file mode 100644 index 000000000..7582aa5ae --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostSearchAsStreamConstants.Stale.html @@ -0,0 +1,3 @@ +Stale | @ibm-cloud/cloudant - v0.8.1

Do not wait for the index to finish building to return results.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostSearchConstants.Stale.html b/docs/0.8.1/enums/cloudant_v1.export_.PostSearchConstants.Stale.html new file mode 100644 index 000000000..9af85c417 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostSearchConstants.Stale.html @@ -0,0 +1,3 @@ +Stale | @ibm-cloud/cloudant - v0.8.1

Do not wait for the index to finish building to return results.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostViewAsStreamConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostViewAsStreamConstants.Update.html new file mode 100644 index 000000000..475f19279 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostViewAsStreamConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PostViewConstants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.PostViewConstants.Update.html new file mode 100644 index 000000000..f6b9dec96 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PostViewConstants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PutCloudantSecurityConfigurationConstants.Cloudant.html b/docs/0.8.1/enums/cloudant_v1.export_.PutCloudantSecurityConfigurationConstants.Cloudant.html new file mode 100644 index 000000000..cde1eed8d --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PutCloudantSecurityConfigurationConstants.Cloudant.html @@ -0,0 +1,10 @@ +Cloudant | @ibm-cloud/cloudant - v0.8.1

Database permissions for Cloudant users and/or API keys.

+

Enumeration Members

ADMIN: "_admin"
DB_UPDATES: "_db_updates"
DESIGN: "_design"
READER: "_reader"
REPLICATOR: "_replicator"
SECURITY: "_security"
SHARDS: "_shards"
WRITER: "_writer"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PutDesignDocumentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.PutDesignDocumentConstants.Batch.html new file mode 100644 index 000000000..202d61157 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PutDesignDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PutDocumentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.PutDocumentConstants.Batch.html new file mode 100644 index 000000000..bd82776a3 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PutDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PutDocumentConstants.ContentType.html b/docs/0.8.1/enums/cloudant_v1.export_.PutDocumentConstants.ContentType.html new file mode 100644 index 000000000..cb62d5cae --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PutDocumentConstants.ContentType.html @@ -0,0 +1,6 @@ +ContentType | @ibm-cloud/cloudant - v0.8.1

The type of the input.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"
MULTIPART_MIXED: "multipart/mixed"
MULTIPART_RELATED: "multipart/related"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PutLocalDocumentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.PutLocalDocumentConstants.Batch.html new file mode 100644 index 000000000..5e3915d57 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PutLocalDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PutLocalDocumentConstants.ContentType.html b/docs/0.8.1/enums/cloudant_v1.export_.PutLocalDocumentConstants.ContentType.html new file mode 100644 index 000000000..755e5fbda --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PutLocalDocumentConstants.ContentType.html @@ -0,0 +1,6 @@ +ContentType | @ibm-cloud/cloudant - v0.8.1

The type of the input.

+

Enumeration Members

APPLICATION_JSON: "application/json"
APPLICATION_OCTET_STREAM: "application/octet-stream"
MULTIPART_MIXED: "multipart/mixed"
MULTIPART_RELATED: "multipart/related"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PutReplicationDocumentConstants.Batch.html b/docs/0.8.1/enums/cloudant_v1.export_.PutReplicationDocumentConstants.Batch.html new file mode 100644 index 000000000..b0171893d --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PutReplicationDocumentConstants.Batch.html @@ -0,0 +1,3 @@ +Batch | @ibm-cloud/cloudant - v0.8.1

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

+

Enumeration Members

OK +

Enumeration Members

OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.PutSecurityConstants.Cloudant.html b/docs/0.8.1/enums/cloudant_v1.export_.PutSecurityConstants.Cloudant.html new file mode 100644 index 000000000..2a9e73474 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.PutSecurityConstants.Cloudant.html @@ -0,0 +1,10 @@ +Cloudant | @ibm-cloud/cloudant - v0.8.1

Database permissions for Cloudant users and/or API keys.

+

Enumeration Members

ADMIN: "_admin"
DB_UPDATES: "_db_updates"
DESIGN: "_design"
READER: "_reader"
REPLICATOR: "_replicator"
SECURITY: "_security"
SHARDS: "_shards"
WRITER: "_writer"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.SchedulerDocument.Constants.State.html b/docs/0.8.1/enums/cloudant_v1.export_.SchedulerDocument.Constants.State.html new file mode 100644 index 000000000..7bc3f5e54 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.SchedulerDocument.Constants.State.html @@ -0,0 +1,9 @@ +State | @ibm-cloud/cloudant - v0.8.1

Schema for replication state.

+

Enumeration Members

COMPLETED: "completed"
CRASHING: "crashing"
ERROR: "error"
FAILED: "failed"
INITIALIZING: "initializing"
PENDING: "pending"
RUNNING: "running"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.UpInformation.Constants.Status.html b/docs/0.8.1/enums/cloudant_v1.export_.UpInformation.Constants.Status.html new file mode 100644 index 000000000..d1914001c --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.UpInformation.Constants.Status.html @@ -0,0 +1,5 @@ +Status | @ibm-cloud/cloudant - v0.8.1

status.

+

Enumeration Members

Enumeration Members

MAINTENANCE_MODE: "maintenance_mode"
NOLB: "nolb"
OK: "ok"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.UserContext.Constants.Roles.html b/docs/0.8.1/enums/cloudant_v1.export_.UserContext.Constants.Roles.html new file mode 100644 index 000000000..40fb187c6 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.UserContext.Constants.Roles.html @@ -0,0 +1,10 @@ +Roles | @ibm-cloud/cloudant - v0.8.1

List of user roles.

+

Enumeration Members

ADMIN: "_admin"
DB_UPDATES: "_db_updates"
DESIGN: "_design"
READER: "_reader"
REPLICATOR: "_replicator"
SECURITY: "_security"
SHARDS: "_shards"
WRITER: "_writer"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/enums/cloudant_v1.export_.ViewQuery.Constants.Update.html b/docs/0.8.1/enums/cloudant_v1.export_.ViewQuery.Constants.Update.html new file mode 100644 index 000000000..6ad522065 --- /dev/null +++ b/docs/0.8.1/enums/cloudant_v1.export_.ViewQuery.Constants.Update.html @@ -0,0 +1,5 @@ +Update | @ibm-cloud/cloudant - v0.8.1

Parameter to specify whether or not the view in question should be updated prior to responding to the user. * true - Return results after the view is updated. * false - Return results without updating the view. * lazy - Return the view results without waiting for an update, but update them immediately after the request.

+

Enumeration Members

Enumeration Members

FALSE: "false"
LAZY: "lazy"
TRUE: "true"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/index.html b/docs/0.8.1/index.html new file mode 100644 index 000000000..de41a6aab --- /dev/null +++ b/docs/0.8.1/index.html @@ -0,0 +1,686 @@ +@ibm-cloud/cloudant - v0.8.1

@ibm-cloud/cloudant - v0.8.1

Build Status +Release +Docs

+

IBM Cloudant Node.js SDK Version 0.8.1

IBM Cloudant Node.js SDK is a client library that interacts with the +IBM Cloudant APIs.

+

Disclaimer: This library is still a 0.x release. We do consider this +library production-ready and capable, but there are still some +limitations we’re working to resolve, and refinements we want to +deliver. We are working really hard to minimise the disruption from +now until the 1.0 release, but there may still be some changes that +impact applications using this SDK. For now, be sure to pin versions +to avoid surprises.

+
+Table of Contents + + + + + + + + +
+ +

Overview

The IBM Cloudant Node.js SDK allows developers to programmatically +interact with IBM Cloudant +with the help of the @ibm-cloud/cloudant package.

+

Features

The purpose of this Node.js SDK is to wrap most of the HTTP request APIs +provided by Cloudant and supply other functions to ease the usage of Cloudant. +This SDK should make life easier for programmers to do what’s really important +to them: developing software.

+

Reasons why you should consider using Cloudant Node.js SDK in your +project:

+
    +
  • Supported by IBM Cloudant.
  • +
  • Server compatibility with: +
  • +
  • Includes all the most popular and latest supported endpoints for +applications.
  • +
  • Handles the authentication.
  • +
  • Familiar user experience with IBM Cloud SDKs.
  • +
  • Flexibility to use either built-in models or byte-based requests and responses for documents.
  • +
  • Built-in Changes feed follower (beta)
  • +
  • Promise based design with asynchronous HTTP requests.
  • +
  • Use either as native JavaScript or take advantage of TypeScript models.
  • +
  • Transparently compresses request and response bodies.
  • +
+

Prerequisites

    +
  • A +Cloudant +service instance or a +CouchDB +server.
  • +
  • Node.js 18 or 20.
  • +
+

Installation

npm install @ibm-cloud/cloudant
+
+

Using the SDK

For fundamental SDK usage information and config options, please see the common IBM Cloud SDK documentation.

+

This library requires configuration with a service URL and +Cloudant service credentials to authenticate with your +account.

+

There are several ways to set these authentication properties:

+
    +
  1. As environment variables
  2. +
  3. The programmatic approach
  4. +
  5. With an external credentials file
  6. +
+

The following section describes the different authentication types and provides environment variable examples. +Examples for other configuration methods are available by following the provided links.

+

Authentication

This library requires credentials to authenticate with IBM Cloudant. These credentials may be:

+
    +
  • IBM Cloud IAM credentials (can be used with authentication types CONTAINER, VPC and IAM) +
  • +
  • Username and password credentials (can be used with authentication types COUCHDB_SESSION and BASIC) +
  • +
+

For other compatible APIs that are not Cloudant accounts (e.g. Apache CouchDB) non-IAM based authentication types +must be used.

+

This table summarizes the available authentication types. +The authentication types are listed in order of recommendation, preferably use the authentication type +from the first row in the table that is compatible with your environment.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Authentication typeRecommended forAUTH_TYPEDescription
IAM Trusted Profiles compute resource (container)Cloudant
(SDK running in IBM Cloud IKS)
CONTAINERObtains a compute resource (CR) token from the container.
Exchanges the CR token for an IAM access_token.
Adds an Authorization: Bearer <access_token> header to each HTTP request.
Automatically renews the access token when needed.
IAM Trusted Profiles compute resource (VPC)Cloudant
(SDK running in IBM Cloud VPC)
VPCObtains an identity token from the VPC instance metadata.
Exchanges the identity token for an IAM access_token.
Adds an Authorization: Bearer <access_token> header to each HTTP request.
Automatically renews the access token when needed.
IAM API keyCloudantIAMExchanges an IAM API key for an IAM access_token.
Adds an Authorization: Bearer <access_token> header to each HTTP request.
Automatically renews the access token when needed.
Session cookieCloudant
(legacy credentials & instances without IAM)

Apache CouchDB
COUCHDB_SESSIONExchanges credentials with /_session endpoint to retrieve a cookie.
Adds Cookie header and content to each HTTP request.
Automatically renews session when needed.
Bearer tokenApache CouchDB
(using JWT authentication)
BEARERTOKENAdds an Authorization: Bearer <token> to each HTTP request.
No token management or renewal.
Also compatible with IAM access tokens managed independently of the SDK.
BasicApache CouchDB
(if cookies are not enabled)
BASICAdds an Authorization: Basic <encoded username and password> header to each HTTP request.
None-NOAUTHNote that this authentication type only works for operations against a database allowing access for unauthenticated users.
+

The default authentication type for the SDK is CONTAINER unless APIKEY configuration is supplied, which changes the default authentication type to IAM.

+

Authentication with environment variables

The default service name is CLOUDANT so CLOUDANT_ prefixed names are used in these examples.

+

Any custom service name prefix can be used as long as the matching name is used to instantiate the SDK client +and the same prefix is used for all configuration options.

+
IAM API key authentication

For Cloudant IAM API key authentication, set the following environmental variables by +replacing the <url> and <apikey> with your proper +service credentials. There is no need to set +CLOUDANT_AUTH_TYPE to IAM because it is the default when an APIKEY is set.

+
CLOUDANT_URL=<url>
CLOUDANT_APIKEY=<apikey> +
+
IAM Trusted profile (container) authentication

For Cloudant IAM Trusted profile compute resource container authentication, set the following environmental variables by +replacing the <url> and <id> with your values. There is no need to set +CLOUDANT_AUTH_TYPE to CONTAINER because it is the default.

+
CLOUDANT_URL=<url>
CLOUDANT_IAM_PROFILE_ID=<id> +
+

Alternatively a profile name may be used instead of an ID by replacing CLOUDANT_IAM_PROFILE_ID with CLOUDANT_IAM_PROFILE_NAME.

+
IAM Trusted profile (VPC) authentication

For Cloudant IAM Trusted profile compute resource vpc authentication, set the following environmental variables by +replacing the <url> and <id> with your values.

+
CLOUDANT_AUTH_TYPE=VPC
CLOUDANT_URL=<url>
CLOUDANT_IAM_PROFILE_ID=<id> +
+

Alternatively a profile CRN may be used instead of an ID by replacing CLOUDANT_IAM_PROFILE_ID with CLOUDANT_IAM_PROFILE_CRN.

+
Session cookie authentication

For COUCHDB_SESSION authentication, set the following environmental variables +by replacing the <url>, <username> and <password> with your proper +service credentials.

+
CLOUDANT_AUTH_TYPE=COUCHDB_SESSION
CLOUDANT_URL=<url>
CLOUDANT_USERNAME=<username>
CLOUDANT_PASSWORD=<password> +
+

Authentication with external configuration

To use an external configuration file, the +Cloudant API docs, +or the +general SDK usage information +will guide you.

+

Programmatic authentication

To learn more about how to use programmatic authentication, see the related +documentation in the +Cloudant API docs +or in the +Node.js SDK Core document about authentication.

+

Request timeout configuration

No request timeout is defined, but a 2.5m connect and 2.5m read timeout is set by default. Be sure to set a request timeout appropriate to your application usage and environment. +The request timeout section contains details on how to change the value.

+

Note: System settings may take precedence over configured timeout values.

+

Code examples

The following code examples +authenticate with the environment variables.

+

1. Create a database and add a document

Note: This example code assumes that orders database does not exist in your account.

+

This example code creates orders database and adds a new document "example" +into it. To connect, you must set your environment variables with +the service url, authentication type and authentication credentials +of your Cloudant service.

+

Cloudant environment variable naming starts with a service name prefix that identifies your service. +By default, this is CLOUDANT, see the settings in the +authentication with environment variables section.

+

If you would like to rename your Cloudant service from CLOUDANT, +you must use your defined service name as the prefix for all Cloudant related environment variables.

+

Once the environment variables are set, you can try out the code examples.

+
+TypeScript: + +
import { CloudantV1 } from "@ibm-cloud/cloudant";
+
+
interface OrderDocument extends CloudantV1.Document {
name?: string;
joined?: string;
_id: string;
_rev?: string;
}

// 1. Create a client with `CLOUDANT` default service name ======================
const client = CloudantV1.newInstance({});

// 2. Create a database =========================================================
const exampleDbName = 'orders';

// Try to create database if it doesn't exist
const createDb = client
.putDatabase({ db: exampleDbName })
.then((putDatabaseResult) => {
if (putDatabaseResult.result.ok) {
console.log(`"${exampleDbName}" database created."`);
}
})
.catch((err) => {
if (err.code === 412) {
console.log(
`Cannot create "${exampleDbName}" database, it already exists.`
);
}
});

// 3. Create a document =========================================================
// Create a document object with "example" id
const exampleDocId = 'example';

// Setting `_id` for the document is optional when postDocument function is used for CREATE.
// When `_id` is not provided the server will generate one for your document.
const exampleDocument: OrderDocument = { _id: exampleDocId };

// Add "name" and "joined" fields to the document
exampleDocument.name = 'Bob Smith';
exampleDocument.joined = '2019-01-24T10:42:59.000Z';

// Save the document in the database with "postDocument" function
createDb.then(() => {
client
.postDocument({
db: exampleDbName,
document: exampleDocument,
})
// ==========================================================================
// Note: saving the document can also be done with the "putDocument"
// function. In this case `docId` is required for a CREATE operation:
/*
.putDocument({
db: exampleDbName,
docId: exampleDocId,
document: exampleDocument,
})
*/
// ==========================================================================
.then((createDocumentResponse) => {
// Keeping track of the revision number of the document object
// is necessary for further UPDATE/DELETE operations:
exampleDocument._rev = createDocumentResponse.result.rev;
console.log(
'You have created the document:\n' +
JSON.stringify(exampleDocument, null, 2)
);
});
}); +
+
+ +
+JavaScript: + +
const { CloudantV1 } = require('@ibm-cloud/cloudant');
+
+

embedmd:# (test/examples/src/js/CreateDbAndDoc.js /const createDbAndDoc/ /createDbAndDoc();\n}/)

+
const createDbAndDoc = async () => {
// 1. Create a client with `CLOUDANT` default service name ====================
const client = CloudantV1.newInstance({});

// 2. Create a database =======================================================
const exampleDbName = 'orders';

// Try to create database if it doesn't exist
try {
const putDatabaseResult = (
await client.putDatabase({
db: exampleDbName,
})
).result;
if (putDatabaseResult.ok) {
console.log(`"${exampleDbName}" database created.`);
}
} catch (err) {
if (err.code === 412) {
console.log(
`Cannot create "${exampleDbName}" database, it already exists.`
);
}
}

// 3. Create a document =======================================================
// Create a document object with "example" id
const exampleDocId = 'example';

// Setting `_id` for the document is optional when "postDocument" function is used for CREATE.
// When `_id` is not provided the server will generate one for your document.
const exampleDocument = { _id: exampleDocId };

// Add "name" and "joined" fields to the document
exampleDocument['name'] = 'Bob Smith';
exampleDocument.joined = '2019-01-24T10:42:59.000Z';

// Save the document in the database with "postDocument" function
const createDocumentResponse = await client.postDocument({
db: exampleDbName,
document: exampleDocument,
});

// ==========================================================================
// Note: saving the document can also be done with the "putDocument"
// function. In this case `docId` is required for a CREATE operation:
/* const createDocumentResponse = await client.putDocument({
db: exampleDbName,
docId: exampleDocId,
document: exampleDocument,
}); */
// ==========================================================================

// Keeping track of the revision number of the document object
// is necessary for further UPDATE/DELETE operations:
exampleDocument._rev = createDocumentResponse.result.rev;
console.log(
'You have created the document:\n' +
JSON.stringify(exampleDocument, null, 2)
);
};

if (require.main === module) {
createDbAndDoc();
} +
+
+ +

When you run the code, you see a result similar to the following output.

+
"orders" database created.
+You have created the document:
+{
+  "_id": "example",
+  "name": "Bob Smith",
+  "joined": "2019-01-24T10:42:59.000Z",
+  "_rev": "1-1b403633540686aa32d013fda9041a5d"
+}
+
+

2. Retrieve information from an existing database

Note: This example code assumes that you have created both the orders +database and the example document by +running the previous example code +successfully. Otherwise, the following error message occurs, "Cannot delete document because either 'orders' +database or 'example' document was not found."

+
+Gather database information example + +
+TypeScript: + +
import { CloudantV1 } from "@ibm-cloud/cloudant";
+
+
// 1. Create a client with `CLOUDANT` default service name =====================
const client = CloudantV1.newInstance({});

// 2. Get server information ====================================================
// call service without parameters:
client.getServerInformation().then((serverInformation) => {
const { version } = serverInformation.result;
console.log(`Server version ${version}`);
});

// 3. Get database information for "orders" ===================================
const dbName = 'orders';

// call service with embedded parameters:
client.getDatabaseInformation({ db: dbName }).then((dbInfo) => {
const documentCount = dbInfo.result.doc_count;
const dbNameResult = dbInfo.result.db_name;

// 4. Show document count in database =========================================
console.log(
`Document count in "${dbNameResult}" database is ${documentCount}.`
);
});

// 5. Get "example" document out of the database by document id =====================
const getDocParams: CloudantV1.GetDocumentParams = {
db: dbName,
docId: 'example',
};

// call service with predefined parameters:
client.getDocument(getDocParams).then((documentExample) => {
// result object is defined as a Document here:
const { result } = documentExample;
console.log(
`Document retrieved from database:\n${JSON.stringify(result, null, 2)}`
);
}); +
+
+ +
+JavaScript: + +
const { CloudantV1 } = require('@ibm-cloud/cloudant');
+
+

embedmd:# (test/examples/src/js/GetInfoFromExistingDatabase.js /const getInfoFromExistingDatabase/ /getInfoFromExistingDatabase();\n}/)

+
const getInfoFromExistingDatabase = async () => {
// 1. Create a client with `CLOUDANT` default service name ===================
const client = CloudantV1.newInstance({});

// 2. Get server information ==================================================
// call service without parameters:
const { version } = (await client.getServerInformation()).result;
console.log(`Server version ${version}`);

// 3. Get database information for "orders" =================================
const dbName = 'orders';

// call service with embedded parameters:
const dbInfo = await client.getDatabaseInformation({ db: dbName });
const documentCount = dbInfo.result.doc_count;
const dbNameResult = dbInfo.result.db_name;

// 4. Show document count in database =========================================
console.log(
`Document count in "${dbNameResult}" database is ${documentCount}.`
);

// 5. Get "example" document out of the database by document id ===================
const getDocParams = { db: dbName, docId: 'example' };

// call service with predefined parameters:
const documentExample = await client.getDocument(getDocParams);

// result object is defined as a Document here:
const { result } = documentExample;

console.log(
`Document retrieved from database:\n${JSON.stringify(result, null, 2)}`
);
};

if (require.main === module) {
getInfoFromExistingDatabase();
} +
+
+ + +
+When you run the code, you see a result similar to the following output. + +
Server version 3.2.1
+Document count in "orders" database is 1.
+Document retrieved from database:
+{
+  "_id": "example",
+  "_rev": "1-1b403633540686aa32d013fda9041a5d",
+  "name": "Bob Smith",
+  "joined": "2019-01-24T10:42:59.000Z"
+}
+
+

3. Update your previously created document

Note: This example code assumes that you have created both the orders +database and the example document by +running the previous example code +successfully. Otherwise, the following error message occurs, "Cannot update document because either 'orders' +database or 'example' document was not found."

+
+Update code example + +
+TypeScript: + +
import { CloudantV1 } from "@ibm-cloud/cloudant";
+
+
interface OrderDocument extends CloudantV1.Document {
address?: string;
joined?: string;
_id?: string;
_rev?: string;
}

// 1. Create a client with `CLOUDANT` default service name ======================
const client = CloudantV1.newInstance({});
// 2. Update the document =======================================================
// Set the options to get the document out of the database if it exists
const exampleDbName = 'orders';

// Try to get the document if it previously existed in the database
const getDocParams: CloudantV1.GetDocumentParams = {
docId: 'example',
db: exampleDbName,
};

// ==============================================================================
// Note : for response byte stream use:
/*
const getdocAsStreamParam: CloudantV1.GetDocumentAsStreamParams = {
docId: 'example',
db: exampleDbName,
};
client
.getDocumentAsStream(getdocAsStreamParam)
.then((documentAsByteStream) => {...});
*/
// ==============================================================================

client
.getDocument(getDocParams)
.then((docResult) => {
// using OrderDocument on getDocument result:
const document: OrderDocument = docResult.result;

// Add Bob Smith's address to the document
document.address = '19 Front Street, Darlington, DL5 1TY';

// Remove the joined property from document object
delete document.joined;

// Update the document in the database
client
.postDocument({ db: exampleDbName, document })
// ========================================================================
// Note 1: for request byte stream use:
// .postDocument(
// {db: exampleDbName, document: documentAsByteStream}
// )
// ========================================================================

// ========================================================================
// Note 2: updating the document can also be done with the "putDocument" function.
// `docId` and `rev` are required for an UPDATE operation,
// but `rev` can be provided in the document object as `_rev` too:
/*
.putDocument({
db: exampleDbName,
docId: document._id, // docId is a required parameter
rev: document._rev,
document, // _rev in the document object CAN replace above `rev` parameter
})
*/
// ========================================================================
.then((res) => {
// Keeping track of the latest revision number of the document object
// is necessary for further UPDATE/DELETE operations:
document._rev = res.result.rev;
console.log(
`You have updated the document:\n${JSON.stringify(document, null, 2)}`
);
});
})
.catch((err) => {
if (err.code === 404) {
console.log(
`Cannot update document because either "${exampleDbName}" database or the "example" ` +
`document was not found.`
);
}
}); +
+
+ +
+JavaScript: + +
const { CloudantV1 } = require('@ibm-cloud/cloudant');
+
+

embedmd:# (test/examples/src/js/UpdateDoc.js /const updateDoc/ /updateDoc();\n}/)

+
const updateDoc = async () => {
// 1. Create a client with `CLOUDANT` default service name ====================
const client = CloudantV1.newInstance({});
// 2. Update the document =====================================================
// Set the options to get the document out of the database if it exists
const exampleDbName = 'orders';

// Try to get the document if it previously existed in the database
try {
const document = (
await client.getDocument({
docId: 'example',
db: exampleDbName,
})
).result;

// ==========================================================================
// Note: for response byte stream use:
/*
const documentAsByteStream = (
await client.getDocumentAsStream({
docId: 'example',
db: exampleDbName,
})
).result;
*/
// ==========================================================================

// Add Bob Smith's address to the document
document.address = '19 Front Street, Darlington, DL5 1TY';

// Remove the joined property from document object
delete document['joined'];

// Keeping track of the latest revision number of the document object
// is necessary for further UPDATE/DELETE operations:
document._rev = (
await client.postDocument({
db: exampleDbName,
document, // _id and _rev MUST be inside the document object
})
).result.rev;

// ==========================================================================
// Note 1: for request byte stream use:
/*
document._rev = (
await client.postDocument({
db: exampleDbName,
document: documentAsByteStream,
})
).result.rev;
*/
// ==========================================================================

// ==========================================================================
// Note 2: updating the document can also be done with the "putDocument" function.
// `docId` and `rev` are required for an UPDATE operation,
// but `rev` can be provided in the document object as `_rev` too:
/*
document._rev = (
await client.putDocument({
db: exampleDbName,
docId: document._id, // docId is a required parameter
rev: document._rev,
document // _rev in the document object CAN replace above `rev` parameter
})
).result.rev;
*/
// ==========================================================================

console.log(
`You have updated the document:\n${JSON.stringify(document, null, 2)}`
);
} catch (err) {
if (err.code === 404) {
console.log(
`Cannot update document because either "${exampleDbName}" database or the "example" ` +
`document was not found.`
);
}
}
};

if (require.main === module) {
updateDoc();
} +
+
+ + +
+When you run the code, you see a result similar to the following output. + +
You have updated the document:
+{
+  "_id": "example",
+  "_rev": "2-4e2178e85cffb32d38ba4e451f6ca376",
+  "name": "Bob Smith",
+  "address": "19 Front Street, Darlington, DL5 1TY"
+}
+
+

4. Delete your previously created document

Note: This example code assumes that you have created both the orders +database and the example document by +running the previous example code +successfully. Otherwise, the following error message occurs, "Cannot delete document because either 'orders' +database or 'example' document was not found."

+
+Delete code example + +
+TypeScript: + +
import { CloudantV1 } from "@ibm-cloud/cloudant";
+
+
interface OrderDocument extends CloudantV1.Document {
name?: string;
address?: string;
joined?: string;
_id?: string;
_rev?: string;
}

// 1. Create a client with `CLOUDANT` default service name ======================
const client = CloudantV1.newInstance({});

// 2. Delete the document =======================================================
// Set the options to get the document out of the database if it exists
const exampleDbName = 'orders';
const exampleDocId = 'example';

// Try to get the document if it previously existed in the database
const getDocParams: CloudantV1.GetDocumentParams = {
docId: exampleDocId,
db: exampleDbName,
};

client
.getDocument(getDocParams)
.then((docResult) => {
const document: OrderDocument = docResult.result;

client
.deleteDocument({
db: exampleDbName,
docId: document._id, // `docId` is required for DELETE
rev: document._rev, // `rev` is required for DELETE
})
.then(() => {
console.log('You have deleted the document.');
});
})
.catch((err) => {
if (err.code === 404) {
console.log(
`Cannot delete document because either "${exampleDbName}" database or the "example" ` +
`document was not found.`
);
}
}); +
+
+ +
+JavaScript: + +
const { CloudantV1 } = require('@ibm-cloud/cloudant');
+
+

embedmd:# (test/examples/src/js/DeleteDoc.js /const deleteDoc/ /deleteDoc();\n}/)

+
const deleteDoc = async () => {
// 1. Create a client with `CLOUDANT` default service name ====================
const client = CloudantV1.newInstance({});

// 2. Delete the document =====================================================
// Set the options to get the document out of the database if it exists
const exampleDbName = 'orders';
const exampleDocId = 'example';

// Try to get the document if it previously existed in the database
try {
const document = (
await client.getDocument({
docId: exampleDocId,
db: exampleDbName,
})
).result;

await client.deleteDocument({
db: exampleDbName,
docId: document._id, // `docId` is required for DELETE
rev: document._rev, // `rev` is required for DELETE
});
console.log('You have deleted the document.');
} catch (err) {
if (err.code === 404) {
console.log(
`Cannot delete document because either "${exampleDbName}" database or the "example" ` +
`document was not found.`
);
}
}
};

if (require.main === module) {
deleteDoc();
} +
+
+ + +
+When you run the code, you see the following output. + +
You have deleted the document.
+
+

Further code examples

For a complete list of code examples, see the examples directory.

+

Error handling

For sample code on handling errors, see +Cloudant API docs.

+

Raw IO

For endpoints that read or write document content it is possible to bypass +usage of the built-in interface with byte streams.

+

Depending on the specific SDK operation it may be possible to:

+
    +
  • accept a user-provided byte stream to send to the server as a request body
  • +
  • return a byte stream of the server response body to the user
  • +
+

Request byte stream can be supplied for NodeJS.ReadableStream or Buffer type parameters +. +For these cases you can pass this byte stream directly to the HTTP request body.

+

Response byte stream is supported in functions with the suffix of AsStream. +The returned byte stream allows the response body to be consumed +without triggering JSON unmarshalling that is typically performed by the SDK.

+

The update document section +contains examples for both request and response byte stream cases.

+

The API reference contains further examples of using byte streams. +They are titled "Example request as stream" and are initially collapsed. +Expand them to see examples of:

+ +

Further resources

    +
  • Cloudant API docs: +API reference including usage examples for Cloudant Node.js SDK API.
  • +
  • TypeDoc: +Cloudant Node.js SDK API Documentation.
  • +
  • Cloudant docs: +The official documentation page for Cloudant.
  • +
  • Cloudant blog: +Many useful articles about how to optimize Cloudant for common problems.
  • +
+

Changes feed follower (beta)

Introduction

The SDK provides a changes feed follower utility (currently beta). +This helper utility connects to the _changes endpoint and returns the individual change items. +It removes some of the complexity of using the _changes endpoint by setting some options automatically +and providing error suppression and retries.

+

Tip: the changes feed often does not meet user expectations or assumptions.

+

Consult the Cloudant changes feed FAQ +to get a better understanding of the limitations and suitable use-cases before using the changes feed in your application.

+

Modes of operation

There are two modes of operation:

+
    +
  • Start mode
      +
    • Fetches the changes from the supplied since sequence (by default the feed will start from now).
    • +
    • Fetches all available changes and then continues listening for new changes indefinitely unless encountering an end condition.
    • +
    • An example use case for this mode is event driven workloads.
    • +
    +
  • +
  • Start one-off mode
      +
    • Fetches the changes from the supplied since sequence (by default the feed will start from the beginning).
    • +
    • Fetches all available changes and then stops when either there are no further changes pending or encountering an end condition.
    • +
    • An example use case for this mode is ETL style workloads.
    • +
    +
  • +
+

Configuring the changes follower

The SDK's model of changes feed options is also used to configure the follower. +However, a subset of the options are invalid as they are configured internally by the implementation. +Supplying these options when instantiating the follower causes an error. +The invalid options are:

+
    +
  • descending
  • +
  • feed
  • +
  • heartbeat
  • +
  • lastEventId - use since instead
  • +
  • timeout
  • +
  • Only the value of _selector is permitted for the filter option. This restriction is because selector +based filters perform better than JavaScript backed filters. Configuring a non-selector based filter will +cause the follower to error.
  • +
+

Note that the limit parameter will terminate the follower at the given number of changes in either +operating mode.

+

The changes follower requires the client to have HTTP timeouts of at least 1 minute and will error during +instantiation if it is insufficient. The default client configuration has sufficiently long timeouts.

+

For use-cases where these configuration limitations are deemed too restrictive then it is recommended to +write code to use the SDK's POST _changes API instead of the follower.

+

Error suppression

By default, the changes follower will suppress transient errors indefinitely and attempt to run to completion or listen forever as +dictated by the operating mode. +For applications where that is not desirable an optional error tolerance duration may be specified to control the time since +the last successful response that transient errors will be suppressed. This can be used, for example, by applications as a grace period +before reporting an error and requiring intervention.

+

There are some additional points to consider for error suppression:

+
    +
  • Errors considered terminal, for example, the database not existing or invalid credentials are never suppressed and will error immediately.
  • +
  • The error suppression duration is not guaranteed to fire immediately after lapsing and should be considered a minimum suppression time.
  • +
  • The changes follower will back-off between retries and as such may remain paused for a short while after the transient errors have resolved.
  • +
  • If the underlying SDK client used to initialize the follower also has retries configured then errors could be suppressed for significantly +longer than the follower's configured error tolerance duration depending on the configuration options.
  • +
+

Follower operation

For both modes:

+
    +
  • The end conditions are:
      +
    • A terminal error (HTTP codes 400, 401, 403 404).
    • +
    • Transient errors occur for longer than the error tolerance duration. Transient errors are all other HTTP status codes and connection errors.
    • +
    • The number of changes received reaches the configured limit.
    • +
    • The feed is terminated early by calling stop.
    • +
    +
  • +
+

As is true for the _changes endpoint change items have at least once delivery and an individual item +may be received multiple times. When using the follower change items may be repeated even within a limited +number of changes (i.e. using the limit option) this is a minor difference from using limit on the HTTP native API.

+

The follower is not optimized for some use cases and it is not recommended to use it in cases where:

+
    +
  • Setting include_docs and larger document sizes (for example > 10 kiB).
  • +
  • The volume of changes is very high (if the rate of changes in the database exceeds the follower's rate of pulling them it will never catch-up).
  • +
+

In these cases use-case specific control over the number of change requests made and the content size of the responses +may be achieved by using the SDK's POST _changes API.

+

Checkpointing

The changes follower does not checkpoint since it has no information about whether a change item has been +processed by the consuming application after being received. It is the application developer's responsibility +to store the sequence IDs to have appropriate checkpoints and to re-initialize the follower with the required +since value after, for example, the application restarts.

+

The frequency and conditions for checkpointing are application specific and some applications may be tolerant +of dropped changes. This section is intended only to provide general guidance on how to avoid missing changes.

+

To guarantee processing of all changes the sequence ID from a change item must not be persisted until after +the processing of the change item by the application has completed. As indicated previously change items are +delivered at least once so application code must be able to handle repeated changes already and it is +preferable to restart from an older since value and receive changes again than risk missing them.

+

The sequence IDs are available on each change item by default, but may be omitted from some change items when +using the seq_interval configuration option. Infrequent sequence IDs may improve performance by reducing +the amount of data that needs to be transferred, but the trade-off is that more changes will be repeated if +it is necessary to resume the changes follower.

+

Extreme care should be taken with persisting sequences if choosing to process change items in parallel as there +is a considerable risk of missing changes on a restart if the sequence is recorded out of order.

+

Code examples

Initializing a changes follower
+TypeScript: + +
import { ChangesFollower, CloudantV1 } from '@ibm-cloud/cloudant';
import { PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1'; +
+
const client = CloudantV1.newInstance({});
const changesParams: PostChangesParams = {
db: 'example', // Required: the database name.
limit: 100, // Optional: return only 100 changes (including duplicates).
since: '3-g1AG3...' // Optional: start from this sequence ID (e.g. with a value read from persistent storage).
};
const errorTolerance: number = 10000; // 10 second duration to suppress transient errors
const changesFollower: ChangesFollower = new ChangesFollower(
client, // Required: the Cloudant service client instance.
changesParams, // Required: changes feed configuration options dict.
10000 // Optional: suppress transient errors for at least 10 seconds before terminating.
); +
+
+ +
+JavaScript: + +
const { ChangesFollower, CloudantV1 } = require('@ibm-cloud/cloudant');
+
+
const client = CloudantV1.newInstance();
const changesParams = {
db: 'example', // Required: the database name.
limit: 100, // Optional: return only 100 changes (including duplicates).
since: '3-g1AG3...' // Optional: start from this sequence ID (e.g. with a value read from persistent storage).
};
const changesFollower = new ChangesFollower(
client, // Required: the Cloudant service client instance.
changesParams, // Required: changes feed configuration options dict.
10000 // Optional: suppress transient errors for at least 10 seconds before terminating.
); +
+
+ + +
Starting the changes follower
Start mode for continuous listening
+TypeScript: + +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1'; +
+
const client = CloudantV1.newInstance({});
const changesParams: PostChangesParams = {
db: 'example'
};
const changesFollower: ChangesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.start();
// Create for-async-loop or pipeline to begin the flow of changes
// e.g. pipeline(changesItemsStream, destinationStream).then(() => { ... }).catch((err) => { ... }); +
+
+ +
+JavaScript: + +
const { ChangesFollower, CloudantV1 } = require('@ibm-cloud/cloudant');
+
+
const client = CloudantV1.newInstance();
const changesParams = {
db: 'example'
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.start();
// Create for-async-loop or pipeline to begin the flow of changes
// e.g. pipeline(changesItemsStream, destinationStream).then(() => { ... }).catch((err) => { ... }); +
+
+ + +
Start mode for one-off fetching
+TypeScript: + +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1'; +
+
const client = CloudantV1.newInstance({});
const changesParams: PostChangesParams = {
db: 'example'
};
const changesFollower: ChangesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.startOneOff();
// Create for-async-loop or pipeline to begin the flow of changes
// e.g. pipeline(changesItemsStream, destinationStream).then(() => { ... }).catch((err) => { ... }); +
+
+ +
+JavaScript: + +
const { ChangesFollower, CloudantV1 } = require('@ibm-cloud/cloudant');
+
+
const client = CloudantV1.newInstance();
const changesParams = {
db: 'example'
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.startOneOff();
// Create for-async-loop or pipeline to begin the flow of changes
// e.g. pipeline(changesItemsStream, destinationStream).then(() => { ... }).catch((err) => { ... }); +
+
+ + +
Processing changes
Process continuous changes
+TypeScript: + +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises'; +
+
const client = CloudantV1.newInstance({});
// Start from a previously persisted seq
// Normally this would be read by the app from persistent storage
// e.g. previouslyPersistedSeq = yourAppPersistenceReadFunc()
const previouslyPersistedSeq = '3-g1AG3...';
const changesParams: PostChangesParams = {
db: 'example',
since: previouslyPersistedSeq
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.start();

const destinationStream = new Writable({
objectMode: true,
write(changesItem: CloudantV1.ChangesResultItem, _, callback) {
// do something with change item
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
const seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc()
callback();
}
});

// A pipeline to keep processing changes until the follower is stopped or some other stop condition is reached
pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('Stopped');
})
.catch((err) => {
console.log(err);
}); +
+
+ +
+JavaScript: + +
const { ChangesFollower, CloudantV1 } = require('@ibm-cloud/cloudant');
const { Writable } = require('node:stream');
const { pipeline } = require('node:stream/promises'); +
+
const client = CloudantV1.newInstance();
// Start from a previously persisted seq
// Normally this would be read by the app from persistent storage
// e.g. previouslyPersistedSeq = yourAppPersistenceReadFunc()
const previouslyPersistedSeq = '3-g1AG3...';
const changesParams = {
db: 'example',
since: previouslyPersistedSeq
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.start();

const destinationStream = new Writable({
objectMode: true,
write(changesItem, _, callback) {
// do something with change item
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
const seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc()
callback();
}
});

// A pipeline to keep processing changes until the follower is stopped or some other stop condition is reached
pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('Stopped');
})
.catch((err) => {
console.log(err);
}); +
+
+ + +
Process one-off changes
+TypeScript: + +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises'; +
+
const client = CloudantV1.newInstance({});
// Start from a previously persisted seq
// Normally this would be read by the app from persistent storage
// e.g. previouslyPersistedSeq = yourAppPersistenceReadFunc()
const previouslyPersistedSeq = '3-g1AG3...';
const changesParams: PostChangesParams = {
db: 'example',
since: previouslyPersistedSeq
};
const changesFollower: ChangesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.startOneOff();

const destinationStream = new Writable({
objectMode: true,
write(changesItem: CloudantV1.ChangesResultItem, _, callback) {
// do something with change item
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
const seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc()
callback();
}
});

pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('All changes done');
})
.catch((err) => {
console.log(err);
});

// use for-async-loop feature for stream
/*
getChangesFromFollower(changesItemsStream);
async function getChangesFromFollower(changesItemsStream: Stream<CloudantV1.ChangesResultItem>) {
for await (const changesItem of changesItemsStream) {
// do something with change item
// write seq to persistent storage for use as since
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc();
}
}
*/ +
+
+ +
+JavaScript: + +
const { ChangesFollower, CloudantV1 } = require('@ibm-cloud/cloudant');
const { Writable } = require('node:stream');
const { pipeline } = require('node:stream/promises'); +
+
const client = CloudantV1.newInstance();
// Start from a previously persisted seq
// Normally this would be read by the app from persistent storage
// e.g. previouslyPersistedSeq = yourAppPersistenceReadFunc()
const previouslyPersistedSeq = '3-g1AG3...';
const changesParams = {
db: 'example',
since: previouslyPersistedSeq
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.startOneOff();

const destinationStream = new Writable({
objectMode: true,
write(changesItem, _, callback) {
// do something with change item
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
const seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc()
callback();
}
});

pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('All changes done');
})
.catch((err) => {
console.log(err);
});

// use for-async-loop feature for stream
/*
getChangesFromFollower(changesItemsStream);
async function getChangesFromFollower(changesItemsStream) {
for await (const changesItem of changesItemsStream) {
// do something with change item
// write seq to persistent storage for use as since
console.log(changesItem.id);
for (const change of changesItem.changes) {
console.log(change.rev);
}
// when change item processing is complete app can store seq
seq = changesItem.seq;
// write seq to persistent storage for use as since if required to resume later
// e.g. yourAppPersistenceWriteFunc();
}
}
*/ +
+
+ + +
Stopping the changes follower
+TypeScript: + +
import { ChangesFollower, CloudantV1, Stream } from '@ibm-cloud/cloudant';
import { ChangesResultItem, PostChangesParams } from '@ibm-cloud/cloudant/cloudant/v1';
import { Writable } from 'node:stream';
import { pipeline } from 'node:stream/promises'; +
+
const client = CloudantV1.newInstance({});
const changesParams: PostChangesParams = {
db: 'example'
};
const changesFollower: ChangesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream: Stream<ChangesResultItem> = changesFollower.start();

const destinationStream = new Writable({
objectMode: true,
write(changesItem: CloudantV1.ChangesResultItem, _, callback) {
// Option 1: call stop after some condition
// Note that at least one item
// must be returned to reach to this point.
// Additional changes may be processed before the iterator stops.
changesFollower.stop();
callback();
}
});

pipeline(changesItemsStream, destinationStream)
.then(() => {
console.log('Stopped');
})
.catch((err) => {
console.log(err);
});

// Option 2: call stop method when you want to end the continuous loop from
// outside the pipeline.
// Normally the call would be made from some other application function
// executing later.
// For example, stop the changesFollower after 1 minute of listening for changes
setTimeout(() => {
changesFollower.stop();
}, 60000); +
+
+ +
+JavaScript: + +
const { ChangesFollower, CloudantV1 } = require('@ibm-cloud/cloudant');
const { Writable } = require('node:stream');
const { pipeline } = require('node:stream/promises'); +
+
const client = CloudantV1.newInstance();
const changesParams = {
db: 'example'
};
const changesFollower = new ChangesFollower(client, changesParams);
const changesItemsStream = changesFollower.start();

const destinationStream = new Writable({
objectMode: true,
write(changesItem, _, callback) {
// Option 1: call stop after some condition
// Note that at least one item
// must be returned to reach to this point.
// Additional changes may be processed before the iterator stops.
changesFollower.stop();
callback();
}
});

pipeline(changesItemsStream, destinationStream)
.then(() =>{
console.log('Stopped');
})
.catch((err) => {
console.log(err);
});

// Option 2: call stop method when you want to end the continuous loop from
// outside the pipeline.
// Normally the call would be made from some other application function
// executing later.
// For example, stop the changesFollower after 1 minute of listening for changes
setTimeout(() => {
changesFollower.stop();
}, 60000); +
+
+ + +

Questions

If you are having difficulties using this SDK or have a question about the +IBM Cloud services, ask a question on +Stack Overflow.

+

Issues

If you encounter an issue with the project, you are welcome to submit a +bug report.

+

Before you submit a bug report, search for +similar issues and review the +KNOWN_ISSUES file to verify that your issue hasn't been reported yet.

+

Please consult the security policy before opening security related issues.

+

Versioning and LTS support

This SDK follows semantic versioning with respect to the definition of user facing APIs. +This means under some circumstances breaking changes may occur within a major or minor version +of the SDK related to changes in supported language platforms.

+

The SDK is supported on the available LTS releases of the language platform. +The LTS language versions are listed in the prerequisites:

+ +

Incompatible changes from new language versions are not added to the SDK +until they are available in the minimum supported language version.

+

When language LTS versions move out of support the following will happen:

+
    +
  • Existing SDK releases will continue to run on obsolete language versions, but will no longer be supported.
  • +
  • The minimum language version supported by the SDK will be updated to the next available LTS.
  • +
  • New language features may be added in subsequent SDK releases that will cause breaking changes + if the new releases of the SDK are used with older, now unsupported, language levels.
  • +
+

Open source at IBM

Find more open source projects on the IBM GitHub page.

+

Contributing

For more information, see CONTRIBUTING.

+

License

This SDK is released under the Apache 2.0 license. To read the full text of the license, see LICENSE.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/auth_sessionTokenManager.SessionTokenManagerOptions.html b/docs/0.8.1/interfaces/auth_sessionTokenManager.SessionTokenManagerOptions.html new file mode 100644 index 000000000..53bde76dc --- /dev/null +++ b/docs/0.8.1/interfaces/auth_sessionTokenManager.SessionTokenManagerOptions.html @@ -0,0 +1,6 @@ +SessionTokenManagerOptions | @ibm-cloud/cloudant - v0.8.1

Configuration options for CouchDB session token retrieval.

+
interface SessionTokenManagerOptions {
    password: string;
    username: string;
}

Hierarchy

  • UserOptions
    • SessionTokenManagerOptions

Properties

Properties

password: string

The password portion of CouchDB session authentication.

+
username: string

The username portion of CouchDB session authentication.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ActiveTask-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ActiveTask-1.html new file mode 100644 index 000000000..40fe7b0ef --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ActiveTask-1.html @@ -0,0 +1,78 @@ +ActiveTask | @ibm-cloud/cloudant - v0.8.1

Schema for information about a running task.

+
interface ActiveTask {
    bulk_get_attempts?: number;
    bulk_get_docs?: number;
    changes_done?: number;
    changes_pending?: number;
    checkpoint_interval?: number;
    checkpointed_source_seq?: string;
    continuous?: boolean;
    database: string;
    design_document?: string;
    doc_id?: string;
    doc_write_failures?: number;
    docs_read?: number;
    docs_written?: number;
    index?: string;
    indexer_pid?: string;
    missing_revisions_found?: number;
    node: string;
    phase?: string;
    pid: string;
    process_status?: string;
    progress?: number;
    replication_id?: string;
    retry?: boolean;
    revisions_checked?: number;
    source?: string;
    source_seq?: string;
    started_on: number;
    target?: string;
    through_seq?: string;
    total_changes?: number;
    type: string;
    updated_on: number;
    user?: string;
    view?: number;
}

Properties

bulk_get_attempts?: number

The total count of attempted doc revisions fetched with _bulk_get. Available for replication type tasks.

+
bulk_get_docs?: number

The total count of successful docs fetched with _bulk_get. Available for replication type tasks.

+
changes_done?: number

Processed changes. Available for database_compaction, indexer, search_indexer, view_compaction type + tasks.

+
changes_pending?: number

The count of changes not yet replicated. Available for replication type tasks.

+
checkpoint_interval?: number

Specifies the checkpoint interval in ms. Available for replication type tasks.

+
checkpointed_source_seq?: string

The source sequence id which was last successfully replicated. Available for replication type tasks.

+
continuous?: boolean

The replication configured to be continuous. Available for replication type tasks.

+
database: string

Source database.

+
design_document?: string

The design document that belongs to this task. Available for indexer, search_indexer, view_compaction + type tasks.

+
doc_id?: string

Replication document ID. Available for replication type tasks.

+
doc_write_failures?: number

Number of document write failures. Available for replication type tasks.

+
docs_read?: number

Number of documents read. Available for replication type tasks.

+
docs_written?: number

Number of documents written to target. Available for replication type tasks.

+
index?: string

The search index that belongs to this task. Available for search_indexer type tasks.

+
indexer_pid?: string

Indexer process ID. Available for indexer type tasks.

+
missing_revisions_found?: number

The count of docs which have been read from the source. Available for replication type tasks.

+
node: string

Cluster node where the task is running.

+
phase?: string

The phase the active task is in. docid_sort, docid_copy, document_copy phases are available for + database_compaction, while ids and view phases are available for view_compaction type tasks.

+
pid: string

Process ID.

+
process_status?: string

Process status.

+
progress?: number

Current percentage progress. Available for database_compaction, indexer, search_indexer, + view_compaction type tasks.

+
replication_id?: string

Replication ID. Available for replication type tasks.

+
retry?: boolean

Indicates whether a compaction retry is currently running on the database. Available for + database_compaction type tasks.

+
revisions_checked?: number

The count of revisions which have been checked since this replication began. Available for replication + type tasks.

+
source?: string

Replication source. Available for replication type tasks.

+
source_seq?: string

The last sequence number obtained from the source database changes feed. Available for replication type + tasks.

+
started_on: number

Schema for a Unix epoch timestamp.

+
target?: string

Replication target. Available for replication type tasks.

+
through_seq?: string

The last sequence number processed by the replicator. Available for replication type tasks.

+
total_changes?: number

Total changes to process. Available for database_compaction, indexer, search_indexer, + view_compaction type tasks.

+
type: string

Operation type.

+
updated_on: number

Schema for a Unix epoch timestamp.

+
user?: string

Name of user running replication or owning the indexer. Available for indexer, replication type tasks.

+
view?: number

Number of view indexes. Available for view_compaction type tasks.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ActivityTrackerEvents-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ActivityTrackerEvents-1.html new file mode 100644 index 000000000..5c2bc426b --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ActivityTrackerEvents-1.html @@ -0,0 +1,5 @@ +ActivityTrackerEvents | @ibm-cloud/cloudant - v0.8.1

Schema for Activity Tracker events.

+
interface ActivityTrackerEvents {
    types: string[] | export=.ActivityTrackerEvents.Constants.Types[];
}

Properties

Properties

An array of event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance. + "management" is a required element of this array.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.AllDocsQueriesResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.AllDocsQueriesResult.html new file mode 100644 index 000000000..22e45c460 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.AllDocsQueriesResult.html @@ -0,0 +1,5 @@ +AllDocsQueriesResult | @ibm-cloud/cloudant - v0.8.1

Schema for the result of an all documents queries operation.

+
interface AllDocsQueriesResult {
    results: AllDocsResult[];
}

Properties

Properties

results: AllDocsResult[]

An array of result objects - one for each query. Each result object contains the same fields as the response + to a regular /_all_docs request.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.AllDocsQuery.html b/docs/0.8.1/interfaces/cloudant_v1.export_.AllDocsQuery.html new file mode 100644 index 000000000..68213acc0 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.AllDocsQuery.html @@ -0,0 +1,31 @@ +AllDocsQuery | @ibm-cloud/cloudant - v0.8.1

Schema for an all documents query operation.

+
interface AllDocsQuery {
    att_encoding_info?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    descending?: boolean;
    end_key?: string;
    include_docs?: boolean;
    inclusive_end?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    skip?: number;
    start_key?: string;
    update_seq?: boolean;
}

Properties

att_encoding_info?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
end_key?: string

Schema for a document ID.

+
include_docs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusive_end?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
start_key?: string

Schema for a document ID.

+
update_seq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.AllDocsResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.AllDocsResult.html new file mode 100644 index 000000000..99c7492f8 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.AllDocsResult.html @@ -0,0 +1,8 @@ +AllDocsResult | @ibm-cloud/cloudant - v0.8.1

Schema for the result of an all documents operation.

+
interface AllDocsResult {
    rows: DocsResultRow[];
    total_rows: number;
    update_seq?: string;
}

Properties

List of doc results.

+
total_rows: number

Number of total rows.

+
update_seq?: string

Current update sequence for the database.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.Analyzer-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.Analyzer-1.html new file mode 100644 index 000000000..bb8c9013d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.Analyzer-1.html @@ -0,0 +1,11 @@ +Analyzer | @ibm-cloud/cloudant - v0.8.1

Schema for a full text search analyzer.

+
interface Analyzer {
    name?: string;
    stopwords?: string[];
}

Properties

Properties

name?: string

Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies + depending on the analyzer usage:

+
    +
  • For search indexes the default is standard * For query text indexes the default is keyword * For a query + text index default_field the default is standard.
  • +
+
stopwords?: string[]

Custom stopwords to use with the named analyzer.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.AnalyzerConfiguration-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.AnalyzerConfiguration-1.html new file mode 100644 index 000000000..ebbf36458 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.AnalyzerConfiguration-1.html @@ -0,0 +1,13 @@ +AnalyzerConfiguration | @ibm-cloud/cloudant - v0.8.1

Schema for a search analyzer configuration.

+
interface AnalyzerConfiguration {
    fields?: JsonObject;
    name?: string;
    stopwords?: string[];
}

Properties

Properties

fields?: JsonObject

Schema for mapping a field name to a per field analyzer.

+
name?: string

Schema for the name of the Apache Lucene analyzer to use for text indexing. The default value varies + depending on the analyzer usage:

+
    +
  • For search indexes the default is standard * For query text indexes the default is keyword * For a query + text index default_field the default is standard.
  • +
+
stopwords?: string[]

Custom stopwords to use with the named analyzer.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ApiKeysResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ApiKeysResult.html new file mode 100644 index 000000000..d33d8e23c --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ApiKeysResult.html @@ -0,0 +1,8 @@ +ApiKeysResult | @ibm-cloud/cloudant - v0.8.1

Schema for api keys.

+
interface ApiKeysResult {
    key: string;
    ok: boolean;
    password: string;
}

Properties

Properties

key: string

The generated api key.

+
ok: boolean

ok.

+
password: string

The password associated with the api key.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.Attachment.html b/docs/0.8.1/interfaces/cloudant_v1.export_.Attachment.html new file mode 100644 index 000000000..3fa6b6c82 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.Attachment.html @@ -0,0 +1,27 @@ +Attachment | @ibm-cloud/cloudant - v0.8.1

Schema for an attachment.

+
interface Attachment {
    content_type?: string;
    data?: string;
    digest?: string;
    encoded_length?: number;
    encoding?: string;
    follows?: boolean;
    length?: number;
    revpos?: number;
    stub?: boolean;
}

Properties

content_type?: string

Attachment MIME type.

+
data?: string

Base64-encoded content. Available if attachment content is requested by using the query parameters + attachments=true or atts_since. Note that when used with a view or changes feed include_docs must also be + true.

+
digest?: string

Content hash digest. It starts with prefix which announce hash type (e.g. md5-) and continues with + Base64-encoded hash digest.

+
encoded_length?: number

Compressed attachment size in bytes. Available if content_type was in list of compressible types when the + attachment was added and the query parameter att_encoding_info is true. Note that when used with a view or + changes feed include_docs must also be true.

+
encoding?: string

Compression codec. Available if content_type was in list of compressible types when the attachment was added + and the and the query parameter att_encoding_info is true. Note that when used with a view or changes feed + include_docs must also be true.

+
follows?: boolean

True if the attachment follows in a multipart request or response.

+
length?: number

Real attachment size in bytes. Not available if inline attachment content requested.

+
revpos?: number

Revision number when attachment was added.

+
stub?: boolean

Has true value if object contains stub info and no content. Otherwise omitted in response.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.BulkDocs.html b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkDocs.html new file mode 100644 index 000000000..f144eaf4f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkDocs.html @@ -0,0 +1,6 @@ +BulkDocs | @ibm-cloud/cloudant - v0.8.1

Schema for submitting documents for bulk modifications.

+
interface BulkDocs {
    docs: Document[];
    new_edits?: boolean;
}

Properties

Properties

docs: Document[]

Array of documents.

+
new_edits?: boolean

If false, prevents the database from assigning them new revision IDs. Default is true.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetQueryDocument.html b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetQueryDocument.html new file mode 100644 index 000000000..5050b542f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetQueryDocument.html @@ -0,0 +1,8 @@ +BulkGetQueryDocument | @ibm-cloud/cloudant - v0.8.1

Schema for a document item in a bulk get query.

+
interface BulkGetQueryDocument {
    atts_since?: string[];
    id: string;
    rev?: string;
}

Properties

Properties

atts_since?: string[]

Includes attachments only since specified revisions.

+
id: string

Schema for a document ID.

+
rev?: string

Schema for a document revision identifier.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetResult.html new file mode 100644 index 000000000..9f71da644 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetResult.html @@ -0,0 +1,4 @@ +BulkGetResult | @ibm-cloud/cloudant - v0.8.1

Schema for the results object of a bulk get operation.

+
interface BulkGetResult {
    results: BulkGetResultItem[];
}

Properties

Properties

Results.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetResultDocument.html b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetResultDocument.html new file mode 100644 index 000000000..c21c3d3f0 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetResultDocument.html @@ -0,0 +1,6 @@ +BulkGetResultDocument | @ibm-cloud/cloudant - v0.8.1

Schema for BulkGetResult object containing a successfully retrieved document or error information.

+
interface BulkGetResultDocument {
    error?: DocumentResult;
    ok?: Document;
}

Properties

Properties

Schema for the result of a document modification.

+

Schema for a document.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetResultItem.html b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetResultItem.html new file mode 100644 index 000000000..67ecc17bf --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.BulkGetResultItem.html @@ -0,0 +1,6 @@ +BulkGetResultItem | @ibm-cloud/cloudant - v0.8.1

Schema for the document revisions information from a bulk get operation.

+
interface BulkGetResultItem {
    docs: BulkGetResultDocument[];
    id: string;
}

Properties

docs +id +

Properties

Array of document revisions or error information.

+
id: string

Schema for a document ID.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.CapacityThroughputInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.CapacityThroughputInformation.html new file mode 100644 index 000000000..7ca23d24a --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.CapacityThroughputInformation.html @@ -0,0 +1,6 @@ +CapacityThroughputInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about the currently provisioned and target throughput capacity.

+
interface CapacityThroughputInformation {
    current: CapacityThroughputInformationCurrent;
    target?: CapacityThroughputInformationTarget;
}

Properties

Properties

Detailed information about provisioned throughput capacity.

+

Detailed information about target throughput capacity.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.CapacityThroughputInformationCurrent.html b/docs/0.8.1/interfaces/cloudant_v1.export_.CapacityThroughputInformationCurrent.html new file mode 100644 index 000000000..3f9069b63 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.CapacityThroughputInformationCurrent.html @@ -0,0 +1,5 @@ +CapacityThroughputInformationCurrent | @ibm-cloud/cloudant - v0.8.1

Detailed information about provisioned throughput capacity.

+
interface CapacityThroughputInformationCurrent {
    throughput: ThroughputInformation;
}

Properties

Properties

Schema for detailed information about throughput capacity with breakdown by specific throughput requests + classes.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.CapacityThroughputInformationTarget.html b/docs/0.8.1/interfaces/cloudant_v1.export_.CapacityThroughputInformationTarget.html new file mode 100644 index 000000000..ecd5dd8c6 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.CapacityThroughputInformationTarget.html @@ -0,0 +1,5 @@ +CapacityThroughputInformationTarget | @ibm-cloud/cloudant - v0.8.1

Detailed information about target throughput capacity.

+
interface CapacityThroughputInformationTarget {
    throughput: ThroughputInformation;
}

Properties

Properties

Schema for detailed information about throughput capacity with breakdown by specific throughput requests + classes.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.Change.html b/docs/0.8.1/interfaces/cloudant_v1.export_.Change.html new file mode 100644 index 000000000..caa32c256 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.Change.html @@ -0,0 +1,4 @@ +Change | @ibm-cloud/cloudant - v0.8.1

Schema for a document leaf with single field rev.

+
interface Change {
    rev: string;
}

Properties

rev +

Properties

rev: string

Schema for a document revision identifier.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ChangesResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ChangesResult.html new file mode 100644 index 000000000..37a8b0bd1 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ChangesResult.html @@ -0,0 +1,8 @@ +ChangesResult | @ibm-cloud/cloudant - v0.8.1

Schema for normal changes feed result.

+
interface ChangesResult {
    last_seq: string;
    pending: number;
    results: ChangesResultItem[];
}

Properties

Properties

last_seq: string

last_seq.

+
pending: number

pending.

+

results.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ChangesResultItem.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ChangesResultItem.html new file mode 100644 index 000000000..131cee27f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ChangesResultItem.html @@ -0,0 +1,12 @@ +ChangesResultItem | @ibm-cloud/cloudant - v0.8.1

Schema for an item in the changes results array.

+
interface ChangesResultItem {
    changes: Change[];
    deleted?: boolean;
    doc?: Document;
    id: string;
    seq: string;
}

Properties

Properties

changes: Change[]

List of document's leaves with single field rev.

+
deleted?: boolean

if true then the document is deleted.

+
doc?: Document

Schema for a document.

+
id: string

Schema for a document ID.

+
seq: string

Update sequence.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ContentInformationSizes.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ContentInformationSizes.html new file mode 100644 index 000000000..b7409c824 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ContentInformationSizes.html @@ -0,0 +1,8 @@ +ContentInformationSizes | @ibm-cloud/cloudant - v0.8.1

Schema for size information of content.

+
interface ContentInformationSizes {
    active: number;
    external: number;
    file: number;
}

Properties

Properties

active: number

The active size of the content, in bytes.

+
external: number

The total uncompressed size of the content, in bytes.

+
file: number

The total size of the content as stored on disk, in bytes.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.CorsInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.CorsInformation.html new file mode 100644 index 000000000..cac4a25be --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.CorsInformation.html @@ -0,0 +1,11 @@ +CorsInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about the CORS configuration.

+
interface CorsInformation {
    allow_credentials: boolean;
    enable_cors: boolean;
    origins: string[];
}

Properties

allow_credentials: boolean

Boolean value to allow authentication credentials. If set to true, browser requests must be done by using + withCredentials = true.

+
enable_cors: boolean

Boolean value to turn CORS on and off.

+
origins: string[]

An array of strings that contain allowed origin domains. You have to specify the full URL including the + protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you + have to specify all subdomains used.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.CurrentThroughputInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.CurrentThroughputInformation.html new file mode 100644 index 000000000..c3364144e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.CurrentThroughputInformation.html @@ -0,0 +1,4 @@ +CurrentThroughputInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about current consumption of a provisioned throughput capacity.

+
interface CurrentThroughputInformation {
    throughput: CurrentThroughputInformationThroughput;
}

Properties

Properties

Detailed information about current consumption.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.CurrentThroughputInformationThroughput.html b/docs/0.8.1/interfaces/cloudant_v1.export_.CurrentThroughputInformationThroughput.html new file mode 100644 index 000000000..c4177adbd --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.CurrentThroughputInformationThroughput.html @@ -0,0 +1,8 @@ +CurrentThroughputInformationThroughput | @ibm-cloud/cloudant - v0.8.1

Detailed information about current consumption.

+
interface CurrentThroughputInformationThroughput {
    query: number;
    read: number;
    write: number;
}

Properties

Properties

query: number

Number of global queries conducted against the instance for a given second.

+
read: number

Number of reads conducted against the instance for a given second.

+
write: number

Number of writes conducted against the instance for a given second.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DatabaseInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DatabaseInformation.html new file mode 100644 index 000000000..b3cb3c96d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DatabaseInformation.html @@ -0,0 +1,31 @@ +DatabaseInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about a database.

+
interface DatabaseInformation {
    cluster: DatabaseInformationCluster;
    committed_update_seq?: string;
    compact_running: boolean;
    compacted_seq?: string;
    db_name: string;
    disk_format_version: number;
    doc_count: number;
    doc_del_count: number;
    engine?: string;
    partitioned_indexes?: PartitionedIndexesInformation;
    props: DatabaseInformationProps;
    sizes: ContentInformationSizes;
    update_seq: string;
    uuid?: string;
}

Properties

Schema for database cluster information.

+
committed_update_seq?: string

An opaque string that describes the committed state of the database.

+
compact_running: boolean

True if the database compaction routine is operating on this database.

+
compacted_seq?: string

An opaque string that describes the compaction state of the database.

+
db_name: string

The name of the database.

+
disk_format_version: number

The version of the physical format used for the data when it is stored on disk.

+
doc_count: number

A count of the documents in the specified database.

+
doc_del_count: number

Number of deleted documents.

+
engine?: string

The engine used for the database.

+
partitioned_indexes?: PartitionedIndexesInformation

Information about database's partitioned indexes.

+

Schema for database properties.

+

Schema for size information of content.

+
update_seq: string

An opaque string that describes the state of the database. Do not rely on this string for counting the + number of updates.

+
uuid?: string

The UUID of the database.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DatabaseInformationCluster.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DatabaseInformationCluster.html new file mode 100644 index 000000000..8f80765ff --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DatabaseInformationCluster.html @@ -0,0 +1,11 @@ +DatabaseInformationCluster | @ibm-cloud/cloudant - v0.8.1

Schema for database cluster information.

+
interface DatabaseInformationCluster {
    n: number;
    q: number;
    r: number;
    w: number;
}

Properties

n +q +r +w +

Properties

n: number

Schema for the number of replicas of a database in a cluster. The cluster is using the default value and it + cannot be changed by the user.

+
q: number

Schema for the number of shards in a database. Each shard is a partition of the hash value range.

+
r: number

Read quorum. The number of consistent copies of a document that need to be read before a successful reply.

+
w: number

Write quorum. The number of copies of a document that need to be written before a successful reply.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DatabaseInformationProps.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DatabaseInformationProps.html new file mode 100644 index 000000000..5628b73a3 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DatabaseInformationProps.html @@ -0,0 +1,4 @@ +DatabaseInformationProps | @ibm-cloud/cloudant - v0.8.1

Schema for database properties.

+
interface DatabaseInformationProps {
    partitioned?: boolean;
}

Properties

Properties

partitioned?: boolean

The value is true for a partitioned database.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DbEvent-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DbEvent-1.html new file mode 100644 index 000000000..c6dcfe84e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DbEvent-1.html @@ -0,0 +1,8 @@ +DbEvent | @ibm-cloud/cloudant - v0.8.1

Schema for a database change event.

+
interface DbEvent {
    db_name: string;
    seq: string;
    type: string;
}

Properties

Properties

db_name: string

Database name.

+
seq: string

Sequence number.

+
type: string

A database event.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DbUpdates.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DbUpdates.html new file mode 100644 index 000000000..46e1b9737 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DbUpdates.html @@ -0,0 +1,6 @@ +DbUpdates | @ibm-cloud/cloudant - v0.8.1

Schema for database updates.

+
interface DbUpdates {
    last_seq: string;
    results: DbEvent[];
}

Properties

Properties

last_seq: string

Last sequence number.

+
results: DbEvent[]

results.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DbsInfoResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DbsInfoResult.html new file mode 100644 index 000000000..eb0811a7c --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DbsInfoResult.html @@ -0,0 +1,8 @@ +DbsInfoResult | @ibm-cloud/cloudant - v0.8.1

Schema for database information keyed by database name.

+
interface DbsInfoResult {
    error?: string;
    info?: DatabaseInformation;
    key: string;
}

Properties

Properties

error?: string

The name of the error.

+

Schema for information about a database.

+
key: string

Database name.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteAttachmentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteAttachmentParams.html new file mode 100644 index 000000000..0de0caf76 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteAttachmentParams.html @@ -0,0 +1,16 @@ +DeleteAttachmentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the deleteAttachment operation.

+
interface DeleteAttachmentParams {
    attachmentName: string;
    batch?: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

attachmentName: string

Path parameter to specify the attachment name.

+
batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteDatabaseParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteDatabaseParams.html new file mode 100644 index 000000000..54ca9ca6f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteDatabaseParams.html @@ -0,0 +1,5 @@ +DeleteDatabaseParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the deleteDatabase operation.

+
interface DeleteDatabaseParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteDesignDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteDesignDocumentParams.html new file mode 100644 index 000000000..b8f13eb9e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteDesignDocumentParams.html @@ -0,0 +1,15 @@ +DeleteDesignDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the deleteDesignDocument operation.

+
interface DeleteDesignDocumentParams {
    batch?: string;
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteDocumentParams.html new file mode 100644 index 000000000..970fbf884 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteDocumentParams.html @@ -0,0 +1,14 @@ +DeleteDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the deleteDocument operation.

+
interface DeleteDocumentParams {
    batch?: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteIndexParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteIndexParams.html new file mode 100644 index 000000000..ba3490ec2 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteIndexParams.html @@ -0,0 +1,12 @@ +DeleteIndexParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the deleteIndex operation.

+
interface DeleteIndexParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    index: string;
    type: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
index: string

Path parameter to specify the index name.

+
type: string

Path parameter to specify the index type.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteLocalDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteLocalDocumentParams.html new file mode 100644 index 000000000..64756fbcb --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteLocalDocumentParams.html @@ -0,0 +1,10 @@ +DeleteLocalDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the deleteLocalDocument operation.

+
interface DeleteLocalDocumentParams {
    batch?: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteReplicationDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteReplicationDocumentParams.html new file mode 100644 index 000000000..00907982a --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DeleteReplicationDocumentParams.html @@ -0,0 +1,12 @@ +DeleteReplicationDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the deleteReplicationDocument operation.

+
interface DeleteReplicationDocumentParams {
    batch?: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocument.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocument.html new file mode 100644 index 000000000..78cf8ca89 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocument.html @@ -0,0 +1,95 @@ +DesignDocument | @ibm-cloud/cloudant - v0.8.1

Schema for a design document.

+
interface DesignDocument {
    _attachments?: JsonObject;
    _conflicts?: string[];
    _deleted?: boolean;
    _deleted_conflicts?: string[];
    _id?: string;
    _local_seq?: string;
    _rev?: string;
    _revisions?: Revisions;
    _revs_info?: DocumentRevisionStatus[];
    autoupdate?: boolean;
    filters?: JsonObject;
    indexes?: JsonObject;
    language?: string;
    options?: DesignDocumentOptions;
    validate_doc_update?: string;
    views?: JsonObject;
    [propName: string]: any;
}

Indexable

[propName: string]: any

DesignDocument accepts additional properties.

+

Properties

_attachments?: JsonObject

Schema for a map of attachment name to attachment metadata.

+
_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_deleted?: boolean

Deletion flag. Available if document was removed.

+
_deleted_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_id?: string

Document ID.

+
_local_seq?: string

Document's update sequence in current database. Available if requested with local_seq=true query parameter.

+
_rev?: string

Schema for a document revision identifier.

+
_revisions?: Revisions

Schema for list of revision information.

+
_revs_info?: DocumentRevisionStatus[]

Schema for a list of objects with information about local revisions and their status.

+
autoupdate?: boolean

Indicates whether to automatically build indexes defined in this design document.

+
filters?: JsonObject

Schema for filter functions definition. This schema is a map where keys are the names of the filter + functions and values are the function definition in string format.

+

Filter function formats, or filters the changes feed that pass filter rules. The function takes 2 parameters:

+
    +
  • doc: The document that is being processed.

    +
  • +
  • req: A Request JavaScript object with these properties:

    +
      +
    • body - string, Request body data as string. +If the request method is GET this field contains the value +"undefined". +If the method is DELETE or HEAD the value is "" (empty string).
    • +
    • cookie - Cookies object.
    • +
    • form - Form Data object, contains the decoded body as key-value +pairs if the Content-Type header was +application/x-www-form-urlencoded.
    • +
    • headers - Request Headers object.
    • +
    • id - string, requested document id if it was specified +or null otherwise.
    • +
    • info - Database Information object, +see DatabaseInformation.
    • +
    • method - string or an array of chars, request method. +String value is a method as one of: HEAD, GET, POST, PUT, +DELETE, OPTIONS, TRACE, COPY. For not supported methods +it will be represented as an array of char codes e.g. for VIEW +it will be 86,73,69,87.
    • +
    • path - array of strings, requested path sections.
    • +
    • peer - string, request source IP address.
    • +
    • query - string, URL query parameters object. Note that multiple +keys are not supported and the last key value suppresses others.
    • +
    • requested_path - array of strings, +actual requested path section.
    • +
    • raw_path - string, raw requested path.
    • +
    • userCtx: User Context Object, containing information about the +user writing the document (if present), see the UserContext.
    • +
    • secObj: Security Object, with lists of database security roles, +see the SecurityObject.
    • +
    • uuid - string, generated UUID by a specified algorithm in the +config file.
    • +
    +
  • +
+

Filter functions must return true if a document passed all the rules.

+
indexes?: JsonObject

Search (text) index function definitions.

+
language?: string

Defines Query Server key to process design document functions.

+

Schema for design document options.

+
validate_doc_update?: string

Validate document update function can be used to prevent invalid or unauthorized document update requests + from being stored. Validation functions typically examine the structure of the new document to ensure that + required fields are present and to verify that the requesting user should be allowed to make changes to the + document properties. When a write request is received for a given database, the validation function in each + design document in that database is called in an unspecified order. If any of the validation functions throw an + error, the write will not succeed.

+

The validation function can abort the pending document write by throwing one of two error objects:

+
// user is not authorized to make the change but may re-authenticate throw({ unauthorized: 'Error message here.'
});

// change is not allowed throw({ forbidden: 'Error message here.' }); +
+

The function takes 4 parameters:

+
    +
  • newDoc - New version of document that will be stored +from the update request.
  • +
  • oldDoc - Previous version of document that is already stored.
  • +
  • userCtx - User Context Object, containing information about the +user writing the document (if present), see the UserContext.
  • +
  • secObj - Security Object, with lists of database security roles, +see the SecurityObject.
  • +
+
views?: JsonObject

Schema for design document views.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentInformation.html new file mode 100644 index 000000000..50e962df7 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentInformation.html @@ -0,0 +1,6 @@ +DesignDocumentInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about a design document.

+
interface DesignDocumentInformation {
    name: string;
    view_index: DesignDocumentViewIndex;
}

Properties

Properties

name: string

name.

+

View index information.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentOptions.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentOptions.html new file mode 100644 index 000000000..c415074eb --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentOptions.html @@ -0,0 +1,4 @@ +DesignDocumentOptions | @ibm-cloud/cloudant - v0.8.1

Schema for design document options.

+
interface DesignDocumentOptions {
    partitioned?: boolean;
}

Properties

Properties

partitioned?: boolean

Whether this design document describes partitioned or global indexes.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentViewIndex.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentViewIndex.html new file mode 100644 index 000000000..ae789ae39 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentViewIndex.html @@ -0,0 +1,21 @@ +DesignDocumentViewIndex | @ibm-cloud/cloudant - v0.8.1

View index information.

+
interface DesignDocumentViewIndex {
    collator_versions: string[];
    compact_running: boolean;
    language: string;
    signature: string;
    sizes: ContentInformationSizes;
    updater_running: boolean;
    updates_pending: UpdatesPending;
    waiting_clients: number;
    waiting_commit: boolean;
}

Properties

collator_versions: string[]

List of collator versions. If there are multiple entries this implies a libicu upgrade has occurred but + compaction has not run yet.

+
compact_running: boolean

Indicates whether a compaction routine is currently running on the view.

+
language: string

Language for the defined views.

+
signature: string

MD5 signature of the views for the design document.

+

Schema for size information of content.

+
updater_running: boolean

Indicates if the view is currently being updated.

+
updates_pending: UpdatesPending

Schema for an ability to tell if view is up-to-date without querying it.

+
waiting_clients: number

Number of clients waiting on views from this design document.

+
waiting_commit: boolean

Indicates if there are outstanding commits to the underlying database that need to processed.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentViewsMapReduce.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentViewsMapReduce.html new file mode 100644 index 000000000..d2bbf7a6f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DesignDocumentViewsMapReduce.html @@ -0,0 +1,6 @@ +DesignDocumentViewsMapReduce | @ibm-cloud/cloudant - v0.8.1

Schema for view functions definition.

+
interface DesignDocumentViewsMapReduce {
    map: string;
    reduce?: string;
}

Properties

Properties

map: string

JavaScript map function as a string.

+
reduce?: string

JavaScript reduce function as a string.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DocsResultRow.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DocsResultRow.html new file mode 100644 index 000000000..8f06a0b57 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DocsResultRow.html @@ -0,0 +1,16 @@ +DocsResultRow | @ibm-cloud/cloudant - v0.8.1

Schema for a row of document information in a DocsResult.

+
interface DocsResultRow {
    caused_by?: string;
    doc?: Document;
    error?: string;
    id?: string;
    key: string;
    reason?: string;
    value?: DocsResultRowValue;
}

Properties

caused_by?: string

The cause of the error (if available).

+
doc?: Document

Schema for a document.

+
error?: string

The name of the error.

+
id?: string

id.

+
key: string

Document ID.

+
reason?: string

The reason the error occurred (if available).

+

Value of built-in /_all_docs style view.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DocsResultRowValue.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DocsResultRowValue.html new file mode 100644 index 000000000..2a202c381 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DocsResultRowValue.html @@ -0,0 +1,6 @@ +DocsResultRowValue | @ibm-cloud/cloudant - v0.8.1

Value of built-in /_all_docs style view.

+
interface DocsResultRowValue {
    deleted?: boolean;
    rev: string;
}

Properties

Properties

deleted?: boolean

If true then the document is deleted. Not present for undeleted documents.

+
rev: string

Schema for a document revision identifier.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.Document.html b/docs/0.8.1/interfaces/cloudant_v1.export_.Document.html new file mode 100644 index 000000000..074ad351e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.Document.html @@ -0,0 +1,21 @@ +Document | @ibm-cloud/cloudant - v0.8.1

Schema for a document.

+
interface Document {
    _attachments?: JsonObject;
    _conflicts?: string[];
    _deleted?: boolean;
    _deleted_conflicts?: string[];
    _id?: string;
    _local_seq?: string;
    _rev?: string;
    _revisions?: Revisions;
    _revs_info?: DocumentRevisionStatus[];
    [propName: string]: any;
}

Indexable

[propName: string]: any

Document accepts additional properties.

+

Properties

_attachments?: JsonObject

Schema for a map of attachment name to attachment metadata.

+
_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_deleted?: boolean

Deletion flag. Available if document was removed.

+
_deleted_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_id?: string

Document ID.

+
_local_seq?: string

Document's update sequence in current database. Available if requested with local_seq=true query parameter.

+
_rev?: string

Schema for a document revision identifier.

+
_revisions?: Revisions

Schema for list of revision information.

+
_revs_info?: DocumentRevisionStatus[]

Schema for a list of objects with information about local revisions and their status.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DocumentResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DocumentResult.html new file mode 100644 index 000000000..ec256525e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DocumentResult.html @@ -0,0 +1,14 @@ +DocumentResult | @ibm-cloud/cloudant - v0.8.1

Schema for the result of a document modification.

+
interface DocumentResult {
    caused_by?: string;
    error?: string;
    id: string;
    ok?: boolean;
    reason?: string;
    rev?: string;
}

Properties

Properties

caused_by?: string

The cause of the error (if available).

+
error?: string

The name of the error.

+
id: string

Schema for a document ID.

+
ok?: boolean

ok.

+
reason?: string

The reason the error occurred (if available).

+
rev?: string

Schema for a document revision identifier.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DocumentRevisionStatus-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DocumentRevisionStatus-1.html new file mode 100644 index 000000000..984beefbd --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DocumentRevisionStatus-1.html @@ -0,0 +1,7 @@ +DocumentRevisionStatus | @ibm-cloud/cloudant - v0.8.1

Schema for information about revisions and their status.

+
interface DocumentRevisionStatus {
    rev: string;
    status: string;
}

Properties

Properties

rev: string

Schema for a document revision identifier.

+
status: string

Status of the revision. May be one of: - available: Revision is available for retrieving with rev query + parameter - missing: Revision is not available - deleted: Revision belongs to deleted document.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.DocumentShardInfo.html b/docs/0.8.1/interfaces/cloudant_v1.export_.DocumentShardInfo.html new file mode 100644 index 000000000..c7c213b4c --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.DocumentShardInfo.html @@ -0,0 +1,6 @@ +DocumentShardInfo | @ibm-cloud/cloudant - v0.8.1

Schema for document shard information.

+
interface DocumentShardInfo {
    nodes: string[];
    range: string;
}

Properties

Properties

nodes: string[]

List of nodes serving a replica of the shard.

+
range: string

The shard range in which the document is stored.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.EmptyObject.html b/docs/0.8.1/interfaces/cloudant_v1.export_.EmptyObject.html new file mode 100644 index 000000000..aa031b89e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.EmptyObject.html @@ -0,0 +1,2 @@ +EmptyObject | @ibm-cloud/cloudant - v0.8.1

The body of a service request that returns no response data.

+
interface EmptyObject {}

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ExecutionStats.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ExecutionStats.html new file mode 100644 index 000000000..606451a86 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ExecutionStats.html @@ -0,0 +1,12 @@ +ExecutionStats | @ibm-cloud/cloudant - v0.8.1

Schema for find query execution statistics.

+
interface ExecutionStats {
    execution_time_ms: number;
    results_returned: number;
    total_docs_examined: number;
    total_keys_examined: number;
    total_quorum_docs_examined: number;
}

Properties

execution_time_ms: number

Time to execute the query.

+
results_returned: number

Number of results returned.

+
total_docs_examined: number

Number of documents fetched from the index.

+
total_keys_examined: number

Number of rows scanned in the index.

+
total_quorum_docs_examined: number

Number of documents fetched from the primary index with the specified read quorum.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ExplainResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ExplainResult.html new file mode 100644 index 000000000..d839f0052 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ExplainResult.html @@ -0,0 +1,47 @@ +ExplainResult | @ibm-cloud/cloudant - v0.8.1

Schema for information about the index used for a find query.

+
interface ExplainResult {
    covering: boolean;
    dbname: string;
    fields: string[];
    index: IndexInformation;
    limit: number;
    mrargs?: ExplainResultMrArgs;
    opts: ExplainResultOpts;
    partitioned?: any;
    selector: JsonObject;
    skip: number;
}

Properties

covering: boolean

When true, the query is answered using the index only and no documents are fetched.

+
dbname: string

Name of database.

+
fields: string[]

Fields that were requested to be projected from the document. If no fields were requested to be projected + this will be empty and all fields will be returned.

+

Schema for information about an index.

+
limit: number

The used maximum number of results returned.

+

Arguments passed to the underlying view.

+

Options used for the request.

+
partitioned?: any

Schema for any JSON type.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
skip: number

Skip parameter used.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ExplainResultMrArgs-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ExplainResultMrArgs-1.html new file mode 100644 index 000000000..60cc7b593 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ExplainResultMrArgs-1.html @@ -0,0 +1,25 @@ +ExplainResultMrArgs | @ibm-cloud/cloudant - v0.8.1

Arguments passed to the underlying view.

+
interface ExplainResultMrArgs {
    conflicts?: any;
    direction?: string;
    end_key?: any;
    include_docs?: boolean;
    partition?: string;
    reduce?: boolean;
    stable?: boolean;
    start_key?: any;
    update?: any;
    view_type?: string;
}

Properties

conflicts?: any

Schema for any JSON type.

+
direction?: string

Direction parameter passed to the underlying view.

+
end_key?: any

Schema for any JSON type.

+
include_docs?: boolean

A parameter that specifies whether to include the full content of the documents in the response in the + underlying view.

+
partition?: string

Partition parameter passed to the underlying view.

+
reduce?: boolean

A parameter that specifies returning only documents that match any of the specified keys in the underlying + view.

+
stable?: boolean

A parameter that specifies whether the view results should be returned form a "stable" set of shards passed + to the underlying view.

+
start_key?: any

Schema for any JSON type.

+
update?: any

Schema for any JSON type.

+
view_type?: string

The type of the underlying view.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ExplainResultOpts.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ExplainResultOpts.html new file mode 100644 index 000000000..6cfe35ce6 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ExplainResultOpts.html @@ -0,0 +1,30 @@ +ExplainResultOpts | @ibm-cloud/cloudant - v0.8.1

Options used for the request.

+
interface ExplainResultOpts {
    bookmark: string;
    conflicts: boolean;
    execution_stats: boolean;
    fields: string[];
    limit: number;
    partition: string;
    r: number;
    skip: number;
    sort: any;
    stable: boolean;
    stale: boolean;
    update: boolean;
    use_index: string[];
}

Properties

bookmark: string

Opaque bookmark token used when paginating results.

+
conflicts: boolean

Conflicts used in the request query.

+
execution_stats: boolean

Execution statistics used in the request query.

+
fields: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be + returned. If it is omitted or empty, the entire document is returned.

+
limit: number

Limit used in the request query.

+
partition: string

On which database partition the request was used. If it was not used on a database partition, it returns + with "".

+
r: number

The read quorum that is needed for the result.

+
skip: number

Skip used in the request query.

+
sort: any

Schema for any JSON type.

+
stable: boolean

Stable used in the request query.

+
stale: boolean

Deprecated: Stale used in the request query.

+
update: boolean

Update used in the request query.

+
use_index: string[]

Use index used in the request query.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.FindResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.FindResult.html new file mode 100644 index 000000000..4f17e87b0 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.FindResult.html @@ -0,0 +1,10 @@ +FindResult | @ibm-cloud/cloudant - v0.8.1

Schema for the result of a query find operation.

+
interface FindResult {
    bookmark: string;
    docs: Document[];
    execution_stats?: ExecutionStats;
    warning?: string;
}

Properties

bookmark: string

Opaque bookmark token used when paginating results.

+
docs: Document[]

Documents matching the selector.

+
execution_stats?: ExecutionStats

Schema for find query execution statistics.

+
warning?: string

warning.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetActiveTasksParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetActiveTasksParams.html new file mode 100644 index 000000000..5a93c0a73 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetActiveTasksParams.html @@ -0,0 +1,3 @@ +GetActiveTasksParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getActiveTasks operation.

+
interface GetActiveTasksParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetActivityTrackerEventsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetActivityTrackerEventsParams.html new file mode 100644 index 000000000..709e28009 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetActivityTrackerEventsParams.html @@ -0,0 +1,3 @@ +GetActivityTrackerEventsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getActivityTrackerEvents operation.

+
interface GetActivityTrackerEventsParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetAllDbsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetAllDbsParams.html new file mode 100644 index 000000000..7efcdab06 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetAllDbsParams.html @@ -0,0 +1,15 @@ +GetAllDbsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getAllDbs operation.

+
interface GetAllDbsParams {
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    limit?: number;
    skip?: number;
    startKey?: string;
}

Properties

descending?: boolean

Query parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Query parameter to specify to stop returning records when the specified key is reached. String + representation of any JSON type that matches the key type emitted by the view function.

+
headers?: OutgoingHttpHeaders
limit?: number

Query parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Query parameter to specify the number of records before starting to return the results.

+
startKey?: string

Query parameter to specify to start returning records from the specified key. String representation of any + JSON type that matches the key type emitted by the view function.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetAttachmentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetAttachmentParams.html new file mode 100644 index 000000000..c89611b82 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetAttachmentParams.html @@ -0,0 +1,20 @@ +GetAttachmentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getAttachment operation.

+
interface GetAttachmentParams {
    accept?: string;
    attachmentName: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    ifNoneMatch?: string;
    range?: string;
    rev?: string;
}

Properties

accept?: string

The type of the response: or /.

+
attachmentName: string

Path parameter to specify the attachment name.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
range?: string

Header parameter to specify the byte range for a request. This allows the implementation of resumable + downloads and skippable streams. This is available for all attachments inside CouchDB.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetCapacityThroughputInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetCapacityThroughputInformationParams.html new file mode 100644 index 000000000..5d6fb69e2 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetCapacityThroughputInformationParams.html @@ -0,0 +1,3 @@ +GetCapacityThroughputInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getCapacityThroughputInformation operation.

+
interface GetCapacityThroughputInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetCorsInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetCorsInformationParams.html new file mode 100644 index 000000000..b88182320 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetCorsInformationParams.html @@ -0,0 +1,3 @@ +GetCorsInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getCorsInformation operation.

+
interface GetCorsInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetCurrentThroughputInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetCurrentThroughputInformationParams.html new file mode 100644 index 000000000..8582410d4 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetCurrentThroughputInformationParams.html @@ -0,0 +1,3 @@ +GetCurrentThroughputInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getCurrentThroughputInformation operation.

+
interface GetCurrentThroughputInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetDatabaseInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDatabaseInformationParams.html new file mode 100644 index 000000000..bb63b2202 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDatabaseInformationParams.html @@ -0,0 +1,5 @@ +GetDatabaseInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getDatabaseInformation operation.

+
interface GetDatabaseInformationParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetDbUpdatesParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDbUpdatesParams.html new file mode 100644 index 000000000..24761878c --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDbUpdatesParams.html @@ -0,0 +1,27 @@ +GetDbUpdatesParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getDbUpdates operation.

+
interface GetDbUpdatesParams {
    feed?: string;
    headers?: OutgoingHttpHeaders;
    heartbeat?: number;
    since?: string;
    timeout?: number;
}

Properties

feed?: string

Query parameter to specify the changes feed type.

+
headers?: OutgoingHttpHeaders
heartbeat?: number

Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off + by default and only applicable for + continuous and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be + true to use a value of 60000.

+

Note: Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an + environment where idle network connections may break, heartbeat is not suitable as a keepalive mechanism. + Instead, consider one of the following options:

+
    +
  • Use the timeout parameter with a value that is compatible with your network environment.
  • +
  • Switch to scheduled usage of one of the non-continuous changes feed types +(normal or longpoll).
  • +
  • Use TCP keepalive.
  • +
+
since?: string

Query parameter to specify to start the results from the change immediately after the given update sequence. + Can be a valid update sequence or now value. Default is 0 i.e. all changes.

+
timeout?: number

Query parameter to specify the maximum period in milliseconds to wait for a change before the response is + sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is + specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum + timeout to prevent undetected dead connections.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetDesignDocumentInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDesignDocumentInformationParams.html new file mode 100644 index 000000000..6331ab780 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDesignDocumentInformationParams.html @@ -0,0 +1,8 @@ +GetDesignDocumentInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getDesignDocumentInformation operation.

+
interface GetDesignDocumentInformationParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetDesignDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDesignDocumentParams.html new file mode 100644 index 000000000..1f0c82007 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDesignDocumentParams.html @@ -0,0 +1,35 @@ +GetDesignDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getDesignDocument operation.

+
interface GetDesignDocumentParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    deletedConflicts?: boolean;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. + Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the + _deleted_conflicts property of the returned document.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of + the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentAsMixedParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentAsMixedParams.html new file mode 100644 index 000000000..4b3f12923 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentAsMixedParams.html @@ -0,0 +1,34 @@ +GetDocumentAsMixedParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getDocumentAsMixed operation.

+
interface GetDocumentAsMixedParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. + Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the + _deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of + the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentAsRelatedParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentAsRelatedParams.html new file mode 100644 index 000000000..2de9a6feb --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentAsRelatedParams.html @@ -0,0 +1,34 @@ +GetDocumentAsRelatedParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getDocumentAsRelated operation.

+
interface GetDocumentAsRelatedParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. + Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the + _deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of + the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentAsStreamParams.html new file mode 100644 index 000000000..86a81bff3 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentAsStreamParams.html @@ -0,0 +1,34 @@ +GetDocumentAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getDocumentAsStream operation.

+
interface GetDocumentAsStreamParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. + Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the + _deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of + the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentParams.html new file mode 100644 index 000000000..0d4c2e49d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentParams.html @@ -0,0 +1,34 @@ +GetDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getDocument operation.

+
interface GetDocumentParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. + Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the + _deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of + the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentShardsInfoParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentShardsInfoParams.html new file mode 100644 index 000000000..61cb2104c --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetDocumentShardsInfoParams.html @@ -0,0 +1,7 @@ +GetDocumentShardsInfoParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getDocumentShardsInfo operation.

+
interface GetDocumentShardsInfoParams {
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetIndexesInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetIndexesInformationParams.html new file mode 100644 index 000000000..9722745db --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetIndexesInformationParams.html @@ -0,0 +1,5 @@ +GetIndexesInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getIndexesInformation operation.

+
interface GetIndexesInformationParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetLocalDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetLocalDocumentParams.html new file mode 100644 index 000000000..a7180f811 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetLocalDocumentParams.html @@ -0,0 +1,18 @@ +GetLocalDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getLocalDocument operation.

+
interface GetLocalDocumentParams {
    accept?: string;
    attEncodingInfo?: boolean;
    attachments?: boolean;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    localSeq?: boolean;
}

Properties

accept?: string

The type of the response: application/json, multipart/mixed, multipart/related, or application/octet-stream.

+
attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetMembershipInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetMembershipInformationParams.html new file mode 100644 index 000000000..1a12726a9 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetMembershipInformationParams.html @@ -0,0 +1,3 @@ +GetMembershipInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getMembershipInformation operation.

+
interface GetMembershipInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetPartitionInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetPartitionInformationParams.html new file mode 100644 index 000000000..b568ad98d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetPartitionInformationParams.html @@ -0,0 +1,7 @@ +GetPartitionInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getPartitionInformation operation.

+
interface GetPartitionInformationParams {
    db: string;
    headers?: OutgoingHttpHeaders;
    partitionKey: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
partitionKey: string

Path parameter to specify the database partition key.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetReplicationDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetReplicationDocumentParams.html new file mode 100644 index 000000000..96b3e7f6a --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetReplicationDocumentParams.html @@ -0,0 +1,32 @@ +GetReplicationDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getReplicationDocument operation.

+
interface GetReplicationDocumentParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    deletedConflicts?: boolean;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    localSeq?: boolean;
    meta?: boolean;
    rev?: string;
    revs?: boolean;
    revsInfo?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. + Active only when include_docs is true.

+
deletedConflicts?: boolean

Query parameter to specify whether to include a list of deleted conflicted revisions in the + _deleted_conflicts property of the returned document.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
localSeq?: boolean

Query parameter to specify whether to include the last update sequence for the document.

+
meta?: boolean

Query parameter to specify whether to include document meta information. Acts the same as specifying all of + the conflicts, deleted_conflicts and open_revs query parameters.

+
rev?: string

Query parameter to specify a document revision.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+
revsInfo?: boolean

Query parameter to specify whether to includes detailed information for all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerDocsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerDocsParams.html new file mode 100644 index 000000000..1bd0377af --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerDocsParams.html @@ -0,0 +1,10 @@ +GetSchedulerDocsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getSchedulerDocs operation.

+
interface GetSchedulerDocsParams {
    headers?: OutgoingHttpHeaders;
    limit?: number;
    skip?: number;
    states?: string[] | States[];
}

Properties

Properties

headers?: OutgoingHttpHeaders
limit?: number

Query parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Query parameter to specify the number of records before starting to return the results.

+
states?: string[] | States[]

Query parameter to include only replication documents in the specified states. String must be a + comma-delimited string.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerDocumentParams.html new file mode 100644 index 000000000..7d96d3e29 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerDocumentParams.html @@ -0,0 +1,5 @@ +GetSchedulerDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getSchedulerDocument operation.

+
interface GetSchedulerDocumentParams {
    docId: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerJobParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerJobParams.html new file mode 100644 index 000000000..6c05688e6 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerJobParams.html @@ -0,0 +1,5 @@ +GetSchedulerJobParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getSchedulerJob operation.

+
interface GetSchedulerJobParams {
    headers?: OutgoingHttpHeaders;
    jobId: string;
}

Properties

Properties

headers?: OutgoingHttpHeaders
jobId: string

Path parameter to specify the replication job id.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerJobsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerJobsParams.html new file mode 100644 index 000000000..d49bca082 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSchedulerJobsParams.html @@ -0,0 +1,7 @@ +GetSchedulerJobsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getSchedulerJobs operation.

+
interface GetSchedulerJobsParams {
    headers?: OutgoingHttpHeaders;
    limit?: number;
    skip?: number;
}

Properties

Properties

headers?: OutgoingHttpHeaders
limit?: number

Query parameter to specify the number of returned jobs to limit the result to.

+
skip?: number

Query parameter to specify the number of records before starting to return the results.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetSearchInfoParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSearchInfoParams.html new file mode 100644 index 000000000..d988ab30e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSearchInfoParams.html @@ -0,0 +1,10 @@ +GetSearchInfoParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getSearchInfo operation.

+
interface GetSearchInfoParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    index: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
index: string

Path parameter to specify the index name.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetSecurityParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSecurityParams.html new file mode 100644 index 000000000..6e4f4afe2 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSecurityParams.html @@ -0,0 +1,5 @@ +GetSecurityParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getSecurity operation.

+
interface GetSecurityParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetServerInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetServerInformationParams.html new file mode 100644 index 000000000..1e86deea6 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetServerInformationParams.html @@ -0,0 +1,3 @@ +GetServerInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getServerInformation operation.

+
interface GetServerInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetSessionInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSessionInformationParams.html new file mode 100644 index 000000000..718772efc --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetSessionInformationParams.html @@ -0,0 +1,3 @@ +GetSessionInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getSessionInformation operation.

+
interface GetSessionInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetShardsInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetShardsInformationParams.html new file mode 100644 index 000000000..e19402bfd --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetShardsInformationParams.html @@ -0,0 +1,5 @@ +GetShardsInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getShardsInformation operation.

+
interface GetShardsInformationParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetUpInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetUpInformationParams.html new file mode 100644 index 000000000..5488f02fc --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetUpInformationParams.html @@ -0,0 +1,3 @@ +GetUpInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getUpInformation operation.

+
interface GetUpInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.GetUuidsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.GetUuidsParams.html new file mode 100644 index 000000000..91c7eb9fc --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.GetUuidsParams.html @@ -0,0 +1,5 @@ +GetUuidsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the getUuids operation.

+
interface GetUuidsParams {
    count?: number;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

count?: number

Query parameter to specify the number of UUIDs to return.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.HeadAttachmentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadAttachmentParams.html new file mode 100644 index 000000000..e84eb61b8 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadAttachmentParams.html @@ -0,0 +1,15 @@ +HeadAttachmentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the headAttachment operation.

+
interface HeadAttachmentParams {
    attachmentName: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    ifNoneMatch?: string;
    rev?: string;
}

Properties

attachmentName: string

Path parameter to specify the attachment name.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.HeadDatabaseParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadDatabaseParams.html new file mode 100644 index 000000000..8b08f1e3b --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadDatabaseParams.html @@ -0,0 +1,5 @@ +HeadDatabaseParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the headDatabase operation.

+
interface HeadDatabaseParams {
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.HeadDesignDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadDesignDocumentParams.html new file mode 100644 index 000000000..ca57ca203 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadDesignDocumentParams.html @@ -0,0 +1,10 @@ +HeadDesignDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the headDesignDocument operation.

+
interface HeadDesignDocumentParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.HeadDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadDocumentParams.html new file mode 100644 index 000000000..c60bb7a23 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadDocumentParams.html @@ -0,0 +1,14 @@ +HeadDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the headDocument operation.

+
interface HeadDocumentParams {
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
    latest?: boolean;
    rev?: string;
}

Properties

db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.HeadLocalDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadLocalDocumentParams.html new file mode 100644 index 000000000..4cf8b9e8c --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadLocalDocumentParams.html @@ -0,0 +1,9 @@ +HeadLocalDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the headLocalDocument operation.

+
interface HeadLocalDocumentParams {
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.HeadReplicationDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadReplicationDocumentParams.html new file mode 100644 index 000000000..39070bfa5 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadReplicationDocumentParams.html @@ -0,0 +1,7 @@ +HeadReplicationDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the headReplicationDocument operation.

+
interface HeadReplicationDocumentParams {
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifNoneMatch?: string;
}

Properties

docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifNoneMatch?: string

Header parameter to specify a double quoted document revision token for cache control.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.HeadSchedulerDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadSchedulerDocumentParams.html new file mode 100644 index 000000000..25ef7e45c --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadSchedulerDocumentParams.html @@ -0,0 +1,5 @@ +HeadSchedulerDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the headSchedulerDocument operation.

+
interface HeadSchedulerDocumentParams {
    docId: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.HeadSchedulerJobParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadSchedulerJobParams.html new file mode 100644 index 000000000..60904f3e9 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadSchedulerJobParams.html @@ -0,0 +1,5 @@ +HeadSchedulerJobParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the headSchedulerJob operation.

+
interface HeadSchedulerJobParams {
    headers?: OutgoingHttpHeaders;
    jobId: string;
}

Properties

Properties

headers?: OutgoingHttpHeaders
jobId: string

Path parameter to specify the replication job id.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.HeadUpInformationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadUpInformationParams.html new file mode 100644 index 000000000..a3afecdab --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.HeadUpInformationParams.html @@ -0,0 +1,3 @@ +HeadUpInformationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the headUpInformation operation.

+
interface HeadUpInformationParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.IndexDefinition.html b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexDefinition.html new file mode 100644 index 000000000..ee4e7d96e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexDefinition.html @@ -0,0 +1,46 @@ +IndexDefinition | @ibm-cloud/cloudant - v0.8.1

Schema for a json or text query index definition. Indexes of type text have additional configuration properties that do not apply to json indexes, these are: * default_analyzer - the default text analyzer to use * default_field - whether to index the text in all document fields and what analyzer to use for that purpose.

+
interface IndexDefinition {
    default_analyzer?: export=.Analyzer;
    default_field?: IndexTextOperatorDefaultField;
    fields?: IndexField[];
    index_array_lengths?: boolean;
    partial_filter_selector?: JsonObject;
}

Properties

default_analyzer?: export=.Analyzer

Schema for a full text search analyzer.

+

Schema for the text index default field configuration. The default field is used to index the text of all + fields within a document for use with the $text operator.

+
fields?: IndexField[]

List of field objects to index. Nested fields are also allowed, e.g. person.name.

+

For "json" type indexes each object is a mapping of field name to sort direction (asc or desc).

+

For "text" type indexes each object has a name property of the field name and a type property of the field + type (string, number, or boolean).

+
index_array_lengths?: boolean

Whether to scan every document for arrays and store the length for each array found. Set the + index_array_lengths field to false if:

+
    +
  • You do not need to know the length of an array. * You do not use the $size operator. * The documents in your + database are complex, or not completely under your control. As a result, it is difficult to estimate the impact + of the extra processing that is needed to determine and store the arrays lengths.
  • +
+
partial_filter_selector?: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.IndexField-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexField-1.html new file mode 100644 index 000000000..1ae36f8a1 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexField-1.html @@ -0,0 +1,7 @@ +IndexField | @ibm-cloud/cloudant - v0.8.1

Schema for indexed fields for use with declarative JSON query.

+
interface IndexField {
    name?: string;
    type?: string;
    [propName: string]: any;
}

Indexable

[propName: string]: any

IndexField accepts additional properties.

+

Properties

Properties

name?: string

Name of the field.

+
type?: string

The type of the named field.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.IndexInformation-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexInformation-1.html new file mode 100644 index 000000000..ffd3e15a5 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexInformation-1.html @@ -0,0 +1,17 @@ +IndexInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about an index.

+
interface IndexInformation {
    ddoc: string;
    def: IndexDefinition;
    name: string;
    partitioned?: boolean;
    type: string;
}

Properties

Properties

ddoc: string

Design document ID including a _design/ prefix.

+

Schema for a json or text query index definition. Indexes of type text have additional configuration + properties that do not apply to json indexes, these are:

+
    +
  • default_analyzer - the default text analyzer to use * default_field - whether to index the text in all + document fields and what analyzer to use for that purpose.
  • +
+
name: string

Index name.

+
partitioned?: boolean

Indicates if index is partitioned.

+
type: string

Schema for the type of an index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.IndexResult-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexResult-1.html new file mode 100644 index 000000000..45464ea88 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexResult-1.html @@ -0,0 +1,8 @@ +IndexResult | @ibm-cloud/cloudant - v0.8.1

Schema for the result of creating an index.

+
interface IndexResult {
    id: string;
    name: string;
    result: string;
}

Properties

Properties

id: string

Id of the design document the index was created in.

+
name: string

Name of the index created.

+
result: string

Flag to show whether the index was created or one already exists.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.IndexTextOperatorDefaultField.html b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexTextOperatorDefaultField.html new file mode 100644 index 000000000..c976e47cc --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexTextOperatorDefaultField.html @@ -0,0 +1,6 @@ +IndexTextOperatorDefaultField | @ibm-cloud/cloudant - v0.8.1

Schema for the text index default field configuration. The default field is used to index the text of all fields within a document for use with the $text operator.

+
interface IndexTextOperatorDefaultField {
    analyzer?: export=.Analyzer;
    enabled?: boolean;
}

Properties

Properties

analyzer?: export=.Analyzer

Schema for a full text search analyzer.

+
enabled?: boolean

Whether or not the default_field is enabled.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.IndexesInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexesInformation.html new file mode 100644 index 000000000..0a0d44320 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.IndexesInformation.html @@ -0,0 +1,6 @@ +IndexesInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about the indexes in a database.

+
interface IndexesInformation {
    indexes: IndexInformation[];
    total_rows: number;
}

Properties

Properties

indexes: IndexInformation[]

Indexes.

+
total_rows: number

Number of total rows.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.JsonObject.html b/docs/0.8.1/interfaces/cloudant_v1.export_.JsonObject.html new file mode 100644 index 000000000..7c0eb5139 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.JsonObject.html @@ -0,0 +1,2 @@ +JsonObject | @ibm-cloud/cloudant - v0.8.1

A standard JS object, defined to avoid the limitations of Object and object

+
interface JsonObject {
    [key: string]: any;
}

Indexable

[key: string]: any

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.MembershipInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.MembershipInformation.html new file mode 100644 index 000000000..707d92100 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.MembershipInformation.html @@ -0,0 +1,6 @@ +MembershipInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about known nodes and cluster membership.

+
interface MembershipInformation {
    all_nodes: string[];
    cluster_nodes: string[];
}

Properties

all_nodes: string[]

List of nodes this node knows about, including the ones that are part of the cluster.

+
cluster_nodes: string[]

All cluster nodes.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.Ok.html b/docs/0.8.1/interfaces/cloudant_v1.export_.Ok.html new file mode 100644 index 000000000..27f29e35d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.Ok.html @@ -0,0 +1,4 @@ +Ok | @ibm-cloud/cloudant - v0.8.1

Schema for an OK result.

+
interface Ok {
    ok?: boolean;
}

Properties

ok? +

Properties

ok?: boolean

ok.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformation.html new file mode 100644 index 000000000..c3812d47f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformation.html @@ -0,0 +1,14 @@ +PartitionInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about a database partition.

+
interface PartitionInformation {
    db_name: string;
    doc_count: number;
    doc_del_count: number;
    partition: string;
    partitioned_indexes?: PartitionInformationIndexes;
    sizes: PartitionInformationSizes;
}

Properties

db_name: string

The name of the database.

+
doc_count: number

A count of the documents in the specified database partition.

+
doc_del_count: number

Number of deleted documents.

+
partition: string

The name of the partition in the database.

+
partitioned_indexes?: PartitionInformationIndexes

Schema for information about the partition index count and limit in a database.

+

The size of active and external data, in bytes.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformationIndexes.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformationIndexes.html new file mode 100644 index 000000000..638335ad8 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformationIndexes.html @@ -0,0 +1,8 @@ +PartitionInformationIndexes | @ibm-cloud/cloudant - v0.8.1

Schema for information about the partition index count and limit in a database.

+
interface PartitionInformationIndexes {
    count?: number;
    indexes?: PartitionInformationIndexesIndexes;
    limit?: number;
}

Properties

Properties

count?: number

Total count of the partitioned indexes.

+

The count breakdown of partitioned indexes.

+
limit?: number

The partitioned index limit.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformationIndexesIndexes.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformationIndexesIndexes.html new file mode 100644 index 000000000..5f238e151 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformationIndexesIndexes.html @@ -0,0 +1,6 @@ +PartitionInformationIndexesIndexes | @ibm-cloud/cloudant - v0.8.1

The count breakdown of partitioned indexes.

+
interface PartitionInformationIndexesIndexes {
    search?: number;
    view?: number;
}

Properties

Properties

search?: number

Number of partitioned search indexes.

+
view?: number

Number of partitioned view indexes.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformationSizes.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformationSizes.html new file mode 100644 index 000000000..05143fc9f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionInformationSizes.html @@ -0,0 +1,6 @@ +PartitionInformationSizes | @ibm-cloud/cloudant - v0.8.1

The size of active and external data, in bytes.

+
interface PartitionInformationSizes {
    active?: number;
    external?: number;
}

Properties

Properties

active?: number

The size of live data inside the database, in bytes.

+
external?: number

The uncompressed size of database contents in bytes.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionedIndexesDetailedInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionedIndexesDetailedInformation.html new file mode 100644 index 000000000..2488a0c2d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionedIndexesDetailedInformation.html @@ -0,0 +1,6 @@ +PartitionedIndexesDetailedInformation | @ibm-cloud/cloudant - v0.8.1

Number of partitioned indexes by type.

+
interface PartitionedIndexesDetailedInformation {
    search?: number;
    view?: number;
}

Properties

Properties

search?: number

Number of partitioned indexes of search type.

+
view?: number

Number of partitioned indexes of view type.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionedIndexesInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionedIndexesInformation.html new file mode 100644 index 000000000..f271dfde6 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PartitionedIndexesInformation.html @@ -0,0 +1,8 @@ +PartitionedIndexesInformation | @ibm-cloud/cloudant - v0.8.1

Information about database's partitioned indexes.

+
interface PartitionedIndexesInformation {
    count?: number;
    indexes?: PartitionedIndexesDetailedInformation;
    limit?: number;
}

Properties

Properties

count?: number

Total number of partitioned indexes in the database.

+

Number of partitioned indexes by type.

+
limit?: number

Maximum allowed number of partitioned indexes in the database.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostActivityTrackerEventsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostActivityTrackerEventsParams.html new file mode 100644 index 000000000..752d006bd --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostActivityTrackerEventsParams.html @@ -0,0 +1,6 @@ +PostActivityTrackerEventsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postActivityTrackerEvents operation.

+
interface PostActivityTrackerEventsParams {
    headers?: OutgoingHttpHeaders;
    types: string[] | export=.PostActivityTrackerEventsConstants.Types[];
}

Properties

Properties

headers?: OutgoingHttpHeaders

An array of event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance. + "management" is a required element of this array.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsAsStreamParams.html new file mode 100644 index 000000000..2c1f414d1 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsAsStreamParams.html @@ -0,0 +1,34 @@ +PostAllDocsAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postAllDocsAsStream operation.

+
interface PostAllDocsAsStreamParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsParams.html new file mode 100644 index 000000000..20a853281 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsParams.html @@ -0,0 +1,34 @@ +PostAllDocsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postAllDocs operation.

+
interface PostAllDocsParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsQueriesAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsQueriesAsStreamParams.html new file mode 100644 index 000000000..ee44d802f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsQueriesAsStreamParams.html @@ -0,0 +1,8 @@ +PostAllDocsQueriesAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postAllDocsQueriesAsStream operation.

+
interface PostAllDocsQueriesAsStreamParams {
    db: string;
    headers?: OutgoingHttpHeaders;
    queries: AllDocsQuery[];
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
queries: AllDocsQuery[]

An array of query objects with fields for the parameters of each individual view query to be executed. The + field names and their meaning are the same as the query parameters of a regular /_all_docs request.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsQueriesParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsQueriesParams.html new file mode 100644 index 000000000..29169538e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostAllDocsQueriesParams.html @@ -0,0 +1,8 @@ +PostAllDocsQueriesParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postAllDocsQueries operation.

+
interface PostAllDocsQueriesParams {
    db: string;
    headers?: OutgoingHttpHeaders;
    queries: AllDocsQuery[];
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
queries: AllDocsQuery[]

An array of query objects with fields for the parameters of each individual view query to be executed. The + field names and their meaning are the same as the query parameters of a regular /_all_docs request.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostApiKeysParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostApiKeysParams.html new file mode 100644 index 000000000..6dee1faed --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostApiKeysParams.html @@ -0,0 +1,3 @@ +PostApiKeysParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postApiKeys operation.

+
interface PostApiKeysParams {
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkDocsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkDocsParams.html new file mode 100644 index 000000000..ec6385ec9 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkDocsParams.html @@ -0,0 +1,7 @@ +PostBulkDocsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postBulkDocs operation.

+
interface PostBulkDocsParams {
    bulkDocs: Buffer | ReadableStream | BulkDocs;
    db: string;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

bulkDocs: Buffer | ReadableStream | BulkDocs

HTTP request body for postBulkDocs.

+
db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetAsMixedParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetAsMixedParams.html new file mode 100644 index 000000000..b89c326de --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetAsMixedParams.html @@ -0,0 +1,17 @@ +PostBulkGetAsMixedParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postBulkGetAsMixed operation.

+
interface PostBulkGetAsMixedParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    db: string;
    docs: BulkGetQueryDocument[];
    headers?: OutgoingHttpHeaders;
    latest?: boolean;
    revs?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
db: string

Path parameter to specify the database name.

+

List of document items to get in bulk.

+
headers?: OutgoingHttpHeaders
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetAsRelatedParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetAsRelatedParams.html new file mode 100644 index 000000000..80697effa --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetAsRelatedParams.html @@ -0,0 +1,17 @@ +PostBulkGetAsRelatedParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postBulkGetAsRelated operation.

+
interface PostBulkGetAsRelatedParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    db: string;
    docs: BulkGetQueryDocument[];
    headers?: OutgoingHttpHeaders;
    latest?: boolean;
    revs?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
db: string

Path parameter to specify the database name.

+

List of document items to get in bulk.

+
headers?: OutgoingHttpHeaders
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetAsStreamParams.html new file mode 100644 index 000000000..336ee09fb --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetAsStreamParams.html @@ -0,0 +1,17 @@ +PostBulkGetAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postBulkGetAsStream operation.

+
interface PostBulkGetAsStreamParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    db: string;
    docs: BulkGetQueryDocument[];
    headers?: OutgoingHttpHeaders;
    latest?: boolean;
    revs?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
db: string

Path parameter to specify the database name.

+

List of document items to get in bulk.

+
headers?: OutgoingHttpHeaders
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetParams.html new file mode 100644 index 000000000..97f82991f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostBulkGetParams.html @@ -0,0 +1,17 @@ +PostBulkGetParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postBulkGet operation.

+
interface PostBulkGetParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    db: string;
    docs: BulkGetQueryDocument[];
    headers?: OutgoingHttpHeaders;
    latest?: boolean;
    revs?: boolean;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
db: string

Path parameter to specify the database name.

+

List of document items to get in bulk.

+
headers?: OutgoingHttpHeaders
latest?: boolean

Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was + requested.

+
revs?: boolean

Query parameter to specify whether to include a list of all known document revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostChangesAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostChangesAsStreamParams.html new file mode 100644 index 000000000..7d35b1cfb --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostChangesAsStreamParams.html @@ -0,0 +1,103 @@ +PostChangesAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postChangesAsStream operation.

+
interface PostChangesAsStreamParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    docIds?: string[];
    feed?: string;
    fields?: string[];
    filter?: string;
    headers?: OutgoingHttpHeaders;
    heartbeat?: number;
    includeDocs?: boolean;
    lastEventId?: string;
    limit?: number;
    selector?: JsonObject;
    seqInterval?: number;
    since?: string;
    style?: string;
    timeout?: number;
    view?: string;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. + Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Query parameter to specify whether to return the documents in descending by key order.

+
docIds?: string[]

Schema for a list of document IDs.

+
feed?: string

Query parameter to specify the changes feed type.

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be + returned. If it is omitted or empty, the entire document is returned.

+
filter?: string

Query parameter to specify a filter function from a design document that will filter the changes stream + emitting only filtered events. For example: design_doc/filtername.

+

Additionally, some keywords are reserved for built-in filters:

+
    +
  • _design - Returns only changes to design documents.
  • +
  • _doc_ids - Returns changes for documents with an ID matching one specified in + doc_ids request body parameter.
  • +
  • _selector - Returns changes for documents that match the selector + request body parameter. The selector syntax is the same as used for + _find.
  • +
  • _view - Returns changes for documents that match an existing map + function in the view specified by the query parameter view.
  • +
+
headers?: OutgoingHttpHeaders
heartbeat?: number

Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off + by default and only applicable for + continuous and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be + true to use a value of 60000.

+

Note: Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an + environment where idle network connections may break, heartbeat is not suitable as a keepalive mechanism. + Instead, consider one of the following options:

+
    +
  • Use the timeout parameter with a value that is compatible with your network environment.
  • +
  • Switch to scheduled usage of one of the non-continuous changes feed types +(normal or longpoll).
  • +
  • Use TCP keepalive.
  • +
+
includeDocs?: boolean

Query parameter to specify whether to include the full content of the documents in the response.

+
lastEventId?: string

Header parameter to specify the ID of the last events received by the server on a previous connection. + Overrides since query parameter.

+
limit?: number

Query parameter to specify the number of returned documents to limit the result to.

+
selector?: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
seqInterval?: number

Query parameter to specify that the update seq should only be calculated with every Nth result returned. + When fetching changes in a batch, setting seq_interval=<batch size>, where <batch size> + is the number of results requested per batch, load can be reduced on the source database as computing the seq + value across many shards (especially in highly-sharded databases) is expensive.

+
since?: string

Query parameter to specify to start the results from the change immediately after the given update sequence. + Can be a valid update sequence or now value. Default is 0 i.e. all changes.

+
style?: string

Query parameter to specify how many revisions are returned in the changes array. The default, main_only, + will only return the current "winning" revision; all_docs will return all leaf revisions (including conflicts + and deleted former conflicts).

+
timeout?: number

Query parameter to specify the maximum period in milliseconds to wait for a change before the response is + sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is + specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum + timeout to prevent undetected dead connections.

+
view?: string

Query parameter to specify a view function as a filter. Documents pass the filter if the view's map function + emits at least one record for them.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostChangesParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostChangesParams.html new file mode 100644 index 000000000..9fb5f7565 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostChangesParams.html @@ -0,0 +1,103 @@ +PostChangesParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postChanges operation.

+
interface PostChangesParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    docIds?: string[];
    feed?: string;
    fields?: string[];
    filter?: string;
    headers?: OutgoingHttpHeaders;
    heartbeat?: number;
    includeDocs?: boolean;
    lastEventId?: string;
    limit?: number;
    selector?: JsonObject;
    seqInterval?: number;
    since?: string;
    style?: string;
    timeout?: number;
    view?: string;
}

Properties

attEncodingInfo?: boolean

Query parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Query parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Query parameter to specify whether to include a list of conflicted revisions in each returned document. + Active only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Query parameter to specify whether to return the documents in descending by key order.

+
docIds?: string[]

Schema for a list of document IDs.

+
feed?: string

Query parameter to specify the changes feed type.

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be + returned. If it is omitted or empty, the entire document is returned.

+
filter?: string

Query parameter to specify a filter function from a design document that will filter the changes stream + emitting only filtered events. For example: design_doc/filtername.

+

Additionally, some keywords are reserved for built-in filters:

+
    +
  • _design - Returns only changes to design documents.
  • +
  • _doc_ids - Returns changes for documents with an ID matching one specified in + doc_ids request body parameter.
  • +
  • _selector - Returns changes for documents that match the selector + request body parameter. The selector syntax is the same as used for + _find.
  • +
  • _view - Returns changes for documents that match an existing map + function in the view specified by the query parameter view.
  • +
+
headers?: OutgoingHttpHeaders
heartbeat?: number

Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off + by default and only applicable for + continuous and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be + true to use a value of 60000.

+

Note: Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an + environment where idle network connections may break, heartbeat is not suitable as a keepalive mechanism. + Instead, consider one of the following options:

+
    +
  • Use the timeout parameter with a value that is compatible with your network environment.
  • +
  • Switch to scheduled usage of one of the non-continuous changes feed types +(normal or longpoll).
  • +
  • Use TCP keepalive.
  • +
+
includeDocs?: boolean

Query parameter to specify whether to include the full content of the documents in the response.

+
lastEventId?: string

Header parameter to specify the ID of the last events received by the server on a previous connection. + Overrides since query parameter.

+
limit?: number

Query parameter to specify the number of returned documents to limit the result to.

+
selector?: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
seqInterval?: number

Query parameter to specify that the update seq should only be calculated with every Nth result returned. + When fetching changes in a batch, setting seq_interval=<batch size>, where <batch size> + is the number of results requested per batch, load can be reduced on the source database as computing the seq + value across many shards (especially in highly-sharded databases) is expensive.

+
since?: string

Query parameter to specify to start the results from the change immediately after the given update sequence. + Can be a valid update sequence or now value. Default is 0 i.e. all changes.

+
style?: string

Query parameter to specify how many revisions are returned in the changes array. The default, main_only, + will only return the current "winning" revision; all_docs will return all leaf revisions (including conflicts + and deleted former conflicts).

+
timeout?: number

Query parameter to specify the maximum period in milliseconds to wait for a change before the response is + sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is + specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum + timeout to prevent undetected dead connections.

+
view?: string

Query parameter to specify a view function as a filter. Documents pass the filter if the view's map function + emits at least one record for them.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostDbsInfoParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostDbsInfoParams.html new file mode 100644 index 000000000..c069b78ac --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostDbsInfoParams.html @@ -0,0 +1,5 @@ +PostDbsInfoParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postDbsInfo operation.

+
interface PostDbsInfoParams {
    headers?: OutgoingHttpHeaders;
    keys: string[];
}

Properties

Properties

headers?: OutgoingHttpHeaders
keys: string[]

A list of database names.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostDesignDocsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostDesignDocsParams.html new file mode 100644 index 000000000..0c3b03941 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostDesignDocsParams.html @@ -0,0 +1,36 @@ +PostDesignDocsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postDesignDocs operation.

+
interface PostDesignDocsParams {
    accept?: string;
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

accept?: string

The type of the response: application/json or application/octet-stream.

+
attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostDesignDocsQueriesParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostDesignDocsQueriesParams.html new file mode 100644 index 000000000..766cf13ce --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostDesignDocsQueriesParams.html @@ -0,0 +1,10 @@ +PostDesignDocsQueriesParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postDesignDocsQueries operation.

+
interface PostDesignDocsQueriesParams {
    accept?: string;
    db: string;
    headers?: OutgoingHttpHeaders;
    queries: AllDocsQuery[];
}

Properties

Properties

accept?: string

The type of the response: application/json or application/octet-stream.

+
db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
queries: AllDocsQuery[]

An array of query objects with fields for the parameters of each individual view query to be executed. The + field names and their meaning are the same as the query parameters of a regular /_all_docs request.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostDocumentParams.html new file mode 100644 index 000000000..7ad675ca1 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostDocumentParams.html @@ -0,0 +1,12 @@ +PostDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postDocument operation.

+
interface PostDocumentParams {
    batch?: string;
    contentType?: string;
    db: string;
    document: Buffer | ReadableStream | Document;
    headers?: OutgoingHttpHeaders;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
contentType?: string

The type of the input.

+
db: string

Path parameter to specify the database name.

+
document: Buffer | ReadableStream | Document

HTTP request body for Document operations.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostExplainParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostExplainParams.html new file mode 100644 index 000000000..c8f717c27 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostExplainParams.html @@ -0,0 +1,67 @@ +PostExplainParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postExplain operation.

+
interface PostExplainParams {
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    r?: number;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the + document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key + lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each + document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be + returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
r?: number

The read quorum that is needed for the result. The value defaults to 1, in which case the document that was + found in the index is returned. If set to a higher value, each document is read from at least that many replicas + before it is returned in the results. The request will take more time than using only the document that is + stored locally with the index.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The + first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next + level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the + same order and each object in the sort array has a single key or at least one of the sort fields is included in + the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant + Query algorithm to find the best index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostFindAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostFindAsStreamParams.html new file mode 100644 index 000000000..b1ccb0b16 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostFindAsStreamParams.html @@ -0,0 +1,67 @@ +PostFindAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postFindAsStream operation.

+
interface PostFindAsStreamParams {
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    r?: number;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the + document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key + lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each + document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be + returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
r?: number

The read quorum that is needed for the result. The value defaults to 1, in which case the document that was + found in the index is returned. If set to a higher value, each document is read from at least that many replicas + before it is returned in the results. The request will take more time than using only the document that is + stored locally with the index.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The + first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next + level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the + same order and each object in the sort array has a single key or at least one of the sort fields is included in + the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant + Query algorithm to find the best index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostFindParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostFindParams.html new file mode 100644 index 000000000..d409edb8f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostFindParams.html @@ -0,0 +1,67 @@ +PostFindParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postFind operation.

+
interface PostFindParams {
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    r?: number;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the + document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key + lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each + document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be + returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
r?: number

The read quorum that is needed for the result. The value defaults to 1, in which case the document that was + found in the index is returned. If set to a higher value, each document is read from at least that many replicas + before it is returned in the results. The request will take more time than using only the document that is + stored locally with the index.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The + first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next + level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the + same order and each object in the sort array has a single key or at least one of the sort fields is included in + the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant + Query algorithm to find the best index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostIndexParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostIndexParams.html new file mode 100644 index 000000000..e429a130b --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostIndexParams.html @@ -0,0 +1,22 @@ +PostIndexParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postIndex operation.

+
interface PostIndexParams {
    db: string;
    ddoc?: string;
    headers?: OutgoingHttpHeaders;
    index: IndexDefinition;
    name?: string;
    partitioned?: boolean;
    type?: string;
}

Properties

db: string

Path parameter to specify the database name.

+
ddoc?: string

Specifies the design document name in which the index will be created. The design document name is the + design document ID excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders

Schema for a json or text query index definition. Indexes of type text have additional configuration + properties that do not apply to json indexes, these are:

+
    +
  • default_analyzer - the default text analyzer to use * default_field - whether to index the text in all + document fields and what analyzer to use for that purpose.
  • +
+
name?: string

name.

+
partitioned?: boolean

The default value is true for databases with partitioned: true and false otherwise. For databases with + partitioned: false if this option is specified the value must be false.

+
type?: string

Schema for the type of an index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionAllDocsAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionAllDocsAsStreamParams.html new file mode 100644 index 000000000..fcd350abf --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionAllDocsAsStreamParams.html @@ -0,0 +1,36 @@ +PostPartitionAllDocsAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postPartitionAllDocsAsStream operation.

+
interface PostPartitionAllDocsAsStreamParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    partitionKey: string;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
partitionKey: string

Path parameter to specify the database partition key.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionAllDocsParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionAllDocsParams.html new file mode 100644 index 000000000..f1c47623f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionAllDocsParams.html @@ -0,0 +1,36 @@ +PostPartitionAllDocsParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postPartitionAllDocs operation.

+
interface PostPartitionAllDocsParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    descending?: boolean;
    endKey?: string;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: string;
    keys?: string[];
    limit?: number;
    partitionKey: string;
    skip?: number;
    startKey?: string;
    updateSeq?: boolean;
}

Properties

attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: string

Schema for a document ID.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: string

Schema for a document ID.

+
keys?: string[]

Schema for a list of document IDs.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
partitionKey: string

Path parameter to specify the database partition key.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: string

Schema for a document ID.

+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionExplainParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionExplainParams.html new file mode 100644 index 000000000..e9cd7c6e9 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionExplainParams.html @@ -0,0 +1,64 @@ +PostPartitionExplainParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postPartitionExplain operation.

+
interface PostPartitionExplainParams {
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    partitionKey: string;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the + document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key + lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each + document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be + returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
partitionKey: string

Path parameter to specify the database partition key.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The + first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next + level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the + same order and each object in the sort array has a single key or at least one of the sort fields is included in + the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant + Query algorithm to find the best index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionFindAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionFindAsStreamParams.html new file mode 100644 index 000000000..a3aa446ba --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionFindAsStreamParams.html @@ -0,0 +1,64 @@ +PostPartitionFindAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postPartitionFindAsStream operation.

+
interface PostPartitionFindAsStreamParams {
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    partitionKey: string;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the + document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key + lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each + document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be + returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
partitionKey: string

Path parameter to specify the database partition key.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The + first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next + level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the + same order and each object in the sort array has a single key or at least one of the sort fields is included in + the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant + Query algorithm to find the best index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionFindParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionFindParams.html new file mode 100644 index 000000000..9f0198605 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionFindParams.html @@ -0,0 +1,64 @@ +PostPartitionFindParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postPartitionFind operation.

+
interface PostPartitionFindParams {
    bookmark?: string;
    conflicts?: boolean;
    db: string;
    executionStats?: boolean;
    fields?: string[];
    headers?: OutgoingHttpHeaders;
    limit?: number;
    partitionKey: string;
    selector: JsonObject;
    skip?: number;
    sort?: JsonObject[];
    stable?: boolean;
    update?: string;
    useIndex?: string[];
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
conflicts?: boolean

A boolean value that indicates whether or not to include information about existing conflicts in the + document.

+
db: string

Path parameter to specify the database name.

+
executionStats?: boolean

Use this option to find information about the query that was run. This information includes total key + lookups, total document lookups (when include_docs=true is used), and total quorum document lookups (when each + document replica is fetched).

+
fields?: string[]

JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be + returned. If it is omitted or empty, the entire document is returned.

+
headers?: OutgoingHttpHeaders
limit?: number

Maximum number of results returned. The type: text indexes are limited to 200 results when queried.

+
partitionKey: string

Path parameter to specify the database partition key.

+
selector: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
skip?: number

Skip the first 'n' results, where 'n' is the value that is specified.

+
sort?: JsonObject[]

The sort field contains a list of pairs, each mapping a field name to a sort direction (asc or desc). The + first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next + level of sort. The field can be any field, using dotted notation if desired for sub-document fields.

+

For example in JSON: [{"fieldName1": "desc"}, {"fieldName2.subFieldName1": "desc"}]

+

When sorting with multiple fields, ensure that there is an index already defined with all the sort fields in the + same order and each object in the sort array has a single key or at least one of the sort fields is included in + the selector. All sorting fields must use the same sort direction, either all ascending or all descending.

+
stable?: boolean

Whether or not the view results should be returned from a "stable" set of shards.

+
update?: string

Whether to update the index prior to returning the result.

+
useIndex?: string[]

Use this option to identify a specific index for query to run against, rather than by using the IBM Cloudant + Query algorithm to find the best index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionSearchAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionSearchAsStreamParams.html new file mode 100644 index 000000000..b3886275b --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionSearchAsStreamParams.html @@ -0,0 +1,45 @@ +PostPartitionSearchAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postPartitionSearchAsStream operation.

+
interface PostPartitionSearchAsStreamParams {
    bookmark?: string;
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    highlightFields?: string[];
    highlightNumber?: number;
    highlightPostTag?: string;
    highlightPreTag?: string;
    highlightSize?: number;
    includeDocs?: boolean;
    includeFields?: string[];
    index: string;
    limit?: number;
    partitionKey: string;
    query: string;
    sort?: string[];
    stale?: string;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
highlightFields?: string[]

Specifies which fields to highlight. If specified, the result object contains a highlights field with an + entry for each specified field.

+
highlightNumber?: number

Number of fragments that are returned in highlights. If the search term occurs less often than the number of + fragments that are specified, longer fragments are returned.

+
highlightPostTag?: string

A string that is inserted after the highlighted word in the highlights output.

+
highlightPreTag?: string

A string that is inserted before the highlighted word in the highlights output.

+
highlightSize?: number

Number of characters in each fragment for highlights.

+
includeDocs?: boolean

Include the full content of the documents in the return.

+
includeFields?: string[]

A JSON array of field names to include in search results. Any fields that are included must be indexed with + the store:true option. The default is all fields.

+
index: string

Path parameter to specify the index name.

+
limit?: number

Limit the number of the returned documents to the specified number.

+
partitionKey: string

Path parameter to specify the database partition key.

+
query: string

The Lucene query to execute.

+
sort?: string[]

Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter + specifies the sort order within a group. The default sort order is relevance. A JSON string of the form + "fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a + string or number field, and type is either a number, a string, or a JSON array of strings. The type part is + optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and + ["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed + fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

+
stale?: string

Do not wait for the index to finish building to return results.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionSearchParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionSearchParams.html new file mode 100644 index 000000000..58505b6b9 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionSearchParams.html @@ -0,0 +1,45 @@ +PostPartitionSearchParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postPartitionSearch operation.

+
interface PostPartitionSearchParams {
    bookmark?: string;
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    highlightFields?: string[];
    highlightNumber?: number;
    highlightPostTag?: string;
    highlightPreTag?: string;
    highlightSize?: number;
    includeDocs?: boolean;
    includeFields?: string[];
    index: string;
    limit?: number;
    partitionKey: string;
    query: string;
    sort?: string[];
    stale?: string;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
highlightFields?: string[]

Specifies which fields to highlight. If specified, the result object contains a highlights field with an + entry for each specified field.

+
highlightNumber?: number

Number of fragments that are returned in highlights. If the search term occurs less often than the number of + fragments that are specified, longer fragments are returned.

+
highlightPostTag?: string

A string that is inserted after the highlighted word in the highlights output.

+
highlightPreTag?: string

A string that is inserted before the highlighted word in the highlights output.

+
highlightSize?: number

Number of characters in each fragment for highlights.

+
includeDocs?: boolean

Include the full content of the documents in the return.

+
includeFields?: string[]

A JSON array of field names to include in search results. Any fields that are included must be indexed with + the store:true option. The default is all fields.

+
index: string

Path parameter to specify the index name.

+
limit?: number

Limit the number of the returned documents to the specified number.

+
partitionKey: string

Path parameter to specify the database partition key.

+
query: string

The Lucene query to execute.

+
sort?: string[]

Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter + specifies the sort order within a group. The default sort order is relevance. A JSON string of the form + "fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a + string or number field, and type is either a number, a string, or a JSON array of strings. The type part is + optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and + ["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed + fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

+
stale?: string

Do not wait for the index to finish building to return results.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionViewAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionViewAsStreamParams.html new file mode 100644 index 000000000..9b1cb3b22 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionViewAsStreamParams.html @@ -0,0 +1,64 @@ +PostPartitionViewAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postPartitionViewAsStream operation.

+
interface PostPartitionViewAsStreamParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    descending?: boolean;
    endKey?: any;
    endKeyDocId?: string;
    group?: boolean;
    groupLevel?: number;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    partitionKey: string;
    reduce?: boolean;
    skip?: number;
    startKey?: any;
    startKeyDocId?: string;
    update?: string;
    updateSeq?: boolean;
    view: string;
}

Properties

attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: any

Schema for any JSON type.

+
endKeyDocId?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the + view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the + number of array elements with the group_level parameter.

+
groupLevel?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. + Implies group is true. Group level groups the reduced results by the specified number of array elements. If + unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys + that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
partitionKey: string

Path parameter to specify the database partition key.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce + function is defined.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: any

Schema for any JSON type.

+
startKeyDocId?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+
view: string

Path parameter to specify the map reduce view function name.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionViewParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionViewParams.html new file mode 100644 index 000000000..d676b40b0 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostPartitionViewParams.html @@ -0,0 +1,64 @@ +PostPartitionViewParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postPartitionView operation.

+
interface PostPartitionViewParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    descending?: boolean;
    endKey?: any;
    endKeyDocId?: string;
    group?: boolean;
    groupLevel?: number;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    partitionKey: string;
    reduce?: boolean;
    skip?: number;
    startKey?: any;
    startKeyDocId?: string;
    update?: string;
    updateSeq?: boolean;
    view: string;
}

Properties

attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: any

Schema for any JSON type.

+
endKeyDocId?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the + view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the + number of array elements with the group_level parameter.

+
groupLevel?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. + Implies group is true. Group level groups the reduced results by the specified number of array elements. If + unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys + that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
partitionKey: string

Path parameter to specify the database partition key.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce + function is defined.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
startKey?: any

Schema for any JSON type.

+
startKeyDocId?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+
view: string

Path parameter to specify the map reduce view function name.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostRevsDiffParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostRevsDiffParams.html new file mode 100644 index 000000000..f1fddc9f8 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostRevsDiffParams.html @@ -0,0 +1,7 @@ +PostRevsDiffParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postRevsDiff operation.

+
interface PostRevsDiffParams {
    db: string;
    documentRevisions: JsonObject;
    headers?: OutgoingHttpHeaders;
}

Properties

db: string

Path parameter to specify the database name.

+
documentRevisions: JsonObject

HTTP request body for operations with Document revisions.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostSearchAnalyzeParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostSearchAnalyzeParams.html new file mode 100644 index 000000000..bba0a45b4 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostSearchAnalyzeParams.html @@ -0,0 +1,7 @@ +PostSearchAnalyzeParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postSearchAnalyze operation.

+
interface PostSearchAnalyzeParams {
    analyzer: string;
    headers?: OutgoingHttpHeaders;
    text: string;
}

Properties

Properties

analyzer: string

The analyzer type that is being used at the tokenization.

+
headers?: OutgoingHttpHeaders
text: string

The text to tokenize with the analyzer.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostSearchAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostSearchAsStreamParams.html new file mode 100644 index 000000000..21a0caa5d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostSearchAsStreamParams.html @@ -0,0 +1,68 @@ +PostSearchAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postSearchAsStream operation.

+
interface PostSearchAsStreamParams {
    bookmark?: string;
    counts?: string[];
    db: string;
    ddoc: string;
    drilldown?: string[][];
    groupField?: string;
    groupLimit?: number;
    groupSort?: string[];
    headers?: OutgoingHttpHeaders;
    highlightFields?: string[];
    highlightNumber?: number;
    highlightPostTag?: string;
    highlightPreTag?: string;
    highlightSize?: number;
    includeDocs?: boolean;
    includeFields?: string[];
    index: string;
    limit?: number;
    query: string;
    ranges?: JsonObject;
    sort?: string[];
    stale?: string;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
counts?: string[]

This field defines an array of names of string fields, for which counts are requested. The response contains + counts for each unique value of this field name among the documents that match the search query. Faceting must + be enabled for this parameter to function. This option is only available when making global queries.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
drilldown?: string[][]

Restrict results to documents with a dimension equal to the specified label(s). The search matches only + documents containing the value that was provided in the named field. It differs from using "fieldname:value" in + the q parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to + function.

+
groupField?: string

Field by which to group search matches. A string that contains the name of a string field. Fields containing + other data such as numbers, objects, or arrays cannot be used. This option is only available when making global + queries.

+
groupLimit?: number

Maximum group count. This field can be used only if group_field is specified. This option is only available + when making global queries.

+
groupSort?: string[]

This field defines the order of the groups in a search that uses group_field. The default sort order is + relevance. This field can have the same values as the sort field, so single fields and arrays of fields are + supported. This option is only available when making global queries.

+
headers?: OutgoingHttpHeaders
highlightFields?: string[]

Specifies which fields to highlight. If specified, the result object contains a highlights field with an + entry for each specified field.

+
highlightNumber?: number

Number of fragments that are returned in highlights. If the search term occurs less often than the number of + fragments that are specified, longer fragments are returned.

+
highlightPostTag?: string

A string that is inserted after the highlighted word in the highlights output.

+
highlightPreTag?: string

A string that is inserted before the highlighted word in the highlights output.

+
highlightSize?: number

Number of characters in each fragment for highlights.

+
includeDocs?: boolean

Include the full content of the documents in the return.

+
includeFields?: string[]

A JSON array of field names to include in search results. Any fields that are included must be indexed with + the store:true option. The default is all fields.

+
index: string

Path parameter to specify the index name.

+
limit?: number

Limit the number of the returned documents to the specified number.

+
query: string

The Lucene query to execute.

+
ranges?: JsonObject

This field defines ranges for faceted, numeric search fields. The value is a JSON object where the fields + names are faceted numeric search fields, and the values of the fields are JSON objects. The field names of the + JSON objects are names for ranges. The values are strings that describe the range, for example "[0 TO 10]". This + option is only available when making global queries.

+
sort?: string[]

Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter + specifies the sort order within a group. The default sort order is relevance. A JSON string of the form + "fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a + string or number field, and type is either a number, a string, or a JSON array of strings. The type part is + optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and + ["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed + fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

+
stale?: string

Do not wait for the index to finish building to return results.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostSearchParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostSearchParams.html new file mode 100644 index 000000000..9f43a402e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostSearchParams.html @@ -0,0 +1,68 @@ +PostSearchParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postSearch operation.

+
interface PostSearchParams {
    bookmark?: string;
    counts?: string[];
    db: string;
    ddoc: string;
    drilldown?: string[][];
    groupField?: string;
    groupLimit?: number;
    groupSort?: string[];
    headers?: OutgoingHttpHeaders;
    highlightFields?: string[];
    highlightNumber?: number;
    highlightPostTag?: string;
    highlightPreTag?: string;
    highlightSize?: number;
    includeDocs?: boolean;
    includeFields?: string[];
    index: string;
    limit?: number;
    query: string;
    ranges?: JsonObject;
    sort?: string[];
    stale?: string;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
counts?: string[]

This field defines an array of names of string fields, for which counts are requested. The response contains + counts for each unique value of this field name among the documents that match the search query. Faceting must + be enabled for this parameter to function. This option is only available when making global queries.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
drilldown?: string[][]

Restrict results to documents with a dimension equal to the specified label(s). The search matches only + documents containing the value that was provided in the named field. It differs from using "fieldname:value" in + the q parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to + function.

+
groupField?: string

Field by which to group search matches. A string that contains the name of a string field. Fields containing + other data such as numbers, objects, or arrays cannot be used. This option is only available when making global + queries.

+
groupLimit?: number

Maximum group count. This field can be used only if group_field is specified. This option is only available + when making global queries.

+
groupSort?: string[]

This field defines the order of the groups in a search that uses group_field. The default sort order is + relevance. This field can have the same values as the sort field, so single fields and arrays of fields are + supported. This option is only available when making global queries.

+
headers?: OutgoingHttpHeaders
highlightFields?: string[]

Specifies which fields to highlight. If specified, the result object contains a highlights field with an + entry for each specified field.

+
highlightNumber?: number

Number of fragments that are returned in highlights. If the search term occurs less often than the number of + fragments that are specified, longer fragments are returned.

+
highlightPostTag?: string

A string that is inserted after the highlighted word in the highlights output.

+
highlightPreTag?: string

A string that is inserted before the highlighted word in the highlights output.

+
highlightSize?: number

Number of characters in each fragment for highlights.

+
includeDocs?: boolean

Include the full content of the documents in the return.

+
includeFields?: string[]

A JSON array of field names to include in search results. Any fields that are included must be indexed with + the store:true option. The default is all fields.

+
index: string

Path parameter to specify the index name.

+
limit?: number

Limit the number of the returned documents to the specified number.

+
query: string

The Lucene query to execute.

+
ranges?: JsonObject

This field defines ranges for faceted, numeric search fields. The value is a JSON object where the fields + names are faceted numeric search fields, and the values of the fields are JSON objects. The field names of the + JSON objects are names for ranges. The values are strings that describe the range, for example "[0 TO 10]". This + option is only available when making global queries.

+
sort?: string[]

Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter + specifies the sort order within a group. The default sort order is relevance. A JSON string of the form + "fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a + string or number field, and type is either a number, a string, or a JSON array of strings. The type part is + optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and + ["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed + fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

+
stale?: string

Do not wait for the index to finish building to return results.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewAsStreamParams.html new file mode 100644 index 000000000..2a436a491 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewAsStreamParams.html @@ -0,0 +1,68 @@ +PostViewAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postViewAsStream operation.

+
interface PostViewAsStreamParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    descending?: boolean;
    endKey?: any;
    endKeyDocId?: string;
    group?: boolean;
    groupLevel?: number;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    reduce?: boolean;
    skip?: number;
    stable?: boolean;
    startKey?: any;
    startKeyDocId?: string;
    update?: string;
    updateSeq?: boolean;
    view: string;
}

Properties

attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: any

Schema for any JSON type.

+
endKeyDocId?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the + view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the + number of array elements with the group_level parameter.

+
groupLevel?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. + Implies group is true. Group level groups the reduced results by the specified number of array elements. If + unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys + that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce + function is defined.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
stable?: boolean

Query parameter to specify whether use the same replica of the index on each request. The default value + false contacts all replicas and returns the result from the first, fastest, responder. Setting it to true + when used in conjunction with update=false may improve consistency at the expense of increased latency and + decreased throughput if the selected replica is not the fastest of the available replicas.

+

Note: In general setting true is discouraged and is strictly not recommended when using update=true.

+
startKey?: any

Schema for any JSON type.

+
startKeyDocId?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+
view: string

Path parameter to specify the map reduce view function name.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewParams.html new file mode 100644 index 000000000..a02bf357b --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewParams.html @@ -0,0 +1,68 @@ +PostViewParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postView operation.

+
interface PostViewParams {
    attEncodingInfo?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    db: string;
    ddoc: string;
    descending?: boolean;
    endKey?: any;
    endKeyDocId?: string;
    group?: boolean;
    groupLevel?: number;
    headers?: OutgoingHttpHeaders;
    includeDocs?: boolean;
    inclusiveEnd?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    reduce?: boolean;
    skip?: number;
    stable?: boolean;
    startKey?: any;
    startKeyDocId?: string;
    update?: string;
    updateSeq?: boolean;
    view: string;
}

Properties

attEncodingInfo?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
endKey?: any

Schema for any JSON type.

+
endKeyDocId?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the + view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the + number of array elements with the group_level parameter.

+
groupLevel?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. + Implies group is true. Group level groups the reduced results by the specified number of array elements. If + unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
headers?: OutgoingHttpHeaders
includeDocs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusiveEnd?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys + that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce + function is defined.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
stable?: boolean

Query parameter to specify whether use the same replica of the index on each request. The default value + false contacts all replicas and returns the result from the first, fastest, responder. Setting it to true + when used in conjunction with update=false may improve consistency at the expense of increased latency and + decreased throughput if the selected replica is not the fastest of the available replicas.

+

Note: In general setting true is discouraged and is strictly not recommended when using update=true.

+
startKey?: any

Schema for any JSON type.

+
startKeyDocId?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
updateSeq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+
view: string

Path parameter to specify the map reduce view function name.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewQueriesAsStreamParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewQueriesAsStreamParams.html new file mode 100644 index 000000000..de7d02083 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewQueriesAsStreamParams.html @@ -0,0 +1,13 @@ +PostViewQueriesAsStreamParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postViewQueriesAsStream operation.

+
interface PostViewQueriesAsStreamParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    queries: ViewQuery[];
    view: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
queries: ViewQuery[]

An array of query objects with fields for the parameters of each individual view query to be executed. The + field names and their meaning are the same as the query parameters of a regular view request.

+
view: string

Path parameter to specify the map reduce view function name.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewQueriesParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewQueriesParams.html new file mode 100644 index 000000000..6628428e7 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PostViewQueriesParams.html @@ -0,0 +1,13 @@ +PostViewQueriesParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the postViewQueries operation.

+
interface PostViewQueriesParams {
    db: string;
    ddoc: string;
    headers?: OutgoingHttpHeaders;
    queries: ViewQuery[];
    view: string;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
headers?: OutgoingHttpHeaders
queries: ViewQuery[]

An array of query objects with fields for the parameters of each individual view query to be executed. The + field names and their meaning are the same as the query parameters of a regular view request.

+
view: string

Path parameter to specify the map reduce view function name.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutAttachmentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutAttachmentParams.html new file mode 100644 index 000000000..1a3b7cf74 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutAttachmentParams.html @@ -0,0 +1,17 @@ +PutAttachmentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putAttachment operation.

+
interface PutAttachmentParams {
    attachment: Buffer | ReadableStream;
    attachmentName: string;
    contentType: string;
    db: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    rev?: string;
}

Properties

attachment: Buffer | ReadableStream

HTTP request body for attachment operations.

+
attachmentName: string

Path parameter to specify the attachment name.

+
contentType: string

Content-Type of the attachment.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutCapacityThroughputConfigurationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutCapacityThroughputConfigurationParams.html new file mode 100644 index 000000000..3d015ab66 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutCapacityThroughputConfigurationParams.html @@ -0,0 +1,6 @@ +PutCapacityThroughputConfigurationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putCapacityThroughputConfiguration operation.

+
interface PutCapacityThroughputConfigurationParams {
    blocks: number;
    headers?: OutgoingHttpHeaders;
}

Properties

Properties

blocks: number

A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global + queries/sec of provisioned throughput capacity.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutCloudantSecurityConfigurationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutCloudantSecurityConfigurationParams.html new file mode 100644 index 000000000..4c44c97a2 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutCloudantSecurityConfigurationParams.html @@ -0,0 +1,13 @@ +PutCloudantSecurityConfigurationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putCloudantSecurityConfiguration operation.

+
interface PutCloudantSecurityConfigurationParams {
    admins?: SecurityObject;
    cloudant: JsonObject;
    couchdbAuthOnly?: boolean;
    db: string;
    headers?: OutgoingHttpHeaders;
    members?: SecurityObject;
}

Properties

Schema for names and roles to map to a database permission.

+
cloudant: JsonObject

Database permissions for Cloudant users and/or API keys.

+
couchdbAuthOnly?: boolean

Manage permissions using the _users database only.

+
db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
members?: SecurityObject

Schema for names and roles to map to a database permission.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutCorsConfigurationParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutCorsConfigurationParams.html new file mode 100644 index 000000000..e7b89bd38 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutCorsConfigurationParams.html @@ -0,0 +1,12 @@ +PutCorsConfigurationParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putCorsConfiguration operation.

+
interface PutCorsConfigurationParams {
    allowCredentials?: boolean;
    enableCors?: boolean;
    headers?: OutgoingHttpHeaders;
    origins: string[];
}

Properties

allowCredentials?: boolean

Boolean value to allow authentication credentials. If set to true, browser requests must be done by using + withCredentials = true.

+
enableCors?: boolean

Boolean value to turn CORS on and off.

+
headers?: OutgoingHttpHeaders
origins: string[]

An array of strings that contain allowed origin domains. You have to specify the full URL including the + protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you + have to specify all subdomains used.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutDatabaseParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutDatabaseParams.html new file mode 100644 index 000000000..c06afba6b --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutDatabaseParams.html @@ -0,0 +1,12 @@ +PutDatabaseParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putDatabase operation.

+
interface PutDatabaseParams {
    db: string;
    headers?: OutgoingHttpHeaders;
    partitioned?: boolean;
    q?: number;
}

Properties

Properties

db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
partitioned?: boolean

Query parameter to specify whether to enable database partitions when creating a database.

+
q?: number

The number of shards in the database. Each shard is a partition of the hash value range. Cloudant recommends + using the default value for most databases. However, if your database is expected to be larger than 250 GB or + have a lot of indexes, you may need to adjust the settings. In these cases, it's best to reach out to IBM + Cloudant customer support for guidance on how to meet your specific needs and requirements.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutDesignDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutDesignDocumentParams.html new file mode 100644 index 000000000..6fa42b79e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutDesignDocumentParams.html @@ -0,0 +1,21 @@ +PutDesignDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putDesignDocument operation.

+
interface PutDesignDocumentParams {
    batch?: string;
    db: string;
    ddoc: string;
    designDocument: DesignDocument;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    newEdits?: boolean;
    rev?: string;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
db: string

Path parameter to specify the database name.

+
ddoc: string

Path parameter to specify the design document name. The design document name is the design document ID + excluding the _design/ prefix.

+
designDocument: DesignDocument

HTTP request body for DesignDocument operations.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
newEdits?: boolean

Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a + well-formed _rev must be included in the document. False is used by the replicator to insert documents into the + target database even if that leads to the creation of conflicts.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutDocumentParams.html new file mode 100644 index 000000000..1c2aa49e9 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutDocumentParams.html @@ -0,0 +1,22 @@ +PutDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putDocument operation.

+
interface PutDocumentParams {
    batch?: string;
    contentType?: string;
    db: string;
    docId: string;
    document: Buffer | ReadableStream | Document;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    newEdits?: boolean;
    rev?: string;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
contentType?: string

The type of the input.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
document: Buffer | ReadableStream | Document

HTTP request body for Document operations.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
newEdits?: boolean

Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a + well-formed _rev must be included in the document. False is used by the replicator to insert documents into the + target database even if that leads to the creation of conflicts.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutLocalDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutLocalDocumentParams.html new file mode 100644 index 000000000..db21d6842 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutLocalDocumentParams.html @@ -0,0 +1,14 @@ +PutLocalDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putLocalDocument operation.

+
interface PutLocalDocumentParams {
    batch?: string;
    contentType?: string;
    db: string;
    docId: string;
    document: Buffer | ReadableStream | Document;
    headers?: OutgoingHttpHeaders;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
contentType?: string

The type of the input.

+
db: string

Path parameter to specify the database name.

+
docId: string

Path parameter to specify the document ID.

+
document: Buffer | ReadableStream | Document

HTTP request body for Document operations.

+
headers?: OutgoingHttpHeaders

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutReplicationDocumentParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutReplicationDocumentParams.html new file mode 100644 index 000000000..755c9a1d1 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutReplicationDocumentParams.html @@ -0,0 +1,18 @@ +PutReplicationDocumentParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putReplicationDocument operation.

+
interface PutReplicationDocumentParams {
    batch?: string;
    docId: string;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    newEdits?: boolean;
    replicationDocument: ReplicationDocument;
    rev?: string;
}

Properties

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted + response code immediately.

+
docId: string

Path parameter to specify the document ID.

+
headers?: OutgoingHttpHeaders
ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

+
newEdits?: boolean

Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a + well-formed _rev must be included in the document. False is used by the replicator to insert documents into the + target database even if that leads to the creation of conflicts.

+
replicationDocument: ReplicationDocument

HTTP request body for replication operations.

+
rev?: string

Query parameter to specify a document revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.PutSecurityParams.html b/docs/0.8.1/interfaces/cloudant_v1.export_.PutSecurityParams.html new file mode 100644 index 000000000..0c8102a26 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.PutSecurityParams.html @@ -0,0 +1,13 @@ +PutSecurityParams | @ibm-cloud/cloudant - v0.8.1

Parameters for the putSecurity operation.

+
interface PutSecurityParams {
    admins?: SecurityObject;
    cloudant?: JsonObject;
    couchdbAuthOnly?: boolean;
    db: string;
    headers?: OutgoingHttpHeaders;
    members?: SecurityObject;
}

Properties

Schema for names and roles to map to a database permission.

+
cloudant?: JsonObject

Database permissions for Cloudant users and/or API keys.

+
couchdbAuthOnly?: boolean

Manage permissions using the _users database only.

+
db: string

Path parameter to specify the database name.

+
headers?: OutgoingHttpHeaders
members?: SecurityObject

Schema for names and roles to map to a database permission.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationCreateTargetParameters.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationCreateTargetParameters.html new file mode 100644 index 000000000..181fa3df0 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationCreateTargetParameters.html @@ -0,0 +1,9 @@ +ReplicationCreateTargetParameters | @ibm-cloud/cloudant - v0.8.1

Request parameters to use during target database creation.

+
interface ReplicationCreateTargetParameters {
    n?: number;
    partitioned?: boolean;
    q?: number;
}

Properties

Properties

n?: number

Schema for the number of replicas of a database in a cluster. The cluster is using the default value and it + cannot be changed by the user.

+
partitioned?: boolean

Parameter to specify whether to enable database partitions when creating the target database.

+
q?: number

Schema for the number of shards in a database. Each shard is a partition of the hash value range.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabase.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabase.html new file mode 100644 index 000000000..344755139 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabase.html @@ -0,0 +1,8 @@ +ReplicationDatabase | @ibm-cloud/cloudant - v0.8.1

Schema for a replication source or target database.

+
interface ReplicationDatabase {
    auth?: ReplicationDatabaseAuth;
    headers?: JsonObject;
    url: string;
}

Properties

Properties

Schema for replication source or target database authentication.

+
headers?: JsonObject

Replication request headers.

+
url: string

Replication database URL.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabaseAuth.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabaseAuth.html new file mode 100644 index 000000000..249fed38a --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabaseAuth.html @@ -0,0 +1,6 @@ +ReplicationDatabaseAuth | @ibm-cloud/cloudant - v0.8.1

Schema for replication source or target database authentication.

+
interface ReplicationDatabaseAuth {
    basic?: ReplicationDatabaseAuthBasic;
    iam?: ReplicationDatabaseAuthIam;
}

Properties

Properties

Schema for basic authentication of replication source or target database.

+

Schema for an IAM API key for replication database authentication.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabaseAuthBasic.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabaseAuthBasic.html new file mode 100644 index 000000000..b7cc9f9cc --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabaseAuthBasic.html @@ -0,0 +1,6 @@ +ReplicationDatabaseAuthBasic | @ibm-cloud/cloudant - v0.8.1

Schema for basic authentication of replication source or target database.

+
interface ReplicationDatabaseAuthBasic {
    password: string;
    username: string;
}

Properties

Properties

password: string

The password associated with the username.

+
username: string

The username.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabaseAuthIam.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabaseAuthIam.html new file mode 100644 index 000000000..6c52a3073 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDatabaseAuthIam.html @@ -0,0 +1,4 @@ +ReplicationDatabaseAuthIam | @ibm-cloud/cloudant - v0.8.1

Schema for an IAM API key for replication database authentication.

+
interface ReplicationDatabaseAuthIam {
    api_key: string;
}

Properties

Properties

api_key: string

IAM API key.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDocument.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDocument.html new file mode 100644 index 000000000..45aad603d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ReplicationDocument.html @@ -0,0 +1,109 @@ +ReplicationDocument | @ibm-cloud/cloudant - v0.8.1

Schema for a replication document. Note that selector, doc_ids, and filter are incompatible with each other.

+
interface ReplicationDocument {
    _attachments?: JsonObject;
    _conflicts?: string[];
    _deleted?: boolean;
    _deleted_conflicts?: string[];
    _id?: string;
    _local_seq?: string;
    _rev?: string;
    _revisions?: Revisions;
    _revs_info?: DocumentRevisionStatus[];
    cancel?: boolean;
    checkpoint_interval?: number;
    connection_timeout?: number;
    continuous?: boolean;
    create_target?: boolean;
    create_target_params?: ReplicationCreateTargetParameters;
    doc_ids?: string[];
    filter?: string;
    http_connections?: number;
    query_params?: JsonObject;
    retries_per_request?: number;
    selector?: JsonObject;
    since_seq?: string;
    socket_options?: string;
    source: ReplicationDatabase;
    source_proxy?: string;
    target: ReplicationDatabase;
    target_proxy?: string;
    use_bulk_get?: boolean;
    use_checkpoints?: boolean;
    user_ctx?: UserContext;
    winning_revs_only?: boolean;
    worker_batch_size?: number;
    worker_processes?: number;
    [propName: string]: any;
}

Indexable

[propName: string]: any

ReplicationDocument accepts additional properties.

+

Properties

_attachments?: JsonObject

Schema for a map of attachment name to attachment metadata.

+
_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_deleted?: boolean

Deletion flag. Available if document was removed.

+
_deleted_conflicts?: string[]

Schema for a list of document revision identifiers.

+
_id?: string

Document ID.

+
_local_seq?: string

Document's update sequence in current database. Available if requested with local_seq=true query parameter.

+
_rev?: string

Schema for a document revision identifier.

+
_revisions?: Revisions

Schema for list of revision information.

+
_revs_info?: DocumentRevisionStatus[]

Schema for a list of objects with information about local revisions and their status.

+
cancel?: boolean

Cancels the replication.

+
checkpoint_interval?: number

Defines replication checkpoint interval in milliseconds.

+
connection_timeout?: number

HTTP connection timeout per replication. Even for very fast/reliable networks it might need to be increased + if a remote database is too busy.

+
continuous?: boolean

Configure the replication to be continuous.

+
create_target?: boolean

Creates the target database. Requires administrator privileges on target server.

+
create_target_params?: ReplicationCreateTargetParameters

Request parameters to use during target database creation.

+
doc_ids?: string[]

Schema for a list of document IDs.

+
filter?: string

The name of a filter function which is defined in a design document in the source database in + {ddoc_id}/{filter} format. It determines which documents get replicated. Using the selector option provides + performance benefits when compared with using the filter option. Use the selector option when possible.

+
http_connections?: number

Maximum number of HTTP connections per replication.

+
query_params?: JsonObject

Schema for a map of string key value pairs, such as query parameters.

+
retries_per_request?: number

Number of times a replication request is retried. The requests are retried with a doubling exponential + backoff starting at 0.25 seconds, with a cap at 5 minutes.

+
selector?: JsonObject

JSON object describing criteria used to select documents. The selector specifies fields in the document, and + provides an expression to evaluate with the field content or other data.

+

The selector object must:

+
    +
  • Be structured as valid JSON.
  • +
  • Contain a valid query expression.
  • +
+

Using a selector is significantly more efficient than using a JavaScript filter function, and is the recommended + option if filtering on document attributes only.

+

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for + those fields. You can create more complex selector expressions by combining operators.

+

Operators are identified by the use of a dollar sign $ prefix in the name field.

+

There are two core types of operators in the selector syntax:

+
    +
  • Combination operators: applied at the topmost level of selection. They are used to combine selectors. A + combination operator takes a single argument. The argument is either another selector, or an array of selectors.
  • +
  • Condition operators: are specific to a field, and are used to evaluate the value stored in that field. For + instance, the basic $eq operator matches when the specified field contains a value that is equal to the + supplied argument. See the Cloudant Docs for a + list of all available combination and conditional operators.
  • +
  • Only equality operators such as $eq, $gt, $gte, $lt, and $lte (but not $ne) can be used as the + basis of a query. You should include at least one of these in a selector.
  • +
+

For further reference see + selector syntax.

+
since_seq?: string

Start the replication at a specific sequence value.

+
socket_options?: string

Replication socket options.

+

Schema for a replication source or target database.

+
source_proxy?: string

Deprecated: This setting is forbidden in IBM Cloudant replication documents. This setting may be used with + alternative replication mediators.

+

Address of a (http or socks5 protocol) proxy server through which replication with the source database should + occur.

+

Schema for a replication source or target database.

+
target_proxy?: string

Deprecated: This setting is forbidden in IBM Cloudant replication documents. This setting may be used with + alternative replication mediators.

+

Address of a (http or socks5 protocol) proxy server through which replication with the target database should + occur.

+
use_bulk_get?: boolean

Specify whether to use _bulk_get for fetching documents from the source. If unset, the server configured + default will be used.

+
use_checkpoints?: boolean

Specify if checkpoints should be saved during replication. Using checkpoints means a replication can be + efficiently resumed.

+
user_ctx?: UserContext

Schema for the user context of a session.

+
winning_revs_only?: boolean

Replicate only the winning revisions. Replication with this mode discards conflicting revisions. Replication + IDs and checkpoints generated by this mode are different to those generated by default, so it is possible to + first replicate the winning revisions then later backfill remaining revisions with a regular replication job.

+
worker_batch_size?: number

Controls how many documents are processed. After each batch a checkpoint is written so this controls how + frequently checkpointing occurs.

+
worker_processes?: number

Controls how many separate processes will read from the changes manager and write to the target. A higher + number can improve throughput.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.Response.html b/docs/0.8.1/interfaces/cloudant_v1.export_.Response.html new file mode 100644 index 000000000..cec895f92 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.Response.html @@ -0,0 +1,6 @@ +Response | @ibm-cloud/cloudant - v0.8.1

An operation response.

+
interface Response<T> {
    headers: IncomingHttpHeaders;
    result: T;
    status: number;
    statusText: string;
}

Type Parameters

  • T = any

Properties

headers: IncomingHttpHeaders
result: T
status: number
statusText: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.Revisions.html b/docs/0.8.1/interfaces/cloudant_v1.export_.Revisions.html new file mode 100644 index 000000000..6b895f53f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.Revisions.html @@ -0,0 +1,6 @@ +Revisions | @ibm-cloud/cloudant - v0.8.1

Schema for list of revision information.

+
interface Revisions {
    ids: string[];
    start: number;
}

Properties

Properties

ids: string[]

Array of valid revision IDs, in reverse order (latest first).

+
start: number

Prefix number for the latest revision.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.RevsDiff.html b/docs/0.8.1/interfaces/cloudant_v1.export_.RevsDiff.html new file mode 100644 index 000000000..d9ce6488e --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.RevsDiff.html @@ -0,0 +1,6 @@ +RevsDiff | @ibm-cloud/cloudant - v0.8.1

Schema for information about missing revs and possible ancestors.

+
interface RevsDiff {
    missing?: string[];
    possible_ancestors?: string[];
}

Properties

missing?: string[]

List of missing revisions.

+
possible_ancestors?: string[]

List of possible ancestor revisions.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerDocsResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerDocsResult.html new file mode 100644 index 000000000..c1d875d1c --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerDocsResult.html @@ -0,0 +1,6 @@ +SchedulerDocsResult | @ibm-cloud/cloudant - v0.8.1

Schema for a listing of replication scheduler documents.

+
interface SchedulerDocsResult {
    docs: SchedulerDocument[];
    total_rows: number;
}

Properties

Properties

Array of replication scheduler doc objects.

+
total_rows: number

Number of total rows.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerDocument-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerDocument-1.html new file mode 100644 index 000000000..b9b18f6f4 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerDocument-1.html @@ -0,0 +1,33 @@ +SchedulerDocument | @ibm-cloud/cloudant - v0.8.1

Schema for a replication scheduler document.

+
interface SchedulerDocument {
    database: string;
    doc_id: string;
    error_count: number;
    id: string;
    info: SchedulerInfo;
    last_updated: string;
    node?: string;
    source?: string;
    source_proxy?: string;
    start_time: string;
    state: string;
    target?: string;
    target_proxy?: string;
}

Properties

database: string

Database where replication document came from.

+
doc_id: string

Replication document ID.

+
error_count: number

Consecutive errors count. Indicates how many times in a row this replication has crashed. Replication will + be retried with an exponential backoff based on this number. As soon as the replication succeeds this count is + reset to 0. To can be used to get an idea why a particular replication is not making progress.

+
id: string

Replication ID, or null if state is completed or failed.

+

Schema for scheduler document information. A JSON object that may contain additional information about the + state. For error states this will contain an error field and string value.

+
last_updated: string

Timestamp of last state update.

+
node?: string

Cluster node where the job is running.

+
source?: string

Replication source.

+
source_proxy?: string

Deprecated: Forbidden in IBM Cloudant mediated replications.

+

Address of the (http or socks5 protocol) proxy server through which replication with the source database occurs.

+
start_time: string

Timestamp of when the replication was started.

+
state: string

Schema for replication state.

+
target?: string

Replication target.

+
target_proxy?: string

Deprecated: Forbidden in IBM Cloudant mediated replications.

+

Address of the (http or socks5 protocol) proxy server through which replication with the target database occurs.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerInfo.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerInfo.html new file mode 100644 index 000000000..3a2b514e7 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerInfo.html @@ -0,0 +1,22 @@ +SchedulerInfo | @ibm-cloud/cloudant - v0.8.1

Schema for scheduler document information. A JSON object that may contain additional information about the state. For error states this will contain an error field and string value.

+
interface SchedulerInfo {
    changes_pending?: number;
    checkpointed_source_seq?: string;
    doc_write_failures?: number;
    docs_read?: number;
    docs_written?: number;
    error?: string;
    missing_revisions_found?: number;
    revisions_checked?: number;
    source_seq?: string;
    through_seq?: string;
}

Properties

changes_pending?: number

The count of changes not yet replicated.

+
checkpointed_source_seq?: string

The source sequence id which was last successfully replicated.

+
doc_write_failures?: number

The count of docs which failed to be written to the target.

+
docs_read?: number

The count of docs which have been read from the source.

+
docs_written?: number

The count of docs which have been written to the target.

+
error?: string

Replication error message.

+
missing_revisions_found?: number

The count of revisions which were found on the source, but missing from the target.

+
revisions_checked?: number

The count of revisions which have been checked since this replication began.

+
source_seq?: string

The last sequence number obtained from the source database changes feed.

+
through_seq?: string

The last sequence number processed by the replicator.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerJob.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerJob.html new file mode 100644 index 000000000..87ed4fc2a --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerJob.html @@ -0,0 +1,25 @@ +SchedulerJob | @ibm-cloud/cloudant - v0.8.1

Schema for a replication scheduler job.

+
interface SchedulerJob {
    database: string;
    doc_id: string;
    history: SchedulerJobEvent[];
    id: string;
    info: SchedulerInfo;
    node: string;
    pid: string;
    source: string;
    start_time: string;
    target: string;
    user: string;
}

Properties

database: string

Replication document database.

+
doc_id: string

Replication document ID.

+

Timestamped history of events as a list of objects.

+
id: string

Schema for a replication job id.

+

Schema for scheduler document information. A JSON object that may contain additional information about the + state. For error states this will contain an error field and string value.

+
node: string

Cluster node where the job is running.

+
pid: string

Replication process ID.

+
source: string

Replication source.

+
start_time: string

Timestamp of when the replication was started.

+
target: string

Replication target.

+
user: string

Name of user running replication.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerJobEvent.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerJobEvent.html new file mode 100644 index 000000000..89506f89c --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerJobEvent.html @@ -0,0 +1,8 @@ +SchedulerJobEvent | @ibm-cloud/cloudant - v0.8.1

Schema for a replication scheduler job event.

+
interface SchedulerJobEvent {
    reason?: string;
    timestamp: string;
    type: string;
}

Properties

Properties

reason?: string

Reason for current state of event.

+
timestamp: string

Timestamp of the event.

+
type: string

Type of the event.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerJobsResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerJobsResult.html new file mode 100644 index 000000000..6af7fde54 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SchedulerJobsResult.html @@ -0,0 +1,6 @@ +SchedulerJobsResult | @ibm-cloud/cloudant - v0.8.1

Schema for a listing of replication scheduler jobs.

+
interface SchedulerJobsResult {
    jobs: SchedulerJob[];
    total_rows: number;
}

Properties

Properties

jobs: SchedulerJob[]

Array of replication job objects.

+
total_rows: number

Number of total rows.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SearchAnalyzeResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchAnalyzeResult.html new file mode 100644 index 000000000..32992cbb2 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchAnalyzeResult.html @@ -0,0 +1,4 @@ +SearchAnalyzeResult | @ibm-cloud/cloudant - v0.8.1

Schema for the output of testing search analyzer tokenization.

+
interface SearchAnalyzeResult {
    tokens: string[];
}

Properties

Properties

tokens: string[]

tokens.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SearchIndexDefinition.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchIndexDefinition.html new file mode 100644 index 000000000..cba1a9d54 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchIndexDefinition.html @@ -0,0 +1,29 @@ +SearchIndexDefinition | @ibm-cloud/cloudant - v0.8.1

Schema for a search index definition.

+
interface SearchIndexDefinition {
    analyzer?: AnalyzerConfiguration;
    index: string;
}

Properties

Properties

Schema for a search analyzer configuration.

+
index: string

String form of a JavaScript function that is called for each document in the database. The function takes + the document as a parameter, extracts some data from it, and then calls the index function to index that data. + The index function takes 2, or optionally 3, parameters.

+
    +
  • The first parameter is the name of the field you intend to use when +querying the index. If the special value "default" is used when you +define the name, you do not have to specify a field name at query time.

    +
  • +
  • The second parameter is the data to be indexed. This data must be only a +string, number, or boolean. Other types will cause an error to be thrown +by the index function call.

    +
  • +
  • The optional third parameter is a JavaScript object with these +properties:

    +
      +
    • facet - boolean, default false - Creates a faceted index.
    • +
    • index - boolean, default true - If set to false, the data +cannot be used for searches, but can still be retrieved from the +index if store is set to true.
    • +
    • store - boolean, default true - If true, the value is returned +in the search result; otherwise, the value is not returned.
    • +
    +
  • +
+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SearchIndexInfo.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchIndexInfo.html new file mode 100644 index 000000000..8e077893d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchIndexInfo.html @@ -0,0 +1,14 @@ +SearchIndexInfo | @ibm-cloud/cloudant - v0.8.1

Schema for metadata information about a search index.

+
interface SearchIndexInfo {
    committed_seq: number;
    disk_size: number;
    doc_count: number;
    doc_del_count: number;
    pending_seq: number;
    signature: string;
}

Properties

committed_seq: number

The committed sequence identifier.

+
disk_size: number

The size of the search index on disk.

+
doc_count: number

The count of the number of indexed documents.

+
doc_del_count: number

The number of deleted documents.

+
pending_seq: number

The pending sequence identifier.

+
signature: string

Unique signature of the search index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SearchInfoResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchInfoResult.html new file mode 100644 index 000000000..cec3755c5 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchInfoResult.html @@ -0,0 +1,6 @@ +SearchInfoResult | @ibm-cloud/cloudant - v0.8.1

Schema for search index information.

+
interface SearchInfoResult {
    name: string;
    search_index: SearchIndexInfo;
}

Properties

Properties

name: string

The name of the search index prefixed by the design document ID where the index is stored.

+
search_index: SearchIndexInfo

Schema for metadata information about a search index.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SearchResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchResult.html new file mode 100644 index 000000000..daa30260f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchResult.html @@ -0,0 +1,17 @@ +SearchResult | @ibm-cloud/cloudant - v0.8.1

Schema for the result of a query search operation.

+
interface SearchResult {
    bookmark?: string;
    by?: string;
    counts?: JsonObject;
    groups?: SearchResultProperties[];
    ranges?: JsonObject;
    rows?: SearchResultRow[];
    total_rows: number;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
by?: string

Grouped search matches.

+
counts?: JsonObject

The counts facet syntax returns the number of query results for each unique value of each named field.

+

Array of grouped search matches.

+
ranges?: JsonObject

The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit + into each specified category.

+

Array of row objects.

+
total_rows: number

Number of total rows.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SearchResultProperties.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchResultProperties.html new file mode 100644 index 000000000..083e1b10b --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchResultProperties.html @@ -0,0 +1,15 @@ +SearchResultProperties | @ibm-cloud/cloudant - v0.8.1

Schema for the result of a query search operation.

+
interface SearchResultProperties {
    bookmark?: string;
    by?: string;
    counts?: JsonObject;
    ranges?: JsonObject;
    rows?: SearchResultRow[];
    total_rows: number;
}

Properties

bookmark?: string

Opaque bookmark token used when paginating results.

+
by?: string

Grouped search matches.

+
counts?: JsonObject

The counts facet syntax returns the number of query results for each unique value of each named field.

+
ranges?: JsonObject

The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit + into each specified category.

+

Array of row objects.

+
total_rows: number

Number of total rows.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SearchResultRow.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchResultRow.html new file mode 100644 index 000000000..71ae39dc4 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SearchResultRow.html @@ -0,0 +1,11 @@ +SearchResultRow | @ibm-cloud/cloudant - v0.8.1

Schema for a row of the result of a query search operation.

+
interface SearchResultRow {
    doc?: Document;
    fields: JsonObject;
    highlights?: JsonObject;
    id: string;
}

Properties

Properties

doc?: Document

Schema for a document.

+
fields: JsonObject

Schema for the fields returned by a query search operation, a map of field name to value.

+
highlights?: JsonObject

Returns the context in which a search term was mentioned so that you can display more emphasized results to + a user.

+
id: string

Schema for a document ID.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.Security.html b/docs/0.8.1/interfaces/cloudant_v1.export_.Security.html new file mode 100644 index 000000000..f591a2e7d --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.Security.html @@ -0,0 +1,10 @@ +Security | @ibm-cloud/cloudant - v0.8.1

Schema for a security document.

+
interface Security {
    admins?: SecurityObject;
    cloudant?: JsonObject;
    couchdb_auth_only?: boolean;
    members?: SecurityObject;
}

Properties

Schema for names and roles to map to a database permission.

+
cloudant?: JsonObject

Database permissions for Cloudant users and/or API keys.

+
couchdb_auth_only?: boolean

Manage permissions using the _users database only.

+
members?: SecurityObject

Schema for names and roles to map to a database permission.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SecurityObject.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SecurityObject.html new file mode 100644 index 000000000..7b64074d7 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SecurityObject.html @@ -0,0 +1,6 @@ +SecurityObject | @ibm-cloud/cloudant - v0.8.1

Schema for names and roles to map to a database permission.

+
interface SecurityObject {
    names?: string[];
    roles?: string[];
}

Properties

Properties

names?: string[]

List of usernames.

+
roles?: string[]

List of roles.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ServerInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ServerInformation.html new file mode 100644 index 000000000..34aa792a1 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ServerInformation.html @@ -0,0 +1,12 @@ +ServerInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about the server instance.

+
interface ServerInformation {
    couchdb: string;
    features: string[];
    features_flags: string[];
    vendor: ServerVendor;
    version: string;
}

Properties

couchdb: string

Welcome message.

+
features: string[]

List of enabled optional features.

+
features_flags: string[]

List of feature flags.

+
vendor: ServerVendor

Schema for server vendor information.

+
version: string

Apache CouchDB version.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ServerVendor.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ServerVendor.html new file mode 100644 index 000000000..da86ea430 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ServerVendor.html @@ -0,0 +1,8 @@ +ServerVendor | @ibm-cloud/cloudant - v0.8.1

Schema for server vendor information.

+
interface ServerVendor {
    name: string;
    variant?: string;
    version?: string;
}

Properties

Properties

name: string

Vendor name.

+
variant?: string

Vendor variant.

+
version?: string

Vendor version.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SessionAuthentication.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SessionAuthentication.html new file mode 100644 index 000000000..605b40b30 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SessionAuthentication.html @@ -0,0 +1,8 @@ +SessionAuthentication | @ibm-cloud/cloudant - v0.8.1

Schema for session authentication information.

+
interface SessionAuthentication {
    authenticated?: string;
    authentication_db?: string;
    authentication_handlers: string[];
}

Properties

authenticated?: string

authenticated.

+
authentication_db?: string

authentication_db.

+
authentication_handlers: string[]

authentication_handlers.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.SessionInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.SessionInformation.html new file mode 100644 index 000000000..f9d277be1 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.SessionInformation.html @@ -0,0 +1,8 @@ +SessionInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about a session.

+
interface SessionInformation {
    info: SessionAuthentication;
    ok: boolean;
    userCtx: UserContext;
}

Properties

Properties

Schema for session authentication information.

+
ok: boolean

ok.

+
userCtx: UserContext

Schema for the user context of a session.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ShardsInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ShardsInformation.html new file mode 100644 index 000000000..1b13a1723 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ShardsInformation.html @@ -0,0 +1,4 @@ +ShardsInformation | @ibm-cloud/cloudant - v0.8.1

Schema for a shards object that maps the hash value range for each shard to the array of nodes that contain a copy of that shard.

+
interface ShardsInformation {
    shards: JsonObject;
}

Properties

Properties

shards: JsonObject

Mapping of shard hash value range to a list of nodes.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ThroughputInformation.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ThroughputInformation.html new file mode 100644 index 000000000..0850069c4 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ThroughputInformation.html @@ -0,0 +1,11 @@ +ThroughputInformation | @ibm-cloud/cloudant - v0.8.1

Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.

+
interface ThroughputInformation {
    blocks: number;
    query: number;
    read: number;
    write: number;
}

Properties

Properties

blocks: number

A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global + queries/sec of provisioned throughput capacity.

+
query: number

Provisioned global queries capacity in operations per second.

+
read: number

Provisioned reads capacity in operations per second.

+
write: number

Provisioned writes capacity in operations per second.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.UpInformation-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.UpInformation-1.html new file mode 100644 index 000000000..8ca9b8164 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.UpInformation-1.html @@ -0,0 +1,6 @@ +UpInformation | @ibm-cloud/cloudant - v0.8.1

Schema for information about the up state of the server.

+
interface UpInformation {
    seeds: JsonObject;
    status: string;
}

Properties

Properties

seeds: JsonObject

seeds.

+
status: string

status.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.UpdatesPending.html b/docs/0.8.1/interfaces/cloudant_v1.export_.UpdatesPending.html new file mode 100644 index 000000000..c9426f609 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.UpdatesPending.html @@ -0,0 +1,9 @@ +UpdatesPending | @ibm-cloud/cloudant - v0.8.1

Schema for an ability to tell if view is up-to-date without querying it.

+
interface UpdatesPending {
    minimum: number;
    preferred: number;
    total: number;
}

Properties

Properties

minimum: number

Sum of shard copies with the least amount of work to do.

+
preferred: number

Sum of unique shards. This value is zero when at least one copy of every shard range is up-to-date and the + view is able to answer a query without index building delays.

+
total: number

Sum of all shard copies.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.UserContext-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.UserContext-1.html new file mode 100644 index 000000000..036b6e092 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.UserContext-1.html @@ -0,0 +1,8 @@ +UserContext | @ibm-cloud/cloudant - v0.8.1

Schema for the user context of a session.

+
interface UserContext {
    db?: string;
    name: string;
    roles: string[] | Roles[];
}

Properties

Properties

db?: string

Database name in the context of the provided operation.

+
name: string

User name.

+
roles: string[] | Roles[]

List of user roles.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.UuidsResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.UuidsResult.html new file mode 100644 index 000000000..af73d91c5 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.UuidsResult.html @@ -0,0 +1,4 @@ +UuidsResult | @ibm-cloud/cloudant - v0.8.1

Schema for a set of uuids generated by the server.

+
interface UuidsResult {
    uuids: string[];
}

Properties

Properties

uuids: string[]

uuids.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ViewQueriesResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ViewQueriesResult.html new file mode 100644 index 000000000..327f80916 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ViewQueriesResult.html @@ -0,0 +1,5 @@ +ViewQueriesResult | @ibm-cloud/cloudant - v0.8.1

Schema for the results of a queries view operation.

+
interface ViewQueriesResult {
    results: ViewResult[];
}

Properties

Properties

results: ViewResult[]

An array of result objects - one for each query. Each result object contains the same fields as the response + to a regular view request.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ViewQuery-1.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ViewQuery-1.html new file mode 100644 index 000000000..7ff51c827 --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ViewQuery-1.html @@ -0,0 +1,60 @@ +ViewQuery | @ibm-cloud/cloudant - v0.8.1

Schema for a query view operation.

+
interface ViewQuery {
    att_encoding_info?: boolean;
    attachments?: boolean;
    conflicts?: boolean;
    descending?: boolean;
    end_key?: any;
    end_key_doc_id?: string;
    group?: boolean;
    group_level?: number;
    include_docs?: boolean;
    inclusive_end?: boolean;
    key?: any;
    keys?: any[];
    limit?: number;
    reduce?: boolean;
    skip?: number;
    stable?: boolean;
    start_key?: any;
    start_key_doc_id?: string;
    update?: string;
    update_seq?: boolean;
}

Properties

att_encoding_info?: boolean

Parameter to specify whether to include the encoding information in attachment stubs if the particular + attachment is compressed.

+
attachments?: boolean

Parameter to specify whether to include attachments bodies in a response.

+
conflicts?: boolean

Parameter to specify whether to include a list of conflicted revisions in each returned document. Active + only when include_docs is true.

+
descending?: boolean

Parameter to specify whether to return the documents in descending by key order.

+
end_key?: any

Schema for any JSON type.

+
end_key_doc_id?: string

Schema for a document ID.

+
group?: boolean

Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the + view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the + number of array elements with the group_level parameter.

+
group_level?: number

Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. + Implies group is true. Group level groups the reduced results by the specified number of array elements. If + unset, results are grouped by the entire array key, returning a reduced value for each complete key.

+
include_docs?: boolean

Parameter to specify whether to include the full content of the documents in the response.

+
inclusive_end?: boolean

Parameter to specify whether the specified end key should be included in the result.

+
key?: any

Schema for any JSON type.

+
keys?: any[]

Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys + that match the key type emitted by the view function.

+
limit?: number

Parameter to specify the number of returned documents to limit the result to.

+
reduce?: boolean

Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce + function is defined.

+
skip?: number

Parameter to specify the number of records before starting to return the results.

+
stable?: boolean

Query parameter to specify whether use the same replica of the index on each request. The default value + false contacts all replicas and returns the result from the first, fastest, responder. Setting it to true + when used in conjunction with update=false may improve consistency at the expense of increased latency and + decreased throughput if the selected replica is not the fastest of the available replicas.

+

Note: In general setting true is discouraged and is strictly not recommended when using update=true.

+
start_key?: any

Schema for any JSON type.

+
start_key_doc_id?: string

Schema for a document ID.

+
update?: string

Parameter to specify whether or not the view in question should be updated prior to responding to the user.

+
    +
  • true - Return results after the view is updated.
  • +
  • false - Return results without updating the view.
  • +
  • lazy - Return the view results without waiting for an update, but update them immediately after the request.
  • +
+
update_seq?: boolean

Parameter to specify whether to include in the response an update_seq value indicating the sequence id of + the database the view reflects.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ViewResult.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ViewResult.html new file mode 100644 index 000000000..92cffb12f --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ViewResult.html @@ -0,0 +1,8 @@ +ViewResult | @ibm-cloud/cloudant - v0.8.1

Schema for the result of a query view operation.

+
interface ViewResult {
    rows: ViewResultRow[];
    total_rows?: number;
    update_seq?: string;
}

Properties

rows.

+
total_rows?: number

Number of total rows.

+
update_seq?: string

Current update sequence for the database.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/interfaces/cloudant_v1.export_.ViewResultRow.html b/docs/0.8.1/interfaces/cloudant_v1.export_.ViewResultRow.html new file mode 100644 index 000000000..5e0670a0b --- /dev/null +++ b/docs/0.8.1/interfaces/cloudant_v1.export_.ViewResultRow.html @@ -0,0 +1,16 @@ +ViewResultRow | @ibm-cloud/cloudant - v0.8.1

Schema for a row of a view result.

+
interface ViewResultRow {
    caused_by?: string;
    doc?: Document;
    error?: string;
    id?: string;
    key: any;
    reason?: string;
    value: any;
}

Properties

caused_by?: string

The cause of the error (if available).

+
doc?: Document

Schema for a document.

+
error?: string

The name of the error.

+
id?: string

Schema for a document ID.

+
key: any

Schema for any JSON type.

+
reason?: string

The reason the error occurred (if available).

+
value: any

Schema for any JSON type.

+

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/auth.html b/docs/0.8.1/modules/auth.html new file mode 100644 index 000000000..2502f4a4c --- /dev/null +++ b/docs/0.8.1/modules/auth.html @@ -0,0 +1,3 @@ +auth | @ibm-cloud/cloudant - v0.8.1

References

Re-exports CouchdbSessionAuthenticator
Re-exports SessionTokenManager

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/auth_couchdbSessionAuthenticator.html b/docs/0.8.1/modules/auth_couchdbSessionAuthenticator.html new file mode 100644 index 000000000..450920cc3 --- /dev/null +++ b/docs/0.8.1/modules/auth_couchdbSessionAuthenticator.html @@ -0,0 +1,3 @@ +auth/couchdbSessionAuthenticator | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/auth_sessionTokenManager.html b/docs/0.8.1/modules/auth_sessionTokenManager.html new file mode 100644 index 000000000..4ae4f01d3 --- /dev/null +++ b/docs/0.8.1/modules/auth_sessionTokenManager.html @@ -0,0 +1,3 @@ +auth/sessionTokenManager | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_features_changesFollower.html b/docs/0.8.1/modules/cloudant_features_changesFollower.html new file mode 100644 index 000000000..0920ae9fa --- /dev/null +++ b/docs/0.8.1/modules/cloudant_features_changesFollower.html @@ -0,0 +1,3 @@ +cloudant/features/changesFollower | @ibm-cloud/cloudant - v0.8.1

Module cloudant/features/changesFollower

Index

Enumerations

Classes

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_features_changesParamsHelper.html b/docs/0.8.1/modules/cloudant_features_changesParamsHelper.html new file mode 100644 index 000000000..2b1d516b5 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_features_changesParamsHelper.html @@ -0,0 +1,2 @@ +cloudant/features/changesParamsHelper | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_features_changesResultItemStream.html b/docs/0.8.1/modules/cloudant_features_changesResultItemStream.html new file mode 100644 index 000000000..4a0748530 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_features_changesResultItemStream.html @@ -0,0 +1,2 @@ +cloudant/features/changesResultItemStream | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_features_changesResultIterator.html b/docs/0.8.1/modules/cloudant_features_changesResultIterator.html new file mode 100644 index 000000000..090f14914 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_features_changesResultIterator.html @@ -0,0 +1,2 @@ +cloudant/features/changesResultIterator | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_features_stream.html b/docs/0.8.1/modules/cloudant_features_stream.html new file mode 100644 index 000000000..3411affb4 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_features_stream.html @@ -0,0 +1,2 @@ +cloudant/features/stream | @ibm-cloud/cloudant - v0.8.1

Module cloudant/features/stream

Index

Classes

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.ActiveTask.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.ActiveTask.Constants.html new file mode 100644 index 000000000..803a68d27 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.ActiveTask.Constants.html @@ -0,0 +1,4 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.ActiveTask.html b/docs/0.8.1/modules/cloudant_v1.export_.ActiveTask.html new file mode 100644 index 000000000..783bf11c2 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.ActiveTask.html @@ -0,0 +1,2 @@ +ActiveTask | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.ActivityTrackerEvents.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.ActivityTrackerEvents.Constants.html new file mode 100644 index 000000000..7c0c56e69 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.ActivityTrackerEvents.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.ActivityTrackerEvents.html b/docs/0.8.1/modules/cloudant_v1.export_.ActivityTrackerEvents.html new file mode 100644 index 000000000..589f8b92f --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.ActivityTrackerEvents.html @@ -0,0 +1,2 @@ +ActivityTrackerEvents | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.Analyzer.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.Analyzer.Constants.html new file mode 100644 index 000000000..a23e34ed1 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.Analyzer.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.Analyzer.html b/docs/0.8.1/modules/cloudant_v1.export_.Analyzer.html new file mode 100644 index 000000000..399f5081d --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.Analyzer.html @@ -0,0 +1,2 @@ +Analyzer | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.AnalyzerConfiguration.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.AnalyzerConfiguration.Constants.html new file mode 100644 index 000000000..50b533945 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.AnalyzerConfiguration.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.AnalyzerConfiguration.html b/docs/0.8.1/modules/cloudant_v1.export_.AnalyzerConfiguration.html new file mode 100644 index 000000000..7ad6ae7b0 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.AnalyzerConfiguration.html @@ -0,0 +1,2 @@ +AnalyzerConfiguration | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DbEvent.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.DbEvent.Constants.html new file mode 100644 index 000000000..7da434a4f --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DbEvent.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DbEvent.html b/docs/0.8.1/modules/cloudant_v1.export_.DbEvent.html new file mode 100644 index 000000000..6965be4ee --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DbEvent.html @@ -0,0 +1,2 @@ +DbEvent | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DeleteAttachmentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.DeleteAttachmentConstants.html new file mode 100644 index 000000000..f157f8f19 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DeleteAttachmentConstants.html @@ -0,0 +1,3 @@ +DeleteAttachmentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the deleteAttachment operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DeleteDesignDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.DeleteDesignDocumentConstants.html new file mode 100644 index 000000000..625e2867a --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DeleteDesignDocumentConstants.html @@ -0,0 +1,3 @@ +DeleteDesignDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the deleteDesignDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DeleteDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.DeleteDocumentConstants.html new file mode 100644 index 000000000..374d3a218 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DeleteDocumentConstants.html @@ -0,0 +1,3 @@ +DeleteDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the deleteDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DeleteIndexConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.DeleteIndexConstants.html new file mode 100644 index 000000000..a910b62ba --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DeleteIndexConstants.html @@ -0,0 +1,3 @@ +DeleteIndexConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the deleteIndex operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DeleteLocalDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.DeleteLocalDocumentConstants.html new file mode 100644 index 000000000..306056c5e --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DeleteLocalDocumentConstants.html @@ -0,0 +1,3 @@ +DeleteLocalDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the deleteLocalDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DeleteReplicationDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.DeleteReplicationDocumentConstants.html new file mode 100644 index 000000000..d62940544 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DeleteReplicationDocumentConstants.html @@ -0,0 +1,3 @@ +DeleteReplicationDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the deleteReplicationDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DocumentRevisionStatus.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.DocumentRevisionStatus.Constants.html new file mode 100644 index 000000000..06759f13a --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DocumentRevisionStatus.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.DocumentRevisionStatus.html b/docs/0.8.1/modules/cloudant_v1.export_.DocumentRevisionStatus.html new file mode 100644 index 000000000..cd11c6711 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.DocumentRevisionStatus.html @@ -0,0 +1,2 @@ +DocumentRevisionStatus | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.ExplainResultMrArgs.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.ExplainResultMrArgs.Constants.html new file mode 100644 index 000000000..aad7724d2 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.ExplainResultMrArgs.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.ExplainResultMrArgs.html b/docs/0.8.1/modules/cloudant_v1.export_.ExplainResultMrArgs.html new file mode 100644 index 000000000..fa6505c68 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.ExplainResultMrArgs.html @@ -0,0 +1,2 @@ +ExplainResultMrArgs | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.GetDbUpdatesConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.GetDbUpdatesConstants.html new file mode 100644 index 000000000..011d8d818 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.GetDbUpdatesConstants.html @@ -0,0 +1,3 @@ +GetDbUpdatesConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the getDbUpdates operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.GetLocalDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.GetLocalDocumentConstants.html new file mode 100644 index 000000000..843aa4783 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.GetLocalDocumentConstants.html @@ -0,0 +1,3 @@ +GetLocalDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the getLocalDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.GetSchedulerDocsConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.GetSchedulerDocsConstants.html new file mode 100644 index 000000000..adbe51f84 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.GetSchedulerDocsConstants.html @@ -0,0 +1,3 @@ +GetSchedulerDocsConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the getSchedulerDocs operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.IndexField.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.IndexField.Constants.html new file mode 100644 index 000000000..f0153162f --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.IndexField.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.IndexField.html b/docs/0.8.1/modules/cloudant_v1.export_.IndexField.html new file mode 100644 index 000000000..b5c0c47d6 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.IndexField.html @@ -0,0 +1,2 @@ +IndexField | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.IndexInformation.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.IndexInformation.Constants.html new file mode 100644 index 000000000..c697a8126 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.IndexInformation.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.IndexInformation.html b/docs/0.8.1/modules/cloudant_v1.export_.IndexInformation.html new file mode 100644 index 000000000..3e20641a8 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.IndexInformation.html @@ -0,0 +1,2 @@ +IndexInformation | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.IndexResult.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.IndexResult.Constants.html new file mode 100644 index 000000000..eb14051e3 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.IndexResult.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.IndexResult.html b/docs/0.8.1/modules/cloudant_v1.export_.IndexResult.html new file mode 100644 index 000000000..a615daa02 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.IndexResult.html @@ -0,0 +1,2 @@ +IndexResult | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostActivityTrackerEventsConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostActivityTrackerEventsConstants.html new file mode 100644 index 000000000..e85b2d8a6 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostActivityTrackerEventsConstants.html @@ -0,0 +1,3 @@ +PostActivityTrackerEventsConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postActivityTrackerEvents operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostChangesAsStreamConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostChangesAsStreamConstants.html new file mode 100644 index 000000000..6c9ac5993 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostChangesAsStreamConstants.html @@ -0,0 +1,3 @@ +PostChangesAsStreamConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postChangesAsStream operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostChangesConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostChangesConstants.html new file mode 100644 index 000000000..55ad32949 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostChangesConstants.html @@ -0,0 +1,3 @@ +PostChangesConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postChanges operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostDesignDocsConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostDesignDocsConstants.html new file mode 100644 index 000000000..5cdba9d45 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostDesignDocsConstants.html @@ -0,0 +1,3 @@ +PostDesignDocsConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postDesignDocs operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostDesignDocsQueriesConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostDesignDocsQueriesConstants.html new file mode 100644 index 000000000..8fd8f30d2 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostDesignDocsQueriesConstants.html @@ -0,0 +1,3 @@ +PostDesignDocsQueriesConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postDesignDocsQueries operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostDocumentConstants.html new file mode 100644 index 000000000..f3791c0a0 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostDocumentConstants.html @@ -0,0 +1,4 @@ +PostDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostExplainConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostExplainConstants.html new file mode 100644 index 000000000..05fbdc0e7 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostExplainConstants.html @@ -0,0 +1,4 @@ +PostExplainConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postExplain operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostFindAsStreamConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostFindAsStreamConstants.html new file mode 100644 index 000000000..80bd82b7b --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostFindAsStreamConstants.html @@ -0,0 +1,4 @@ +PostFindAsStreamConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postFindAsStream operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostFindConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostFindConstants.html new file mode 100644 index 000000000..bd3085646 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostFindConstants.html @@ -0,0 +1,4 @@ +PostFindConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postFind operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostIndexConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostIndexConstants.html new file mode 100644 index 000000000..e5a3b83bc --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostIndexConstants.html @@ -0,0 +1,3 @@ +PostIndexConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postIndex operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionExplainConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionExplainConstants.html new file mode 100644 index 000000000..5eb46952f --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionExplainConstants.html @@ -0,0 +1,4 @@ +PostPartitionExplainConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postPartitionExplain operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionFindAsStreamConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionFindAsStreamConstants.html new file mode 100644 index 000000000..b832856ae --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionFindAsStreamConstants.html @@ -0,0 +1,4 @@ +PostPartitionFindAsStreamConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postPartitionFindAsStream operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionFindConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionFindConstants.html new file mode 100644 index 000000000..fe2f48a6a --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionFindConstants.html @@ -0,0 +1,4 @@ +PostPartitionFindConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postPartitionFind operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionSearchAsStreamConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionSearchAsStreamConstants.html new file mode 100644 index 000000000..a06a5ded5 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionSearchAsStreamConstants.html @@ -0,0 +1,3 @@ +PostPartitionSearchAsStreamConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postPartitionSearchAsStream operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionSearchConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionSearchConstants.html new file mode 100644 index 000000000..d150d7a37 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionSearchConstants.html @@ -0,0 +1,3 @@ +PostPartitionSearchConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postPartitionSearch operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionViewAsStreamConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionViewAsStreamConstants.html new file mode 100644 index 000000000..4da4f8aba --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionViewAsStreamConstants.html @@ -0,0 +1,3 @@ +PostPartitionViewAsStreamConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postPartitionViewAsStream operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionViewConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionViewConstants.html new file mode 100644 index 000000000..757e53a94 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostPartitionViewConstants.html @@ -0,0 +1,3 @@ +PostPartitionViewConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postPartitionView operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostSearchAnalyzeConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostSearchAnalyzeConstants.html new file mode 100644 index 000000000..d17cab3a5 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostSearchAnalyzeConstants.html @@ -0,0 +1,3 @@ +PostSearchAnalyzeConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postSearchAnalyze operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostSearchAsStreamConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostSearchAsStreamConstants.html new file mode 100644 index 000000000..b18ea90c4 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostSearchAsStreamConstants.html @@ -0,0 +1,3 @@ +PostSearchAsStreamConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postSearchAsStream operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostSearchConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostSearchConstants.html new file mode 100644 index 000000000..a1f9af9af --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostSearchConstants.html @@ -0,0 +1,3 @@ +PostSearchConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postSearch operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostViewAsStreamConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostViewAsStreamConstants.html new file mode 100644 index 000000000..f5e80c0eb --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostViewAsStreamConstants.html @@ -0,0 +1,3 @@ +PostViewAsStreamConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postViewAsStream operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PostViewConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PostViewConstants.html new file mode 100644 index 000000000..220919b09 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PostViewConstants.html @@ -0,0 +1,3 @@ +PostViewConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the postView operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PutCloudantSecurityConfigurationConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PutCloudantSecurityConfigurationConstants.html new file mode 100644 index 000000000..a6de1dec1 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PutCloudantSecurityConfigurationConstants.html @@ -0,0 +1,3 @@ +PutCloudantSecurityConfigurationConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the putCloudantSecurityConfiguration operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PutDesignDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PutDesignDocumentConstants.html new file mode 100644 index 000000000..4cdf08a30 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PutDesignDocumentConstants.html @@ -0,0 +1,3 @@ +PutDesignDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the putDesignDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PutDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PutDocumentConstants.html new file mode 100644 index 000000000..f0dda871a --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PutDocumentConstants.html @@ -0,0 +1,4 @@ +PutDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the putDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PutLocalDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PutLocalDocumentConstants.html new file mode 100644 index 000000000..9f19ee080 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PutLocalDocumentConstants.html @@ -0,0 +1,4 @@ +PutLocalDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the putLocalDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PutReplicationDocumentConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PutReplicationDocumentConstants.html new file mode 100644 index 000000000..e8fa77cf2 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PutReplicationDocumentConstants.html @@ -0,0 +1,3 @@ +PutReplicationDocumentConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the putReplicationDocument operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.PutSecurityConstants.html b/docs/0.8.1/modules/cloudant_v1.export_.PutSecurityConstants.html new file mode 100644 index 000000000..6b012543d --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.PutSecurityConstants.html @@ -0,0 +1,3 @@ +PutSecurityConstants | @ibm-cloud/cloudant - v0.8.1

Constants for the putSecurity operation.

+

Index

Enumerations

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.SchedulerDocument.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.SchedulerDocument.Constants.html new file mode 100644 index 000000000..8e9585caf --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.SchedulerDocument.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.SchedulerDocument.html b/docs/0.8.1/modules/cloudant_v1.export_.SchedulerDocument.html new file mode 100644 index 000000000..d7adb60b6 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.SchedulerDocument.html @@ -0,0 +1,2 @@ +SchedulerDocument | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.UpInformation.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.UpInformation.Constants.html new file mode 100644 index 000000000..cf359ebab --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.UpInformation.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.UpInformation.html b/docs/0.8.1/modules/cloudant_v1.export_.UpInformation.html new file mode 100644 index 000000000..8a57f8c5c --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.UpInformation.html @@ -0,0 +1,2 @@ +UpInformation | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.UserContext.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.UserContext.Constants.html new file mode 100644 index 000000000..809c8fe57 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.UserContext.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.UserContext.html b/docs/0.8.1/modules/cloudant_v1.export_.UserContext.html new file mode 100644 index 000000000..6f1b7c1e6 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.UserContext.html @@ -0,0 +1,2 @@ +UserContext | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.ViewQuery.Constants.html b/docs/0.8.1/modules/cloudant_v1.export_.ViewQuery.Constants.html new file mode 100644 index 000000000..6e638576f --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.ViewQuery.Constants.html @@ -0,0 +1,2 @@ +Constants | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.ViewQuery.html b/docs/0.8.1/modules/cloudant_v1.export_.ViewQuery.html new file mode 100644 index 000000000..64fd89512 --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.ViewQuery.html @@ -0,0 +1,2 @@ +ViewQuery | @ibm-cloud/cloudant - v0.8.1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.export_.html b/docs/0.8.1/modules/cloudant_v1.export_.html new file mode 100644 index 000000000..417c219ba --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.export_.html @@ -0,0 +1,252 @@ +export= | @ibm-cloud/cloudant - v0.8.1

+

interfaces

+
+

Index

Namespaces

Interfaces

ActiveTask +ActivityTrackerEvents +AllDocsQueriesResult +AllDocsQuery +AllDocsResult +Analyzer +AnalyzerConfiguration +ApiKeysResult +Attachment +BulkDocs +BulkGetQueryDocument +BulkGetResult +BulkGetResultDocument +BulkGetResultItem +CapacityThroughputInformation +CapacityThroughputInformationCurrent +CapacityThroughputInformationTarget +Change +ChangesResult +ChangesResultItem +ContentInformationSizes +CorsInformation +CurrentThroughputInformation +CurrentThroughputInformationThroughput +DatabaseInformation +DatabaseInformationCluster +DatabaseInformationProps +DbEvent +DbUpdates +DbsInfoResult +DeleteAttachmentParams +DeleteDatabaseParams +DeleteDesignDocumentParams +DeleteDocumentParams +DeleteIndexParams +DeleteLocalDocumentParams +DeleteReplicationDocumentParams +DesignDocument +DesignDocumentInformation +DesignDocumentOptions +DesignDocumentViewIndex +DesignDocumentViewsMapReduce +DocsResultRow +DocsResultRowValue +Document +DocumentResult +DocumentRevisionStatus +DocumentShardInfo +EmptyObject +ExecutionStats +ExplainResult +ExplainResultMrArgs +ExplainResultOpts +FindResult +GetActiveTasksParams +GetActivityTrackerEventsParams +GetAllDbsParams +GetAttachmentParams +GetCapacityThroughputInformationParams +GetCorsInformationParams +GetCurrentThroughputInformationParams +GetDatabaseInformationParams +GetDbUpdatesParams +GetDesignDocumentInformationParams +GetDesignDocumentParams +GetDocumentAsMixedParams +GetDocumentAsRelatedParams +GetDocumentAsStreamParams +GetDocumentParams +GetDocumentShardsInfoParams +GetIndexesInformationParams +GetLocalDocumentParams +GetMembershipInformationParams +GetPartitionInformationParams +GetReplicationDocumentParams +GetSchedulerDocsParams +GetSchedulerDocumentParams +GetSchedulerJobParams +GetSchedulerJobsParams +GetSearchInfoParams +GetSecurityParams +GetServerInformationParams +GetSessionInformationParams +GetShardsInformationParams +GetUpInformationParams +GetUuidsParams +HeadAttachmentParams +HeadDatabaseParams +HeadDesignDocumentParams +HeadDocumentParams +HeadLocalDocumentParams +HeadReplicationDocumentParams +HeadSchedulerDocumentParams +HeadSchedulerJobParams +HeadUpInformationParams +IndexDefinition +IndexField +IndexInformation +IndexResult +IndexTextOperatorDefaultField +IndexesInformation +JsonObject +MembershipInformation +Ok +PartitionInformation +PartitionInformationIndexes +PartitionInformationIndexesIndexes +PartitionInformationSizes +PartitionedIndexesDetailedInformation +PartitionedIndexesInformation +PostActivityTrackerEventsParams +PostAllDocsAsStreamParams +PostAllDocsParams +PostAllDocsQueriesAsStreamParams +PostAllDocsQueriesParams +PostApiKeysParams +PostBulkDocsParams +PostBulkGetAsMixedParams +PostBulkGetAsRelatedParams +PostBulkGetAsStreamParams +PostBulkGetParams +PostChangesAsStreamParams +PostChangesParams +PostDbsInfoParams +PostDesignDocsParams +PostDesignDocsQueriesParams +PostDocumentParams +PostExplainParams +PostFindAsStreamParams +PostFindParams +PostIndexParams +PostPartitionAllDocsAsStreamParams +PostPartitionAllDocsParams +PostPartitionExplainParams +PostPartitionFindAsStreamParams +PostPartitionFindParams +PostPartitionSearchAsStreamParams +PostPartitionSearchParams +PostPartitionViewAsStreamParams +PostPartitionViewParams +PostRevsDiffParams +PostSearchAnalyzeParams +PostSearchAsStreamParams +PostSearchParams +PostViewAsStreamParams +PostViewParams +PostViewQueriesAsStreamParams +PostViewQueriesParams +PutAttachmentParams +PutCapacityThroughputConfigurationParams +PutCloudantSecurityConfigurationParams +PutCorsConfigurationParams +PutDatabaseParams +PutDesignDocumentParams +PutDocumentParams +PutLocalDocumentParams +PutReplicationDocumentParams +PutSecurityParams +ReplicationCreateTargetParameters +ReplicationDatabase +ReplicationDatabaseAuth +ReplicationDatabaseAuthBasic +ReplicationDatabaseAuthIam +ReplicationDocument +Response +Revisions +RevsDiff +SchedulerDocsResult +SchedulerDocument +SchedulerInfo +SchedulerJob +SchedulerJobEvent +SchedulerJobsResult +SearchAnalyzeResult +SearchIndexDefinition +SearchIndexInfo +SearchInfoResult +SearchResult +SearchResultProperties +SearchResultRow +Security +SecurityObject +ServerInformation +ServerVendor +SessionAuthentication +SessionInformation +ShardsInformation +ThroughputInformation +UpInformation +UpdatesPending +UserContext +UuidsResult +ViewQueriesResult +ViewQuery +ViewResult +ViewResultRow +

Type Aliases

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/modules/cloudant_v1.html b/docs/0.8.1/modules/cloudant_v1.html new file mode 100644 index 000000000..971889ddb --- /dev/null +++ b/docs/0.8.1/modules/cloudant_v1.html @@ -0,0 +1,186 @@ +cloudant/v1 | @ibm-cloud/cloudant - v0.8.1

References

AllDocsQueriesResult +AllDocsQuery +AllDocsResult +ApiKeysResult +Attachment +BulkDocs +BulkGetQueryDocument +BulkGetResult +BulkGetResultDocument +BulkGetResultItem +Callback +CapacityThroughputInformation +CapacityThroughputInformationCurrent +CapacityThroughputInformationTarget +Change +ChangesResult +ChangesResultItem +ContentInformationSizes +CorsInformation +CurrentThroughputInformation +CurrentThroughputInformationThroughput +DatabaseInformation +DatabaseInformationCluster +DatabaseInformationProps +DbUpdates +DbsInfoResult +DeleteAttachmentParams +DeleteDatabaseParams +DeleteDesignDocumentParams +DeleteDocumentParams +DeleteIndexParams +DeleteLocalDocumentParams +DeleteReplicationDocumentParams +DesignDocument +DesignDocumentInformation +DesignDocumentOptions +DesignDocumentViewIndex +DesignDocumentViewsMapReduce +DocsResultRow +DocsResultRowValue +Document +DocumentResult +DocumentShardInfo +EmptyObject +ExecutionStats +ExplainResult +ExplainResultOpts +FindResult +GetActiveTasksParams +GetActivityTrackerEventsParams +GetAllDbsParams +GetAttachmentParams +GetCapacityThroughputInformationParams +GetCorsInformationParams +GetCurrentThroughputInformationParams +GetDatabaseInformationParams +GetDbUpdatesParams +GetDesignDocumentInformationParams +GetDesignDocumentParams +GetDocumentAsMixedParams +GetDocumentAsRelatedParams +GetDocumentAsStreamParams +GetDocumentParams +GetDocumentShardsInfoParams +GetIndexesInformationParams +GetLocalDocumentParams +GetMembershipInformationParams +GetPartitionInformationParams +GetReplicationDocumentParams +GetSchedulerDocsParams +GetSchedulerDocumentParams +GetSchedulerJobParams +GetSchedulerJobsParams +GetSearchInfoParams +GetSecurityParams +GetServerInformationParams +GetSessionInformationParams +GetShardsInformationParams +GetUpInformationParams +GetUuidsParams +HeadAttachmentParams +HeadDatabaseParams +HeadDesignDocumentParams +HeadDocumentParams +HeadLocalDocumentParams +HeadReplicationDocumentParams +HeadSchedulerDocumentParams +HeadSchedulerJobParams +HeadUpInformationParams +IndexDefinition +IndexTextOperatorDefaultField +IndexesInformation +JsonObject +MembershipInformation +Ok +PartitionInformation +PartitionInformationIndexes +PartitionInformationIndexesIndexes +PartitionInformationSizes +PartitionedIndexesDetailedInformation +PartitionedIndexesInformation +PostActivityTrackerEventsParams +PostAllDocsAsStreamParams +PostAllDocsParams +PostAllDocsQueriesAsStreamParams +PostAllDocsQueriesParams +PostApiKeysParams +PostBulkDocsParams +PostBulkGetAsMixedParams +PostBulkGetAsRelatedParams +PostBulkGetAsStreamParams +PostBulkGetParams +PostChangesAsStreamParams +PostChangesParams +PostDbsInfoParams +PostDesignDocsParams +PostDesignDocsQueriesParams +PostDocumentParams +PostExplainParams +PostFindAsStreamParams +PostFindParams +PostIndexParams +PostPartitionAllDocsAsStreamParams +PostPartitionAllDocsParams +PostPartitionExplainParams +PostPartitionFindAsStreamParams +PostPartitionFindParams +PostPartitionSearchAsStreamParams +PostPartitionSearchParams +PostPartitionViewAsStreamParams +PostPartitionViewParams +PostRevsDiffParams +PostSearchAnalyzeParams +PostSearchAsStreamParams +PostSearchParams +PostViewAsStreamParams +PostViewParams +PostViewQueriesAsStreamParams +PostViewQueriesParams +PutAttachmentParams +PutCapacityThroughputConfigurationParams +PutCloudantSecurityConfigurationParams +PutCorsConfigurationParams +PutDatabaseParams +PutDesignDocumentParams +PutDocumentParams +PutLocalDocumentParams +PutReplicationDocumentParams +PutSecurityParams +ReplicationCreateTargetParameters +ReplicationDatabase +ReplicationDatabaseAuth +ReplicationDatabaseAuthBasic +ReplicationDatabaseAuthIam +ReplicationDocument +Response +Revisions +RevsDiff +SchedulerDocsResult +SchedulerInfo +SchedulerJob +SchedulerJobEvent +SchedulerJobsResult +SearchAnalyzeResult +SearchIndexDefinition +SearchIndexInfo +SearchInfoResult +SearchResult +SearchResultProperties +SearchResultRow +Security +SecurityObject +ServerInformation +ServerVendor +SessionAuthentication +SessionInformation +ShardsInformation +ThroughputInformation +UpdatesPending +UuidsResult +ViewQueriesResult +ViewResult +ViewResultRow +

Namespaces

Classes

References

Re-exports AllDocsQueriesResult
Re-exports AllDocsQuery
Re-exports AllDocsResult
Re-exports ApiKeysResult
Re-exports Attachment
Re-exports BulkDocs
Re-exports BulkGetQueryDocument
Re-exports BulkGetResult
Re-exports BulkGetResultDocument
Re-exports BulkGetResultItem
Re-exports Callback
Re-exports CapacityThroughputInformation
Re-exports CapacityThroughputInformationCurrent
Re-exports CapacityThroughputInformationTarget
Re-exports Change
Re-exports ChangesResult
Re-exports ChangesResultItem
Re-exports ContentInformationSizes
Re-exports CorsInformation
Re-exports CurrentThroughputInformation
Re-exports CurrentThroughputInformationThroughput
Re-exports DatabaseInformation
Re-exports DatabaseInformationCluster
Re-exports DatabaseInformationProps
Re-exports DbUpdates
Re-exports DbsInfoResult
Re-exports DeleteAttachmentParams
Re-exports DeleteDatabaseParams
Re-exports DeleteDesignDocumentParams
Re-exports DeleteDocumentParams
Re-exports DeleteIndexParams
Re-exports DeleteLocalDocumentParams
Re-exports DeleteReplicationDocumentParams
Re-exports DesignDocument
Re-exports DesignDocumentInformation
Re-exports DesignDocumentOptions
Re-exports DesignDocumentViewIndex
Re-exports DesignDocumentViewsMapReduce
Re-exports DocsResultRow
Re-exports DocsResultRowValue
Re-exports Document
Re-exports DocumentResult
Re-exports DocumentShardInfo
Re-exports EmptyObject
Re-exports ExecutionStats
Re-exports ExplainResult
Re-exports ExplainResultOpts
Re-exports FindResult
Re-exports GetActiveTasksParams
Re-exports GetActivityTrackerEventsParams
Re-exports GetAllDbsParams
Re-exports GetAttachmentParams
Re-exports GetCapacityThroughputInformationParams
Re-exports GetCorsInformationParams
Re-exports GetCurrentThroughputInformationParams
Re-exports GetDatabaseInformationParams
Re-exports GetDbUpdatesParams
Re-exports GetDesignDocumentInformationParams
Re-exports GetDesignDocumentParams
Re-exports GetDocumentAsMixedParams
Re-exports GetDocumentAsRelatedParams
Re-exports GetDocumentAsStreamParams
Re-exports GetDocumentParams
Re-exports GetDocumentShardsInfoParams
Re-exports GetIndexesInformationParams
Re-exports GetLocalDocumentParams
Re-exports GetMembershipInformationParams
Re-exports GetPartitionInformationParams
Re-exports GetReplicationDocumentParams
Re-exports GetSchedulerDocsParams
Re-exports GetSchedulerDocumentParams
Re-exports GetSchedulerJobParams
Re-exports GetSchedulerJobsParams
Re-exports GetSearchInfoParams
Re-exports GetSecurityParams
Re-exports GetServerInformationParams
Re-exports GetSessionInformationParams
Re-exports GetShardsInformationParams
Re-exports GetUpInformationParams
Re-exports GetUuidsParams
Re-exports HeadAttachmentParams
Re-exports HeadDatabaseParams
Re-exports HeadDesignDocumentParams
Re-exports HeadDocumentParams
Re-exports HeadLocalDocumentParams
Re-exports HeadReplicationDocumentParams
Re-exports HeadSchedulerDocumentParams
Re-exports HeadSchedulerJobParams
Re-exports HeadUpInformationParams
Re-exports IndexDefinition
Re-exports IndexTextOperatorDefaultField
Re-exports IndexesInformation
Re-exports JsonObject
Re-exports MembershipInformation
Re-exports Ok
Re-exports PartitionInformation
Re-exports PartitionInformationIndexes
Re-exports PartitionInformationIndexesIndexes
Re-exports PartitionInformationSizes
Re-exports PartitionedIndexesDetailedInformation
Re-exports PartitionedIndexesInformation
Re-exports PostActivityTrackerEventsParams
Re-exports PostAllDocsAsStreamParams
Re-exports PostAllDocsParams
Re-exports PostAllDocsQueriesAsStreamParams
Re-exports PostAllDocsQueriesParams
Re-exports PostApiKeysParams
Re-exports PostBulkDocsParams
Re-exports PostBulkGetAsMixedParams
Re-exports PostBulkGetAsRelatedParams
Re-exports PostBulkGetAsStreamParams
Re-exports PostBulkGetParams
Re-exports PostChangesAsStreamParams
Re-exports PostChangesParams
Re-exports PostDbsInfoParams
Re-exports PostDesignDocsParams
Re-exports PostDesignDocsQueriesParams
Re-exports PostDocumentParams
Re-exports PostExplainParams
Re-exports PostFindAsStreamParams
Re-exports PostFindParams
Re-exports PostIndexParams
Re-exports PostPartitionAllDocsAsStreamParams
Re-exports PostPartitionAllDocsParams
Re-exports PostPartitionExplainParams
Re-exports PostPartitionFindAsStreamParams
Re-exports PostPartitionFindParams
Re-exports PostPartitionSearchAsStreamParams
Re-exports PostPartitionSearchParams
Re-exports PostPartitionViewAsStreamParams
Re-exports PostPartitionViewParams
Re-exports PostRevsDiffParams
Re-exports PostSearchAnalyzeParams
Re-exports PostSearchAsStreamParams
Re-exports PostSearchParams
Re-exports PostViewAsStreamParams
Re-exports PostViewParams
Re-exports PostViewQueriesAsStreamParams
Re-exports PostViewQueriesParams
Re-exports PutAttachmentParams
Re-exports PutCapacityThroughputConfigurationParams
Re-exports PutCloudantSecurityConfigurationParams
Re-exports PutCorsConfigurationParams
Re-exports PutDatabaseParams
Re-exports PutDesignDocumentParams
Re-exports PutDocumentParams
Re-exports PutLocalDocumentParams
Re-exports PutReplicationDocumentParams
Re-exports PutSecurityParams
Re-exports ReplicationCreateTargetParameters
Re-exports ReplicationDatabase
Re-exports ReplicationDatabaseAuth
Re-exports ReplicationDatabaseAuthBasic
Re-exports ReplicationDatabaseAuthIam
Re-exports ReplicationDocument
Re-exports Response
Re-exports Revisions
Re-exports RevsDiff
Re-exports SchedulerDocsResult
Re-exports SchedulerInfo
Re-exports SchedulerJob
Re-exports SchedulerJobEvent
Re-exports SchedulerJobsResult
Re-exports SearchAnalyzeResult
Re-exports SearchIndexDefinition
Re-exports SearchIndexInfo
Re-exports SearchInfoResult
Re-exports SearchResult
Re-exports SearchResultProperties
Re-exports SearchResultRow
Re-exports Security
Re-exports SecurityObject
Re-exports ServerInformation
Re-exports ServerVendor
Re-exports SessionAuthentication
Re-exports SessionInformation
Re-exports ShardsInformation
Re-exports ThroughputInformation
Re-exports UpdatesPending
Re-exports UuidsResult
Re-exports ViewQueriesResult
Re-exports ViewResult
Re-exports ViewResultRow

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/types/auth_couchdbSessionAuthenticator.CouchdbSessionAuthenticatorOptions.html b/docs/0.8.1/types/auth_couchdbSessionAuthenticator.CouchdbSessionAuthenticatorOptions.html new file mode 100644 index 000000000..2950e68ba --- /dev/null +++ b/docs/0.8.1/types/auth_couchdbSessionAuthenticator.CouchdbSessionAuthenticatorOptions.html @@ -0,0 +1,4 @@ +CouchdbSessionAuthenticatorOptions | @ibm-cloud/cloudant - v0.8.1
CouchdbSessionAuthenticatorOptions: {
    password: string;
    username: string;
}

Configuration options for CouchDB session authentication.

+

Type declaration

  • password: string

    The password to be used in CouchDB session authentication.

    +
  • username: string

    The username to be used in CouchDB session authentication.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/0.8.1/types/cloudant_v1.export_.Callback.html b/docs/0.8.1/types/cloudant_v1.export_.Callback.html new file mode 100644 index 000000000..58241ae45 --- /dev/null +++ b/docs/0.8.1/types/cloudant_v1.export_.Callback.html @@ -0,0 +1,2 @@ +Callback | @ibm-cloud/cloudant - v0.8.1
Callback<T>: ((error, response?) => void)

The callback for a service request.

+

Type Parameters

  • T

Type declaration

    • (error, response?): void
    • Parameters

      Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/latest b/docs/latest index 3617dec53..2cd22f0c4 120000 --- a/docs/latest +++ b/docs/latest @@ -1 +1 @@ -./0.8.0 \ No newline at end of file +./0.8.1 \ No newline at end of file diff --git a/index.html b/index.html index 78b5d3b0e..94e0a8680 100644 --- a/index.html +++ b/index.html @@ -54,6 +54,7 @@

IBM Cloudant Node SDK Documentation

  • 0.7.1
  • 0.7.2
  • 0.8.0
  • +
  • 0.8.1