From 6208422884b711d6aa619ae02a152b1d5e620b9d Mon Sep 17 00:00:00 2001 From: Erik Brinkman Date: Thu, 4 Apr 2024 00:09:17 -0400 Subject: [PATCH] v4.0.0 --- CHANGELOG.md | 13 + docs/assets/highlight.css | 7 + docs/assets/icons.js | 15 + docs/assets/icons.svg | 1 + docs/assets/main.js | 7 +- docs/assets/navigation.js | 1 + docs/assets/search.js | 2 +- docs/assets/style.css | 100 ++- docs/classes/GenerationError.html | 230 +----- docs/classes/ResponseError.html | 263 +------ docs/functions/formatEntry.html | 98 +-- docs/functions/parseEntry.html | 98 +-- docs/functions/register.html | 106 +-- docs/functions/remarkable.html | 106 +-- docs/hierarchy.html | 1 + docs/index.html | 98 +-- docs/interfaces/BaseMetadataEntry.html | 134 +--- docs/interfaces/CacheLike.html | 149 +--- docs/interfaces/CollectionEntry.html | 167 +---- docs/interfaces/CollectionMetadataEntry.html | 266 +------ docs/interfaces/CollectionTypeMetadata.html | 240 +------ docs/interfaces/CommonMetadata.html | 218 +----- docs/interfaces/Content.html | 299 +------- docs/interfaces/CreateMoveOptions.html | 139 +--- docs/interfaces/DocumentMetadata.html | 131 +--- docs/interfaces/DocumentMetadataEntry.html | 306 +------- docs/interfaces/DocumentTypeMetadata.html | 266 +------ docs/interfaces/FetchLike.html | 109 +-- docs/interfaces/FileEntry.html | 167 +---- docs/interfaces/GetRootHashOptions.html | 123 +--- docs/interfaces/HeadersLike.html | 127 +--- docs/interfaces/PutEpubOptions.html | 215 +----- docs/interfaces/PutPdfOptions.html | 155 +---- docs/interfaces/RegisterOptions.html | 155 +---- docs/interfaces/RemarkableApi.html | 694 +++---------------- docs/interfaces/RemarkableOptions.html | 199 +----- docs/interfaces/RequestInitLike.html | 143 +--- docs/interfaces/ResponseLike.html | 190 +---- docs/interfaces/SubtleCryptoLike.html | 129 +--- docs/interfaces/UploadEntry.html | 131 +--- docs/modules.html | 192 ++--- docs/types/Entry.html | 89 +-- docs/types/ExtraMetadata.html | 89 +-- docs/types/FileType.html | 89 +-- docs/types/Metadata.html | 89 +-- docs/types/MetadataEntry.html | 89 +-- docs/types/RequestMethod.html | 89 +-- docs/types/TextAlignment.html | 89 +-- docs/types/Transform.html | 89 +-- docs/variables/builtinFontNames.html | 89 +-- docs/variables/builtinLineHeights.html | 116 +--- docs/variables/builtinMargins.html | 116 +--- docs/variables/builtinTextScales.html | 128 +--- docs/variables/builtinTools.html | 89 +-- package.json | 2 +- 55 files changed, 654 insertions(+), 6788 deletions(-) create mode 100644 docs/assets/icons.js create mode 100644 docs/assets/icons.svg create mode 100644 docs/assets/navigation.js create mode 100644 docs/hierarchy.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 93c6a1a..55c5aaf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [4.0.0] - 2024-04-03 + +### Added + +- `verify` option to some calls to disable verifying that requests follow the + expected format. Note that disabling verification will break typescripts + guarantees, and so it's only recommend if you know what you're doing. + +### Modified + +- `lastModified` is now optional. This might break some code that replied on it + to be present. + ## [3.1.0] - 2023-12-05 ### Added diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 15c7497..8fd06d3 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -15,6 +15,8 @@ --dark-hl-6: #6A9955; --light-hl-7: #795E26; --dark-hl-7: #DCDCAA; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -28,6 +30,7 @@ --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); --code-background: var(--light-code-background); } } @@ -40,6 +43,7 @@ --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); --code-background: var(--dark-code-background); } } @@ -52,6 +56,7 @@ --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); --code-background: var(--light-code-background); } @@ -64,6 +69,7 @@ --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); --code-background: var(--dark-code-background); } @@ -75,4 +81,5 @@ .hl-5 { color: var(--hl-5); } .hl-6 { color: var(--hl-6); } .hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js new file mode 100644 index 0000000..b79c9e8 --- /dev/null +++ b/docs/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg new file mode 100644 index 0000000..7dead61 --- /dev/null +++ b/docs/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 4c8fa61..1daeb69 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},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),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=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,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.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){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=n}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,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(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);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()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(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}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=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=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_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),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=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.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.scrollToHash(),this.updateIndexVisibility())}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()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.scrollToHash(),this.updateIndexVisibility())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&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 y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}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 He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!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&&(Be=!0,F="touchstart",fe="touchmove",H="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(fe,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(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,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 ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(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.showPage(),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.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-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: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..ffff7c4 --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE5XWXW/aMBQG4P+SazRWunYbd11Hy6SyVbS7mnZxSA7EwrEz+6QCTfvvUygQx4mP01ve1w/+wAm//iaEO0qmyT0qNEBCq5kx2iSjpATKk2mSSrAW7dgrvMupkMko2QqVJdOLyad/o7O1RFtqZTEgtWLO+QIWF0iQAcFMkdk3llCEZg0p2nGn1SYnV9cOeQtpjg9ii73UOWUJLSWmh40IzsnrDOPiSw10h/HP+/K8TxHdrfJ4UTRzCaBuhccUoaKAcsjY4QaBcKFf8EdZr8H2Q36LI7/qtCpQEbtAv/QWMHzSvc0hdPSU+4ocfIeU5sEbc05ZQkgML/WccsQ90lJrmoPNuePt1jh0jpChscHFOTnHPFY0K6sVN692JYI9ZuuI1TQ4aokbYQkNh3kdnivAbGEl8aYUAcxpDKP4uXktnvxToaVvSlDwPL0Oz72+oxirKXDQU7UiibdmX5IOYn6JA3+WUkMWvk5OzjEeQPsS7bhv1PvPHy+uJu7IHRnoPmKOghvGpPrm148hHzl9HhsfmsTQ7w88htvIoD05/rIWSLnOfKkVxqRn3NGNFBtVtN6Fr1IrjEoGlF1rU3SUUxATVpWQJNSdVvQdCnRu6QsYUV9MO/Y7bfOyh3sQCucoNjlxoNOKkwswG6E47tiIU/UWP6Ug2dU2pQGg1pK16pxh6oMC8n6i60od/qjZsRO3kesPDlKCsf4ruDGalCHM8U3RB5wydvjpYd4PnNIO8fs/EgCls6QMAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 3330178..9369f3e 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":64,\"name\":\"register\",\"url\":\"functions/register.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"formatEntry\",\"url\":\"functions/formatEntry.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"parseEntry\",\"url\":\"functions/parseEntry.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"remarkable\",\"url\":\"functions/remarkable.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"RequestMethod\",\"url\":\"types/RequestMethod.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"TextAlignment\",\"url\":\"types/TextAlignment.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"builtinTools\",\"url\":\"variables/builtinTools.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"builtinFontNames\",\"url\":\"variables/builtinFontNames.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"builtinTextScales\",\"url\":\"variables/builtinTextScales.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/builtinTextScales.html#__type\",\"classes\":\"\",\"parent\":\"builtinTextScales\"},{\"kind\":1024,\"name\":\"xs\",\"url\":\"variables/builtinTextScales.html#__type.xs\",\"classes\":\"\",\"parent\":\"builtinTextScales.__type\"},{\"kind\":1024,\"name\":\"sm\",\"url\":\"variables/builtinTextScales.html#__type.sm\",\"classes\":\"\",\"parent\":\"builtinTextScales.__type\"},{\"kind\":1024,\"name\":\"md\",\"url\":\"variables/builtinTextScales.html#__type.md\",\"classes\":\"\",\"parent\":\"builtinTextScales.__type\"},{\"kind\":1024,\"name\":\"lg\",\"url\":\"variables/builtinTextScales.html#__type.lg\",\"classes\":\"\",\"parent\":\"builtinTextScales.__type\"},{\"kind\":1024,\"name\":\"xl\",\"url\":\"variables/builtinTextScales.html#__type.xl\",\"classes\":\"\",\"parent\":\"builtinTextScales.__type\"},{\"kind\":1024,\"name\":\"xx\",\"url\":\"variables/builtinTextScales.html#__type.xx\",\"classes\":\"\",\"parent\":\"builtinTextScales.__type\"},{\"kind\":32,\"name\":\"builtinMargins\",\"url\":\"variables/builtinMargins.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/builtinMargins.html#__type\",\"classes\":\"\",\"parent\":\"builtinMargins\"},{\"kind\":1024,\"name\":\"sm\",\"url\":\"variables/builtinMargins.html#__type.sm\",\"classes\":\"\",\"parent\":\"builtinMargins.__type\"},{\"kind\":1024,\"name\":\"md\",\"url\":\"variables/builtinMargins.html#__type.md\",\"classes\":\"\",\"parent\":\"builtinMargins.__type\"},{\"kind\":1024,\"name\":\"rr\",\"url\":\"variables/builtinMargins.html#__type.rr\",\"classes\":\"\",\"parent\":\"builtinMargins.__type\"},{\"kind\":1024,\"name\":\"lg\",\"url\":\"variables/builtinMargins.html#__type.lg\",\"classes\":\"\",\"parent\":\"builtinMargins.__type\"},{\"kind\":32,\"name\":\"builtinLineHeights\",\"url\":\"variables/builtinLineHeights.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/builtinLineHeights.html#__type\",\"classes\":\"\",\"parent\":\"builtinLineHeights\"},{\"kind\":1024,\"name\":\"df\",\"url\":\"variables/builtinLineHeights.html#__type.df\",\"classes\":\"\",\"parent\":\"builtinLineHeights.__type\"},{\"kind\":1024,\"name\":\"md\",\"url\":\"variables/builtinLineHeights.html#__type.md\",\"classes\":\"\",\"parent\":\"builtinLineHeights.__type\"},{\"kind\":1024,\"name\":\"lg\",\"url\":\"variables/builtinLineHeights.html#__type.lg\",\"classes\":\"\",\"parent\":\"builtinLineHeights.__type\"},{\"kind\":1024,\"name\":\"xl\",\"url\":\"variables/builtinLineHeights.html#__type.xl\",\"classes\":\"\",\"parent\":\"builtinLineHeights.__type\"},{\"kind\":256,\"name\":\"CollectionEntry\",\"url\":\"interfaces/CollectionEntry.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"interfaces/CollectionEntry.html#type\",\"classes\":\"\",\"parent\":\"CollectionEntry\"},{\"kind\":1024,\"name\":\"hash\",\"url\":\"interfaces/CollectionEntry.html#hash\",\"classes\":\"\",\"parent\":\"CollectionEntry\"},{\"kind\":1024,\"name\":\"documentId\",\"url\":\"interfaces/CollectionEntry.html#documentId\",\"classes\":\"\",\"parent\":\"CollectionEntry\"},{\"kind\":1024,\"name\":\"subfiles\",\"url\":\"interfaces/CollectionEntry.html#subfiles\",\"classes\":\"\",\"parent\":\"CollectionEntry\"},{\"kind\":1024,\"name\":\"size\",\"url\":\"interfaces/CollectionEntry.html#size\",\"classes\":\"\",\"parent\":\"CollectionEntry\"},{\"kind\":256,\"name\":\"FileEntry\",\"url\":\"interfaces/FileEntry.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"interfaces/FileEntry.html#type\",\"classes\":\"\",\"parent\":\"FileEntry\"},{\"kind\":1024,\"name\":\"hash\",\"url\":\"interfaces/FileEntry.html#hash\",\"classes\":\"\",\"parent\":\"FileEntry\"},{\"kind\":1024,\"name\":\"documentId\",\"url\":\"interfaces/FileEntry.html#documentId\",\"classes\":\"\",\"parent\":\"FileEntry\"},{\"kind\":1024,\"name\":\"subfiles\",\"url\":\"interfaces/FileEntry.html#subfiles\",\"classes\":\"\",\"parent\":\"FileEntry\"},{\"kind\":1024,\"name\":\"size\",\"url\":\"interfaces/FileEntry.html#size\",\"classes\":\"\",\"parent\":\"FileEntry\"},{\"kind\":4194304,\"name\":\"Entry\",\"url\":\"types/Entry.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"UploadEntry\",\"url\":\"interfaces/UploadEntry.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"docID\",\"url\":\"interfaces/UploadEntry.html#docID\",\"classes\":\"\",\"parent\":\"UploadEntry\"},{\"kind\":1024,\"name\":\"hash\",\"url\":\"interfaces/UploadEntry.html#hash\",\"classes\":\"\",\"parent\":\"UploadEntry\"},{\"kind\":256,\"name\":\"CommonMetadata\",\"url\":\"interfaces/CommonMetadata.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"visibleName\",\"url\":\"interfaces/CommonMetadata.html#visibleName\",\"classes\":\"\",\"parent\":\"CommonMetadata\"},{\"kind\":1024,\"name\":\"parent\",\"url\":\"interfaces/CommonMetadata.html#parent\",\"classes\":\"\",\"parent\":\"CommonMetadata\"},{\"kind\":1024,\"name\":\"lastModified\",\"url\":\"interfaces/CommonMetadata.html#lastModified\",\"classes\":\"\",\"parent\":\"CommonMetadata\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"interfaces/CommonMetadata.html#version\",\"classes\":\"\",\"parent\":\"CommonMetadata\"},{\"kind\":1024,\"name\":\"pinned\",\"url\":\"interfaces/CommonMetadata.html#pinned\",\"classes\":\"\",\"parent\":\"CommonMetadata\"},{\"kind\":1024,\"name\":\"synced\",\"url\":\"interfaces/CommonMetadata.html#synced\",\"classes\":\"\",\"parent\":\"CommonMetadata\"},{\"kind\":1024,\"name\":\"modified\",\"url\":\"interfaces/CommonMetadata.html#modified\",\"classes\":\"\",\"parent\":\"CommonMetadata\"},{\"kind\":1024,\"name\":\"deleted\",\"url\":\"interfaces/CommonMetadata.html#deleted\",\"classes\":\"\",\"parent\":\"CommonMetadata\"},{\"kind\":1024,\"name\":\"metadatamodified\",\"url\":\"interfaces/CommonMetadata.html#metadatamodified\",\"classes\":\"\",\"parent\":\"CommonMetadata\"},{\"kind\":256,\"name\":\"CollectionTypeMetadata\",\"url\":\"interfaces/CollectionTypeMetadata.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"interfaces/CollectionTypeMetadata.html#type\",\"classes\":\"\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":1024,\"name\":\"visibleName\",\"url\":\"interfaces/CollectionTypeMetadata.html#visibleName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":1024,\"name\":\"parent\",\"url\":\"interfaces/CollectionTypeMetadata.html#parent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":1024,\"name\":\"lastModified\",\"url\":\"interfaces/CollectionTypeMetadata.html#lastModified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"interfaces/CollectionTypeMetadata.html#version\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":1024,\"name\":\"pinned\",\"url\":\"interfaces/CollectionTypeMetadata.html#pinned\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":1024,\"name\":\"synced\",\"url\":\"interfaces/CollectionTypeMetadata.html#synced\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":1024,\"name\":\"modified\",\"url\":\"interfaces/CollectionTypeMetadata.html#modified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":1024,\"name\":\"deleted\",\"url\":\"interfaces/CollectionTypeMetadata.html#deleted\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":1024,\"name\":\"metadatamodified\",\"url\":\"interfaces/CollectionTypeMetadata.html#metadatamodified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionTypeMetadata\"},{\"kind\":256,\"name\":\"DocumentTypeMetadata\",\"url\":\"interfaces/DocumentTypeMetadata.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"interfaces/DocumentTypeMetadata.html#type\",\"classes\":\"\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"lastOpened\",\"url\":\"interfaces/DocumentTypeMetadata.html#lastOpened\",\"classes\":\"\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"lastOpenedPage\",\"url\":\"interfaces/DocumentTypeMetadata.html#lastOpenedPage\",\"classes\":\"\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"visibleName\",\"url\":\"interfaces/DocumentTypeMetadata.html#visibleName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"parent\",\"url\":\"interfaces/DocumentTypeMetadata.html#parent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"lastModified\",\"url\":\"interfaces/DocumentTypeMetadata.html#lastModified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"interfaces/DocumentTypeMetadata.html#version\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"pinned\",\"url\":\"interfaces/DocumentTypeMetadata.html#pinned\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"synced\",\"url\":\"interfaces/DocumentTypeMetadata.html#synced\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"modified\",\"url\":\"interfaces/DocumentTypeMetadata.html#modified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"deleted\",\"url\":\"interfaces/DocumentTypeMetadata.html#deleted\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":1024,\"name\":\"metadatamodified\",\"url\":\"interfaces/DocumentTypeMetadata.html#metadatamodified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentTypeMetadata\"},{\"kind\":4194304,\"name\":\"Metadata\",\"url\":\"types/Metadata.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"BaseMetadataEntry\",\"url\":\"interfaces/BaseMetadataEntry.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/BaseMetadataEntry.html#id\",\"classes\":\"\",\"parent\":\"BaseMetadataEntry\"},{\"kind\":1024,\"name\":\"hash\",\"url\":\"interfaces/BaseMetadataEntry.html#hash\",\"classes\":\"\",\"parent\":\"BaseMetadataEntry\"},{\"kind\":256,\"name\":\"CollectionMetadataEntry\",\"url\":\"interfaces/CollectionMetadataEntry.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/CollectionMetadataEntry.html#id\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"hash\",\"url\":\"interfaces/CollectionMetadataEntry.html#hash\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"interfaces/CollectionMetadataEntry.html#type\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"visibleName\",\"url\":\"interfaces/CollectionMetadataEntry.html#visibleName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"parent\",\"url\":\"interfaces/CollectionMetadataEntry.html#parent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"lastModified\",\"url\":\"interfaces/CollectionMetadataEntry.html#lastModified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"interfaces/CollectionMetadataEntry.html#version\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"pinned\",\"url\":\"interfaces/CollectionMetadataEntry.html#pinned\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"synced\",\"url\":\"interfaces/CollectionMetadataEntry.html#synced\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"modified\",\"url\":\"interfaces/CollectionMetadataEntry.html#modified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"deleted\",\"url\":\"interfaces/CollectionMetadataEntry.html#deleted\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":1024,\"name\":\"metadatamodified\",\"url\":\"interfaces/CollectionMetadataEntry.html#metadatamodified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"CollectionMetadataEntry\"},{\"kind\":256,\"name\":\"DocumentMetadataEntry\",\"url\":\"interfaces/DocumentMetadataEntry.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"fileType\",\"url\":\"interfaces/DocumentMetadataEntry.html#fileType\",\"classes\":\"\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/DocumentMetadataEntry.html#id\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"hash\",\"url\":\"interfaces/DocumentMetadataEntry.html#hash\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"interfaces/DocumentMetadataEntry.html#type\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"lastOpened\",\"url\":\"interfaces/DocumentMetadataEntry.html#lastOpened\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"lastOpenedPage\",\"url\":\"interfaces/DocumentMetadataEntry.html#lastOpenedPage\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"visibleName\",\"url\":\"interfaces/DocumentMetadataEntry.html#visibleName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"parent\",\"url\":\"interfaces/DocumentMetadataEntry.html#parent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"lastModified\",\"url\":\"interfaces/DocumentMetadataEntry.html#lastModified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"interfaces/DocumentMetadataEntry.html#version\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"pinned\",\"url\":\"interfaces/DocumentMetadataEntry.html#pinned\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"synced\",\"url\":\"interfaces/DocumentMetadataEntry.html#synced\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"modified\",\"url\":\"interfaces/DocumentMetadataEntry.html#modified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"deleted\",\"url\":\"interfaces/DocumentMetadataEntry.html#deleted\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":1024,\"name\":\"metadatamodified\",\"url\":\"interfaces/DocumentMetadataEntry.html#metadatamodified\",\"classes\":\"tsd-is-inherited\",\"parent\":\"DocumentMetadataEntry\"},{\"kind\":4194304,\"name\":\"MetadataEntry\",\"url\":\"types/MetadataEntry.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"ExtraMetadata\",\"url\":\"types/ExtraMetadata.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"FileType\",\"url\":\"types/FileType.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"Transform\",\"url\":\"types/Transform.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"DocumentMetadata\",\"url\":\"interfaces/DocumentMetadata.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"interfaces/DocumentMetadata.html#title\",\"classes\":\"\",\"parent\":\"DocumentMetadata\"},{\"kind\":1024,\"name\":\"authors\",\"url\":\"interfaces/DocumentMetadata.html#authors\",\"classes\":\"\",\"parent\":\"DocumentMetadata\"},{\"kind\":256,\"name\":\"Content\",\"url\":\"interfaces/Content.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"dummyDocument\",\"url\":\"interfaces/Content.html#dummyDocument\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"documentMetadata\",\"url\":\"interfaces/Content.html#documentMetadata\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"extraMetadata\",\"url\":\"interfaces/Content.html#extraMetadata\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"fileType\",\"url\":\"interfaces/Content.html#fileType\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"fontName\",\"url\":\"interfaces/Content.html#fontName\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"lastOpenedPage\",\"url\":\"interfaces/Content.html#lastOpenedPage\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"lineHeight\",\"url\":\"interfaces/Content.html#lineHeight\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"margins\",\"url\":\"interfaces/Content.html#margins\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"orientation\",\"url\":\"interfaces/Content.html#orientation\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"pageCount\",\"url\":\"interfaces/Content.html#pageCount\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"pages\",\"url\":\"interfaces/Content.html#pages\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"coverPageNumber\",\"url\":\"interfaces/Content.html#coverPageNumber\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"textScale\",\"url\":\"interfaces/Content.html#textScale\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"transform\",\"url\":\"interfaces/Content.html#transform\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"formatVersion\",\"url\":\"interfaces/Content.html#formatVersion\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":1024,\"name\":\"textAlignment\",\"url\":\"interfaces/Content.html#textAlignment\",\"classes\":\"\",\"parent\":\"Content\"},{\"kind\":256,\"name\":\"RequestInitLike\",\"url\":\"interfaces/RequestInitLike.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"method\",\"url\":\"interfaces/RequestInitLike.html#method\",\"classes\":\"\",\"parent\":\"RequestInitLike\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"interfaces/RequestInitLike.html#headers\",\"classes\":\"\",\"parent\":\"RequestInitLike\"},{\"kind\":1024,\"name\":\"body\",\"url\":\"interfaces/RequestInitLike.html#body\",\"classes\":\"\",\"parent\":\"RequestInitLike\"},{\"kind\":256,\"name\":\"HeadersLike\",\"url\":\"interfaces/HeadersLike.html\",\"classes\":\"\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"interfaces/HeadersLike.html#get\",\"classes\":\"\",\"parent\":\"HeadersLike\"},{\"kind\":256,\"name\":\"ResponseLike\",\"url\":\"interfaces/ResponseLike.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"ok\",\"url\":\"interfaces/ResponseLike.html#ok\",\"classes\":\"\",\"parent\":\"ResponseLike\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"interfaces/ResponseLike.html#status\",\"classes\":\"\",\"parent\":\"ResponseLike\"},{\"kind\":1024,\"name\":\"statusText\",\"url\":\"interfaces/ResponseLike.html#statusText\",\"classes\":\"\",\"parent\":\"ResponseLike\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"interfaces/ResponseLike.html#headers\",\"classes\":\"\",\"parent\":\"ResponseLike\"},{\"kind\":2048,\"name\":\"text\",\"url\":\"interfaces/ResponseLike.html#text\",\"classes\":\"\",\"parent\":\"ResponseLike\"},{\"kind\":2048,\"name\":\"arrayBuffer\",\"url\":\"interfaces/ResponseLike.html#arrayBuffer\",\"classes\":\"\",\"parent\":\"ResponseLike\"},{\"kind\":256,\"name\":\"FetchLike\",\"url\":\"interfaces/FetchLike.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"CacheLike\",\"url\":\"interfaces/CacheLike.html\",\"classes\":\"\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"interfaces/CacheLike.html#get\",\"classes\":\"\",\"parent\":\"CacheLike\"},{\"kind\":2048,\"name\":\"set\",\"url\":\"interfaces/CacheLike.html#set\",\"classes\":\"\",\"parent\":\"CacheLike\"},{\"kind\":256,\"name\":\"SubtleCryptoLike\",\"url\":\"interfaces/SubtleCryptoLike.html\",\"classes\":\"\"},{\"kind\":2048,\"name\":\"digest\",\"url\":\"interfaces/SubtleCryptoLike.html#digest\",\"classes\":\"\",\"parent\":\"SubtleCryptoLike\"},{\"kind\":128,\"name\":\"ResponseError\",\"url\":\"classes/ResponseError.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/ResponseError.html#constructor\",\"classes\":\"\",\"parent\":\"ResponseError\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"classes/ResponseError.html#status\",\"classes\":\"\",\"parent\":\"ResponseError\"},{\"kind\":1024,\"name\":\"statusText\",\"url\":\"classes/ResponseError.html#statusText\",\"classes\":\"\",\"parent\":\"ResponseError\"},{\"kind\":128,\"name\":\"GenerationError\",\"url\":\"classes/GenerationError.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/GenerationError.html#constructor\",\"classes\":\"\",\"parent\":\"GenerationError\"},{\"kind\":256,\"name\":\"RegisterOptions\",\"url\":\"interfaces/RegisterOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"deviceDesc\",\"url\":\"interfaces/RegisterOptions.html#deviceDesc\",\"classes\":\"\",\"parent\":\"RegisterOptions\"},{\"kind\":1024,\"name\":\"uuid\",\"url\":\"interfaces/RegisterOptions.html#uuid\",\"classes\":\"\",\"parent\":\"RegisterOptions\"},{\"kind\":1024,\"name\":\"authHost\",\"url\":\"interfaces/RegisterOptions.html#authHost\",\"classes\":\"\",\"parent\":\"RegisterOptions\"},{\"kind\":1024,\"name\":\"fetch\",\"url\":\"interfaces/RegisterOptions.html#fetch\",\"classes\":\"\",\"parent\":\"RegisterOptions\"},{\"kind\":256,\"name\":\"PutEpubOptions\",\"url\":\"interfaces/PutEpubOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"parent\",\"url\":\"interfaces/PutEpubOptions.html#parent\",\"classes\":\"\",\"parent\":\"PutEpubOptions\"},{\"kind\":1024,\"name\":\"margins\",\"url\":\"interfaces/PutEpubOptions.html#margins\",\"classes\":\"\",\"parent\":\"PutEpubOptions\"},{\"kind\":1024,\"name\":\"lineHeight\",\"url\":\"interfaces/PutEpubOptions.html#lineHeight\",\"classes\":\"\",\"parent\":\"PutEpubOptions\"},{\"kind\":1024,\"name\":\"textScale\",\"url\":\"interfaces/PutEpubOptions.html#textScale\",\"classes\":\"\",\"parent\":\"PutEpubOptions\"},{\"kind\":1024,\"name\":\"orientation\",\"url\":\"interfaces/PutEpubOptions.html#orientation\",\"classes\":\"\",\"parent\":\"PutEpubOptions\"},{\"kind\":1024,\"name\":\"textAlignment\",\"url\":\"interfaces/PutEpubOptions.html#textAlignment\",\"classes\":\"\",\"parent\":\"PutEpubOptions\"},{\"kind\":1024,\"name\":\"cover\",\"url\":\"interfaces/PutEpubOptions.html#cover\",\"classes\":\"\",\"parent\":\"PutEpubOptions\"},{\"kind\":1024,\"name\":\"fontName\",\"url\":\"interfaces/PutEpubOptions.html#fontName\",\"classes\":\"\",\"parent\":\"PutEpubOptions\"},{\"kind\":1024,\"name\":\"lastTool\",\"url\":\"interfaces/PutEpubOptions.html#lastTool\",\"classes\":\"\",\"parent\":\"PutEpubOptions\"},{\"kind\":256,\"name\":\"GetRootHashOptions\",\"url\":\"interfaces/GetRootHashOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"interfaces/GetRootHashOptions.html#cache\",\"classes\":\"\",\"parent\":\"GetRootHashOptions\"},{\"kind\":256,\"name\":\"CreateMoveOptions\",\"url\":\"interfaces/CreateMoveOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"interfaces/CreateMoveOptions.html#cache\",\"classes\":\"\",\"parent\":\"CreateMoveOptions\"},{\"kind\":1024,\"name\":\"sync\",\"url\":\"interfaces/CreateMoveOptions.html#sync\",\"classes\":\"\",\"parent\":\"CreateMoveOptions\"},{\"kind\":256,\"name\":\"PutPdfOptions\",\"url\":\"interfaces/PutPdfOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"parent\",\"url\":\"interfaces/PutPdfOptions.html#parent\",\"classes\":\"\",\"parent\":\"PutPdfOptions\"},{\"kind\":1024,\"name\":\"orientation\",\"url\":\"interfaces/PutPdfOptions.html#orientation\",\"classes\":\"\",\"parent\":\"PutPdfOptions\"},{\"kind\":1024,\"name\":\"cover\",\"url\":\"interfaces/PutPdfOptions.html#cover\",\"classes\":\"\",\"parent\":\"PutPdfOptions\"},{\"kind\":1024,\"name\":\"lastTool\",\"url\":\"interfaces/PutPdfOptions.html#lastTool\",\"classes\":\"\",\"parent\":\"PutPdfOptions\"},{\"kind\":256,\"name\":\"RemarkableApi\",\"url\":\"interfaces/RemarkableApi.html\",\"classes\":\"\"},{\"kind\":2048,\"name\":\"getRootHash\",\"url\":\"interfaces/RemarkableApi.html#getRootHash\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"putRootHash\",\"url\":\"interfaces/RemarkableApi.html#putRootHash\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"getBuffer\",\"url\":\"interfaces/RemarkableApi.html#getBuffer\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"getText\",\"url\":\"interfaces/RemarkableApi.html#getText\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"getJson\",\"url\":\"interfaces/RemarkableApi.html#getJson\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"getMetadata\",\"url\":\"interfaces/RemarkableApi.html#getMetadata\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"getEntries\",\"url\":\"interfaces/RemarkableApi.html#getEntries\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"putEntries\",\"url\":\"interfaces/RemarkableApi.html#putEntries\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"putBuffer\",\"url\":\"interfaces/RemarkableApi.html#putBuffer\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"putText\",\"url\":\"interfaces/RemarkableApi.html#putText\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"putJson\",\"url\":\"interfaces/RemarkableApi.html#putJson\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"putMetadata\",\"url\":\"interfaces/RemarkableApi.html#putMetadata\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"putCollection\",\"url\":\"interfaces/RemarkableApi.html#putCollection\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"putEpub\",\"url\":\"interfaces/RemarkableApi.html#putEpub\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"putPdf\",\"url\":\"interfaces/RemarkableApi.html#putPdf\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"syncComplete\",\"url\":\"interfaces/RemarkableApi.html#syncComplete\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"interfaces/RemarkableApi.html#create\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"move\",\"url\":\"interfaces/RemarkableApi.html#move\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"getEntriesMetadata\",\"url\":\"interfaces/RemarkableApi.html#getEntriesMetadata\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"uploadEpub\",\"url\":\"interfaces/RemarkableApi.html#uploadEpub\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"uploadPdf\",\"url\":\"interfaces/RemarkableApi.html#uploadPdf\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":2048,\"name\":\"getCache\",\"url\":\"interfaces/RemarkableApi.html#getCache\",\"classes\":\"\",\"parent\":\"RemarkableApi\"},{\"kind\":256,\"name\":\"RemarkableOptions\",\"url\":\"interfaces/RemarkableOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"fetch\",\"url\":\"interfaces/RemarkableOptions.html#fetch\",\"classes\":\"\",\"parent\":\"RemarkableOptions\"},{\"kind\":1024,\"name\":\"subtle\",\"url\":\"interfaces/RemarkableOptions.html#subtle\",\"classes\":\"\",\"parent\":\"RemarkableOptions\"},{\"kind\":1024,\"name\":\"authHost\",\"url\":\"interfaces/RemarkableOptions.html#authHost\",\"classes\":\"\",\"parent\":\"RemarkableOptions\"},{\"kind\":1024,\"name\":\"syncHost\",\"url\":\"interfaces/RemarkableOptions.html#syncHost\",\"classes\":\"\",\"parent\":\"RemarkableOptions\"},{\"kind\":1024,\"name\":\"cacheLimitBytes\",\"url\":\"interfaces/RemarkableOptions.html#cacheLimitBytes\",\"classes\":\"\",\"parent\":\"RemarkableOptions\"},{\"kind\":1024,\"name\":\"initCache\",\"url\":\"interfaces/RemarkableOptions.html#initCache\",\"classes\":\"\",\"parent\":\"RemarkableOptions\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,49.698]],[\"comment/0\",[]],[\"name/1\",[1,49.698]],[\"comment/1\",[]],[\"name/2\",[2,49.698]],[\"comment/2\",[]],[\"name/3\",[3,49.698]],[\"comment/3\",[]],[\"name/4\",[4,49.698]],[\"comment/4\",[]],[\"name/5\",[5,41.225]],[\"comment/5\",[]],[\"name/6\",[6,49.698]],[\"comment/6\",[]],[\"name/7\",[7,49.698]],[\"comment/7\",[]],[\"name/8\",[8,49.698]],[\"comment/8\",[]],[\"name/9\",[9,41.225]],[\"comment/9\",[]],[\"name/10\",[10,49.698]],[\"comment/10\",[]],[\"name/11\",[11,44.59]],[\"comment/11\",[]],[\"name/12\",[12,41.225]],[\"comment/12\",[]],[\"name/13\",[13,41.225]],[\"comment/13\",[]],[\"name/14\",[14,44.59]],[\"comment/14\",[]],[\"name/15\",[15,49.698]],[\"comment/15\",[]],[\"name/16\",[16,49.698]],[\"comment/16\",[]],[\"name/17\",[9,41.225]],[\"comment/17\",[]],[\"name/18\",[11,44.59]],[\"comment/18\",[]],[\"name/19\",[12,41.225]],[\"comment/19\",[]],[\"name/20\",[17,49.698]],[\"comment/20\",[]],[\"name/21\",[13,41.225]],[\"comment/21\",[]],[\"name/22\",[18,49.698]],[\"comment/22\",[]],[\"name/23\",[9,41.225]],[\"comment/23\",[]],[\"name/24\",[19,49.698]],[\"comment/24\",[]],[\"name/25\",[12,41.225]],[\"comment/25\",[]],[\"name/26\",[13,41.225]],[\"comment/26\",[]],[\"name/27\",[14,44.59]],[\"comment/27\",[]],[\"name/28\",[20,49.698]],[\"comment/28\",[]],[\"name/29\",[21,35.035]],[\"comment/29\",[]],[\"name/30\",[22,35.035]],[\"comment/30\",[]],[\"name/31\",[23,44.59]],[\"comment/31\",[]],[\"name/32\",[24,44.59]],[\"comment/32\",[]],[\"name/33\",[25,44.59]],[\"comment/33\",[]],[\"name/34\",[26,49.698]],[\"comment/34\",[]],[\"name/35\",[21,35.035]],[\"comment/35\",[]],[\"name/36\",[22,35.035]],[\"comment/36\",[]],[\"name/37\",[23,44.59]],[\"comment/37\",[]],[\"name/38\",[24,44.59]],[\"comment/38\",[]],[\"name/39\",[25,44.59]],[\"comment/39\",[]],[\"name/40\",[27,49.698]],[\"comment/40\",[]],[\"name/41\",[28,49.698]],[\"comment/41\",[]],[\"name/42\",[29,49.698]],[\"comment/42\",[]],[\"name/43\",[22,35.035]],[\"comment/43\",[]],[\"name/44\",[30,49.698]],[\"comment/44\",[]],[\"name/45\",[31,36.705]],[\"comment/45\",[]],[\"name/46\",[32,33.604]],[\"comment/46\",[]],[\"name/47\",[33,36.705]],[\"comment/47\",[]],[\"name/48\",[34,36.705]],[\"comment/48\",[]],[\"name/49\",[35,36.705]],[\"comment/49\",[]],[\"name/50\",[36,36.705]],[\"comment/50\",[]],[\"name/51\",[37,36.705]],[\"comment/51\",[]],[\"name/52\",[38,36.705]],[\"comment/52\",[]],[\"name/53\",[39,36.705]],[\"comment/53\",[]],[\"name/54\",[40,49.698]],[\"comment/54\",[]],[\"name/55\",[21,35.035]],[\"comment/55\",[]],[\"name/56\",[31,36.705]],[\"comment/56\",[]],[\"name/57\",[32,33.604]],[\"comment/57\",[]],[\"name/58\",[33,36.705]],[\"comment/58\",[]],[\"name/59\",[34,36.705]],[\"comment/59\",[]],[\"name/60\",[35,36.705]],[\"comment/60\",[]],[\"name/61\",[36,36.705]],[\"comment/61\",[]],[\"name/62\",[37,36.705]],[\"comment/62\",[]],[\"name/63\",[38,36.705]],[\"comment/63\",[]],[\"name/64\",[39,36.705]],[\"comment/64\",[]],[\"name/65\",[41,49.698]],[\"comment/65\",[]],[\"name/66\",[21,35.035]],[\"comment/66\",[]],[\"name/67\",[42,44.59]],[\"comment/67\",[]],[\"name/68\",[43,41.225]],[\"comment/68\",[]],[\"name/69\",[31,36.705]],[\"comment/69\",[]],[\"name/70\",[32,33.604]],[\"comment/70\",[]],[\"name/71\",[33,36.705]],[\"comment/71\",[]],[\"name/72\",[34,36.705]],[\"comment/72\",[]],[\"name/73\",[35,36.705]],[\"comment/73\",[]],[\"name/74\",[36,36.705]],[\"comment/74\",[]],[\"name/75\",[37,36.705]],[\"comment/75\",[]],[\"name/76\",[38,36.705]],[\"comment/76\",[]],[\"name/77\",[39,36.705]],[\"comment/77\",[]],[\"name/78\",[44,49.698]],[\"comment/78\",[]],[\"name/79\",[45,49.698]],[\"comment/79\",[]],[\"name/80\",[46,41.225]],[\"comment/80\",[]],[\"name/81\",[22,35.035]],[\"comment/81\",[]],[\"name/82\",[47,49.698]],[\"comment/82\",[]],[\"name/83\",[46,41.225]],[\"comment/83\",[]],[\"name/84\",[22,35.035]],[\"comment/84\",[]],[\"name/85\",[21,35.035]],[\"comment/85\",[]],[\"name/86\",[31,36.705]],[\"comment/86\",[]],[\"name/87\",[32,33.604]],[\"comment/87\",[]],[\"name/88\",[33,36.705]],[\"comment/88\",[]],[\"name/89\",[34,36.705]],[\"comment/89\",[]],[\"name/90\",[35,36.705]],[\"comment/90\",[]],[\"name/91\",[36,36.705]],[\"comment/91\",[]],[\"name/92\",[37,36.705]],[\"comment/92\",[]],[\"name/93\",[38,36.705]],[\"comment/93\",[]],[\"name/94\",[39,36.705]],[\"comment/94\",[]],[\"name/95\",[48,49.698]],[\"comment/95\",[]],[\"name/96\",[49,41.225]],[\"comment/96\",[]],[\"name/97\",[46,41.225]],[\"comment/97\",[]],[\"name/98\",[22,35.035]],[\"comment/98\",[]],[\"name/99\",[21,35.035]],[\"comment/99\",[]],[\"name/100\",[42,44.59]],[\"comment/100\",[]],[\"name/101\",[43,41.225]],[\"comment/101\",[]],[\"name/102\",[31,36.705]],[\"comment/102\",[]],[\"name/103\",[32,33.604]],[\"comment/103\",[]],[\"name/104\",[33,36.705]],[\"comment/104\",[]],[\"name/105\",[34,36.705]],[\"comment/105\",[]],[\"name/106\",[35,36.705]],[\"comment/106\",[]],[\"name/107\",[36,36.705]],[\"comment/107\",[]],[\"name/108\",[37,36.705]],[\"comment/108\",[]],[\"name/109\",[38,36.705]],[\"comment/109\",[]],[\"name/110\",[39,36.705]],[\"comment/110\",[]],[\"name/111\",[50,49.698]],[\"comment/111\",[]],[\"name/112\",[51,44.59]],[\"comment/112\",[]],[\"name/113\",[49,41.225]],[\"comment/113\",[]],[\"name/114\",[52,44.59]],[\"comment/114\",[]],[\"name/115\",[53,44.59]],[\"comment/115\",[]],[\"name/116\",[54,49.698]],[\"comment/116\",[]],[\"name/117\",[55,49.698]],[\"comment/117\",[]],[\"name/118\",[56,49.698]],[\"comment/118\",[]],[\"name/119\",[57,49.698]],[\"comment/119\",[]],[\"name/120\",[53,44.59]],[\"comment/120\",[]],[\"name/121\",[51,44.59]],[\"comment/121\",[]],[\"name/122\",[49,41.225]],[\"comment/122\",[]],[\"name/123\",[58,44.59]],[\"comment/123\",[]],[\"name/124\",[43,41.225]],[\"comment/124\",[]],[\"name/125\",[59,44.59]],[\"comment/125\",[]],[\"name/126\",[60,44.59]],[\"comment/126\",[]],[\"name/127\",[61,41.225]],[\"comment/127\",[]],[\"name/128\",[62,49.698]],[\"comment/128\",[]],[\"name/129\",[63,49.698]],[\"comment/129\",[]],[\"name/130\",[64,49.698]],[\"comment/130\",[]],[\"name/131\",[65,44.59]],[\"comment/131\",[]],[\"name/132\",[52,44.59]],[\"comment/132\",[]],[\"name/133\",[66,49.698]],[\"comment/133\",[]],[\"name/134\",[5,41.225]],[\"comment/134\",[]],[\"name/135\",[67,49.698]],[\"comment/135\",[]],[\"name/136\",[68,49.698]],[\"comment/136\",[]],[\"name/137\",[69,44.59]],[\"comment/137\",[]],[\"name/138\",[70,49.698]],[\"comment/138\",[]],[\"name/139\",[71,49.698]],[\"comment/139\",[]],[\"name/140\",[72,44.59]],[\"comment/140\",[]],[\"name/141\",[73,49.698]],[\"comment/141\",[]],[\"name/142\",[74,49.698]],[\"comment/142\",[]],[\"name/143\",[75,44.59]],[\"comment/143\",[]],[\"name/144\",[76,44.59]],[\"comment/144\",[]],[\"name/145\",[69,44.59]],[\"comment/145\",[]],[\"name/146\",[77,49.698]],[\"comment/146\",[]],[\"name/147\",[78,49.698]],[\"comment/147\",[]],[\"name/148\",[79,49.698]],[\"comment/148\",[]],[\"name/149\",[80,49.698]],[\"comment/149\",[]],[\"name/150\",[72,44.59]],[\"comment/150\",[]],[\"name/151\",[81,49.698]],[\"comment/151\",[]],[\"name/152\",[82,49.698]],[\"comment/152\",[]],[\"name/153\",[83,49.698]],[\"comment/153\",[]],[\"name/154\",[84,49.698]],[\"comment/154\",[]],[\"name/155\",[85,44.59]],[\"comment/155\",[]],[\"name/156\",[75,44.59]],[\"comment/156\",[]],[\"name/157\",[76,44.59]],[\"comment/157\",[]],[\"name/158\",[86,49.698]],[\"comment/158\",[]],[\"name/159\",[85,44.59]],[\"comment/159\",[]],[\"name/160\",[87,49.698]],[\"comment/160\",[]],[\"name/161\",[88,49.698]],[\"comment/161\",[]],[\"name/162\",[89,49.698]],[\"comment/162\",[]],[\"name/163\",[90,44.59]],[\"comment/163\",[]],[\"name/164\",[91,44.59]],[\"comment/164\",[]],[\"name/165\",[92,49.698]],[\"comment/165\",[]],[\"name/166\",[32,33.604]],[\"comment/166\",[]],[\"name/167\",[60,44.59]],[\"comment/167\",[]],[\"name/168\",[59,44.59]],[\"comment/168\",[]],[\"name/169\",[65,44.59]],[\"comment/169\",[]],[\"name/170\",[61,41.225]],[\"comment/170\",[]],[\"name/171\",[5,41.225]],[\"comment/171\",[]],[\"name/172\",[93,44.59]],[\"comment/172\",[]],[\"name/173\",[58,44.59]],[\"comment/173\",[]],[\"name/174\",[94,44.59]],[\"comment/174\",[]],[\"name/175\",[95,49.698]],[\"comment/175\",[]],[\"name/176\",[96,44.59]],[\"comment/176\",[]],[\"name/177\",[97,49.698]],[\"comment/177\",[]],[\"name/178\",[96,44.59]],[\"comment/178\",[]],[\"name/179\",[98,49.698]],[\"comment/179\",[]],[\"name/180\",[99,49.698]],[\"comment/180\",[]],[\"name/181\",[32,33.604]],[\"comment/181\",[]],[\"name/182\",[61,41.225]],[\"comment/182\",[]],[\"name/183\",[93,44.59]],[\"comment/183\",[]],[\"name/184\",[94,44.59]],[\"comment/184\",[]],[\"name/185\",[100,49.698]],[\"comment/185\",[]],[\"name/186\",[101,49.698]],[\"comment/186\",[]],[\"name/187\",[102,49.698]],[\"comment/187\",[]],[\"name/188\",[103,49.698]],[\"comment/188\",[]],[\"name/189\",[104,49.698]],[\"comment/189\",[]],[\"name/190\",[105,49.698]],[\"comment/190\",[]],[\"name/191\",[106,49.698]],[\"comment/191\",[]],[\"name/192\",[107,49.698]],[\"comment/192\",[]],[\"name/193\",[108,49.698]],[\"comment/193\",[]],[\"name/194\",[109,49.698]],[\"comment/194\",[]],[\"name/195\",[110,49.698]],[\"comment/195\",[]],[\"name/196\",[111,49.698]],[\"comment/196\",[]],[\"name/197\",[112,49.698]],[\"comment/197\",[]],[\"name/198\",[113,49.698]],[\"comment/198\",[]],[\"name/199\",[114,49.698]],[\"comment/199\",[]],[\"name/200\",[115,49.698]],[\"comment/200\",[]],[\"name/201\",[116,49.698]],[\"comment/201\",[]],[\"name/202\",[117,49.698]],[\"comment/202\",[]],[\"name/203\",[118,49.698]],[\"comment/203\",[]],[\"name/204\",[119,49.698]],[\"comment/204\",[]],[\"name/205\",[120,49.698]],[\"comment/205\",[]],[\"name/206\",[121,49.698]],[\"comment/206\",[]],[\"name/207\",[122,49.698]],[\"comment/207\",[]],[\"name/208\",[123,49.698]],[\"comment/208\",[]],[\"name/209\",[91,44.59]],[\"comment/209\",[]],[\"name/210\",[124,49.698]],[\"comment/210\",[]],[\"name/211\",[90,44.59]],[\"comment/211\",[]],[\"name/212\",[125,49.698]],[\"comment/212\",[]],[\"name/213\",[126,49.698]],[\"comment/213\",[]],[\"name/214\",[127,49.698]],[\"comment/214\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":9,\"name\":{\"9\":{},\"17\":{},\"23\":{}},\"comment\":{}}],[\"arraybuffer\",{\"_index\":78,\"name\":{\"147\":{}},\"comment\":{}}],[\"authhost\",{\"_index\":90,\"name\":{\"163\":{},\"211\":{}},\"comment\":{}}],[\"authors\",{\"_index\":55,\"name\":{\"117\":{}},\"comment\":{}}],[\"basemetadataentry\",{\"_index\":45,\"name\":{\"79\":{}},\"comment\":{}}],[\"body\",{\"_index\":70,\"name\":{\"138\":{}},\"comment\":{}}],[\"builtinfontnames\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"builtinlineheights\",{\"_index\":18,\"name\":{\"22\":{}},\"comment\":{}}],[\"builtinmargins\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"builtintextscales\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"builtintools\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"cache\",{\"_index\":96,\"name\":{\"176\":{},\"178\":{}},\"comment\":{}}],[\"cachelike\",{\"_index\":80,\"name\":{\"149\":{}},\"comment\":{}}],[\"cachelimitbytes\",{\"_index\":126,\"name\":{\"213\":{}},\"comment\":{}}],[\"collectionentry\",{\"_index\":20,\"name\":{\"28\":{}},\"comment\":{}}],[\"collectionmetadataentry\",{\"_index\":47,\"name\":{\"82\":{}},\"comment\":{}}],[\"collectiontypemetadata\",{\"_index\":40,\"name\":{\"54\":{}},\"comment\":{}}],[\"commonmetadata\",{\"_index\":30,\"name\":{\"44\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":85,\"name\":{\"155\":{},\"159\":{}},\"comment\":{}}],[\"content\",{\"_index\":56,\"name\":{\"118\":{}},\"comment\":{}}],[\"cover\",{\"_index\":93,\"name\":{\"172\":{},\"183\":{}},\"comment\":{}}],[\"coverpagenumber\",{\"_index\":64,\"name\":{\"130\":{}},\"comment\":{}}],[\"create\",{\"_index\":117,\"name\":{\"202\":{}},\"comment\":{}}],[\"createmoveoptions\",{\"_index\":97,\"name\":{\"177\":{}},\"comment\":{}}],[\"deleted\",{\"_index\":38,\"name\":{\"52\":{},\"63\":{},\"76\":{},\"93\":{},\"109\":{}},\"comment\":{}}],[\"devicedesc\",{\"_index\":88,\"name\":{\"161\":{}},\"comment\":{}}],[\"df\",{\"_index\":19,\"name\":{\"24\":{}},\"comment\":{}}],[\"digest\",{\"_index\":83,\"name\":{\"153\":{}},\"comment\":{}}],[\"docid\",{\"_index\":29,\"name\":{\"42\":{}},\"comment\":{}}],[\"documentid\",{\"_index\":23,\"name\":{\"31\":{},\"37\":{}},\"comment\":{}}],[\"documentmetadata\",{\"_index\":53,\"name\":{\"115\":{},\"120\":{}},\"comment\":{}}],[\"documentmetadataentry\",{\"_index\":48,\"name\":{\"95\":{}},\"comment\":{}}],[\"documenttypemetadata\",{\"_index\":41,\"name\":{\"65\":{}},\"comment\":{}}],[\"dummydocument\",{\"_index\":57,\"name\":{\"119\":{}},\"comment\":{}}],[\"entry\",{\"_index\":27,\"name\":{\"40\":{}},\"comment\":{}}],[\"extrametadata\",{\"_index\":51,\"name\":{\"112\":{},\"121\":{}},\"comment\":{}}],[\"fetch\",{\"_index\":91,\"name\":{\"164\":{},\"209\":{}},\"comment\":{}}],[\"fetchlike\",{\"_index\":79,\"name\":{\"148\":{}},\"comment\":{}}],[\"fileentry\",{\"_index\":26,\"name\":{\"34\":{}},\"comment\":{}}],[\"filetype\",{\"_index\":49,\"name\":{\"96\":{},\"113\":{},\"122\":{}},\"comment\":{}}],[\"fontname\",{\"_index\":58,\"name\":{\"123\":{},\"173\":{}},\"comment\":{}}],[\"formatentry\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"formatversion\",{\"_index\":66,\"name\":{\"133\":{}},\"comment\":{}}],[\"generationerror\",{\"_index\":86,\"name\":{\"158\":{}},\"comment\":{}}],[\"get\",{\"_index\":72,\"name\":{\"140\":{},\"150\":{}},\"comment\":{}}],[\"getbuffer\",{\"_index\":103,\"name\":{\"188\":{}},\"comment\":{}}],[\"getcache\",{\"_index\":122,\"name\":{\"207\":{}},\"comment\":{}}],[\"getentries\",{\"_index\":107,\"name\":{\"192\":{}},\"comment\":{}}],[\"getentriesmetadata\",{\"_index\":119,\"name\":{\"204\":{}},\"comment\":{}}],[\"getjson\",{\"_index\":105,\"name\":{\"190\":{}},\"comment\":{}}],[\"getmetadata\",{\"_index\":106,\"name\":{\"191\":{}},\"comment\":{}}],[\"getroothash\",{\"_index\":101,\"name\":{\"186\":{}},\"comment\":{}}],[\"getroothashoptions\",{\"_index\":95,\"name\":{\"175\":{}},\"comment\":{}}],[\"gettext\",{\"_index\":104,\"name\":{\"189\":{}},\"comment\":{}}],[\"hash\",{\"_index\":22,\"name\":{\"30\":{},\"36\":{},\"43\":{},\"81\":{},\"84\":{},\"98\":{}},\"comment\":{}}],[\"headers\",{\"_index\":69,\"name\":{\"137\":{},\"145\":{}},\"comment\":{}}],[\"headerslike\",{\"_index\":71,\"name\":{\"139\":{}},\"comment\":{}}],[\"id\",{\"_index\":46,\"name\":{\"80\":{},\"83\":{},\"97\":{}},\"comment\":{}}],[\"initcache\",{\"_index\":127,\"name\":{\"214\":{}},\"comment\":{}}],[\"lastmodified\",{\"_index\":33,\"name\":{\"47\":{},\"58\":{},\"71\":{},\"88\":{},\"104\":{}},\"comment\":{}}],[\"lastopened\",{\"_index\":42,\"name\":{\"67\":{},\"100\":{}},\"comment\":{}}],[\"lastopenedpage\",{\"_index\":43,\"name\":{\"68\":{},\"101\":{},\"124\":{}},\"comment\":{}}],[\"lasttool\",{\"_index\":94,\"name\":{\"174\":{},\"184\":{}},\"comment\":{}}],[\"lg\",{\"_index\":13,\"name\":{\"13\":{},\"21\":{},\"26\":{}},\"comment\":{}}],[\"lineheight\",{\"_index\":59,\"name\":{\"125\":{},\"168\":{}},\"comment\":{}}],[\"margins\",{\"_index\":60,\"name\":{\"126\":{},\"167\":{}},\"comment\":{}}],[\"md\",{\"_index\":12,\"name\":{\"12\":{},\"19\":{},\"25\":{}},\"comment\":{}}],[\"metadata\",{\"_index\":44,\"name\":{\"78\":{}},\"comment\":{}}],[\"metadataentry\",{\"_index\":50,\"name\":{\"111\":{}},\"comment\":{}}],[\"metadatamodified\",{\"_index\":39,\"name\":{\"53\":{},\"64\":{},\"77\":{},\"94\":{},\"110\":{}},\"comment\":{}}],[\"method\",{\"_index\":68,\"name\":{\"136\":{}},\"comment\":{}}],[\"modified\",{\"_index\":37,\"name\":{\"51\":{},\"62\":{},\"75\":{},\"92\":{},\"108\":{}},\"comment\":{}}],[\"move\",{\"_index\":118,\"name\":{\"203\":{}},\"comment\":{}}],[\"ok\",{\"_index\":74,\"name\":{\"142\":{}},\"comment\":{}}],[\"orientation\",{\"_index\":61,\"name\":{\"127\":{},\"170\":{},\"182\":{}},\"comment\":{}}],[\"pagecount\",{\"_index\":62,\"name\":{\"128\":{}},\"comment\":{}}],[\"pages\",{\"_index\":63,\"name\":{\"129\":{}},\"comment\":{}}],[\"parent\",{\"_index\":32,\"name\":{\"46\":{},\"57\":{},\"70\":{},\"87\":{},\"103\":{},\"166\":{},\"181\":{}},\"comment\":{}}],[\"parseentry\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"pinned\",{\"_index\":35,\"name\":{\"49\":{},\"60\":{},\"73\":{},\"90\":{},\"106\":{}},\"comment\":{}}],[\"putbuffer\",{\"_index\":109,\"name\":{\"194\":{}},\"comment\":{}}],[\"putcollection\",{\"_index\":113,\"name\":{\"198\":{}},\"comment\":{}}],[\"putentries\",{\"_index\":108,\"name\":{\"193\":{}},\"comment\":{}}],[\"putepub\",{\"_index\":114,\"name\":{\"199\":{}},\"comment\":{}}],[\"putepuboptions\",{\"_index\":92,\"name\":{\"165\":{}},\"comment\":{}}],[\"putjson\",{\"_index\":111,\"name\":{\"196\":{}},\"comment\":{}}],[\"putmetadata\",{\"_index\":112,\"name\":{\"197\":{}},\"comment\":{}}],[\"putpdf\",{\"_index\":115,\"name\":{\"200\":{}},\"comment\":{}}],[\"putpdfoptions\",{\"_index\":99,\"name\":{\"180\":{}},\"comment\":{}}],[\"putroothash\",{\"_index\":102,\"name\":{\"187\":{}},\"comment\":{}}],[\"puttext\",{\"_index\":110,\"name\":{\"195\":{}},\"comment\":{}}],[\"register\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"registeroptions\",{\"_index\":87,\"name\":{\"160\":{}},\"comment\":{}}],[\"remarkable\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"remarkableapi\",{\"_index\":100,\"name\":{\"185\":{}},\"comment\":{}}],[\"remarkableoptions\",{\"_index\":123,\"name\":{\"208\":{}},\"comment\":{}}],[\"requestinitlike\",{\"_index\":67,\"name\":{\"135\":{}},\"comment\":{}}],[\"requestmethod\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"responseerror\",{\"_index\":84,\"name\":{\"154\":{}},\"comment\":{}}],[\"responselike\",{\"_index\":73,\"name\":{\"141\":{}},\"comment\":{}}],[\"rr\",{\"_index\":17,\"name\":{\"20\":{}},\"comment\":{}}],[\"set\",{\"_index\":81,\"name\":{\"151\":{}},\"comment\":{}}],[\"size\",{\"_index\":25,\"name\":{\"33\":{},\"39\":{}},\"comment\":{}}],[\"sm\",{\"_index\":11,\"name\":{\"11\":{},\"18\":{}},\"comment\":{}}],[\"status\",{\"_index\":75,\"name\":{\"143\":{},\"156\":{}},\"comment\":{}}],[\"statustext\",{\"_index\":76,\"name\":{\"144\":{},\"157\":{}},\"comment\":{}}],[\"subfiles\",{\"_index\":24,\"name\":{\"32\":{},\"38\":{}},\"comment\":{}}],[\"subtle\",{\"_index\":124,\"name\":{\"210\":{}},\"comment\":{}}],[\"subtlecryptolike\",{\"_index\":82,\"name\":{\"152\":{}},\"comment\":{}}],[\"sync\",{\"_index\":98,\"name\":{\"179\":{}},\"comment\":{}}],[\"synccomplete\",{\"_index\":116,\"name\":{\"201\":{}},\"comment\":{}}],[\"synced\",{\"_index\":36,\"name\":{\"50\":{},\"61\":{},\"74\":{},\"91\":{},\"107\":{}},\"comment\":{}}],[\"synchost\",{\"_index\":125,\"name\":{\"212\":{}},\"comment\":{}}],[\"text\",{\"_index\":77,\"name\":{\"146\":{}},\"comment\":{}}],[\"textalignment\",{\"_index\":5,\"name\":{\"5\":{},\"134\":{},\"171\":{}},\"comment\":{}}],[\"textscale\",{\"_index\":65,\"name\":{\"131\":{},\"169\":{}},\"comment\":{}}],[\"title\",{\"_index\":54,\"name\":{\"116\":{}},\"comment\":{}}],[\"transform\",{\"_index\":52,\"name\":{\"114\":{},\"132\":{}},\"comment\":{}}],[\"type\",{\"_index\":21,\"name\":{\"29\":{},\"35\":{},\"55\":{},\"66\":{},\"85\":{},\"99\":{}},\"comment\":{}}],[\"uploadentry\",{\"_index\":28,\"name\":{\"41\":{}},\"comment\":{}}],[\"uploadepub\",{\"_index\":120,\"name\":{\"205\":{}},\"comment\":{}}],[\"uploadpdf\",{\"_index\":121,\"name\":{\"206\":{}},\"comment\":{}}],[\"uuid\",{\"_index\":89,\"name\":{\"162\":{}},\"comment\":{}}],[\"version\",{\"_index\":34,\"name\":{\"48\":{},\"59\":{},\"72\":{},\"89\":{},\"105\":{}},\"comment\":{}}],[\"visiblename\",{\"_index\":31,\"name\":{\"45\":{},\"56\":{},\"69\":{},\"86\":{},\"102\":{}},\"comment\":{}}],[\"xl\",{\"_index\":14,\"name\":{\"14\":{},\"27\":{}},\"comment\":{}}],[\"xs\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"xx\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7VdXZPbRq79L5pX7Vhofvtt4ySb3NrsunZz92XKldJI9Axv9HUlyne8rvz3rW6SEgACzaao+zRlEw2g+6AB8JBsfZsd9/93mr1/+jb7vdqtZ+/TeD7bLbfl7P3sWL5Up7o8zuaz83Ezez/7fN6t6mq/O73rLj2+1tvNbD5bbZanU3mavZ/N/pgLqj7vj9tl/cOuPn4VtKGroQoPy+Op1PRdL4aqO5bb5fH35fOmFCfbXfSqM4sig8RcdP6j/N9zeap/KevX/fqitv56KE/vyLVRWn8t3+o/b6qX3bbc1UwruebVGl0VPp+rTV3tft3vN6eLvi/LY2UnfHqHL49U+eN+V/9tuS09ai8iY70t3+p/rpYbn+6rjD8KkiRKL/p/+80uZbDSh4s80j230WnRkdy9GoaFuQbgW/hEWpuPbkig2cfWT8X6aTvauhtyH+vb9Wjrbsh9rG9eRlt3Q+5j/W0zHvfN/ay/jbf+NsV6fyf/sjy+VDtP9LcCd9zDWGPgBu68vGH/CNYCNk836vadI9kd3jZhdo/HcXad/B3s+vaqZHd4o6p2+5H612pX/lRWL6+1J1qR0B0jlmsNjFrssbKi68+jrT66MaGGJ0SwZn84isPt+yJKsz8cVeH2fflfsz9cALz2TXINvA/7zaZ0bS7tpatdXR4/L1fl6R0T8UY1mRoJ6QGFD95w5l4qBl+Xp9dgg63wJIPr/epsW+2f18FmyZBJxk/n588VboCHTKMB0wxX/w7HtRUeaxDH6I/VplSj83JxelxSVf6IvPo0MhaZEW8UDhrxxx8zFRB5gwZ9McfMDUbbsDElzrghX4RJRvgdNY2t5k56OKRwhP73YbNfrtUYRZfDo3S9X/38fYi2h05SXgHs28hY7VnyRqtsiBab7Xa/+6Wsl+tlvZRTCJYIX6wv1al63pSWSQhU+0CHaPmJOKwYb8UD7V6kp5jcLE/1L/t19bkqldLTN8zGTDH/pTyeqv0ueKkv4pOWudrtwmd7kZ5i8vR1two3eZGeYnI7EtXtfRBdl5uyDrd6FZ801/b66Dn3x410Q26Bf/16KP3ZSZK8Z0Pc0xvaFxPXb02SuhdasqxP6z9Vpz9Vu9fyWDUBcaNzviSq+yUk0/u5NJxkdcfUZHs/97xJ2AOlkIzvCKMnSXtg7Cfr+7nkS+K6S0Iyv59L/oSnOyUmvPu55S0CuldSMbjjWgUVCc+a+YrFJDdxEfm+vbkaKiGS3PQComr1lw/RaU8y/PuhVDa37gAZd083Pi5fRq5Fb+x0d1bHclmX618ruaTqvtCB0x0ZqO26I7dU9jGO6XVd92lkVR8bP76a7o+e0RV9FIR6PffAN7Kaj4JOreUe6MZV8jHu6HVcd2dkFR/jjq8e6Q6NrkJjXPLUb92jsdV71BoF1G7PWt1auQdc5Pxfr143FGBQecY9wHfL08WcygX2hMKrfyWun6zwodLrbd/PkbygYtLLDvqMynfjg0upiE5dUJ9avqxh/eOkxfa601vyOzo0zFYIDvX6zTs6FMxfCH5NIzCC3AthMATPbqYwgpwK5zAE1yaSGGGghrAYEqA30xhhYAbwGBKYtxIZQU6FMBmCUzdTGUFOhd2XC25NuCEPciyIzRD8up3OCFuvUXyGtG7TCY2QQtw1UYNlWBQML8L2IfGvA7yGsApomP/uOQgUuRPwmB/RB4xyROsCPK6M6gFGOTNEN02t/6OcCSOglComMFD/D44NUVJe53qc1N0cDCSpBO80lupurgXSVndq6Ea5NkxcTW/mRsdZCHV1r0ZuHJDD5NUdmrhxAA7SV9MbuFEODRNY05u3UQ6F0DL3aNxGORVAYt2haRu3TiNorHs2bENOakSW9EJbeHfWez3urT4uFY6MXBul9Ufe9jUKu/8e90nccbk72W8I+edw3f8HU3h8xUOQHvH4rqo3QXWu7aVa8bD+VjO6PNev+6P4xqZs9jpgtGFK5O1qlQ9xl0a8C3nebr92doc0PnBp7d2Zxr+BV2v97wNhq/0BNxkuxe2mWeXSN5n03YIRa4M3XUOG2q89hw1dBW8yNNyTE3OBT4aHjF4+uhg2iEVvMrZln81plq5yN5nZH6tyVy9rlaJDpqjsTeYOy5fyw/4csMmx5M2mhpevk7rJxGr/pTzaiPrbefuMPqPXjPXlbzJbd99fDhrEkreZ6lVe1RSSvDF32DMC/uWji0kCodI3L2T/U3vfYmLpUJO4aLbHAvy8q+q/Vr+LADKR8CK6pecQDKh8uIjL8+CeanxWuVyXcvchWr3KTzL7vF+LXKVosxUeaxDj9lPjtoYZujzQ2Mb5RedLKcYc1/XQyMneY7+0iDsd9rtTqYfb9Xp4rO1/D9L14OS0hUeOaXfU9bI+K8HFTV1kp5qzn7ePMdnK327Wu4e4zeENJBokkVcHz7C+YW7E1PJ4XH797vz5s1we+xbpgHGG8TeFZb161WL+cjH4vvHDcvWqbqHLxcl7n2ry7vyrR4qJU5CJ01gTaFH+eX6uN+WH49dDvdfWhsuEL9G6eilP4hREnQ8XeXkyPWfRZjR5L13+cDzurxHbqnxHrnqnkoBBbeLuVB/PqzpI4wMV9++Axs2w7OkxGZg7A6yR5DloMSh19qwiuP5S7sqjuyORAWPX7wKZpDMINO6sVrCbk7f+fnCHU8lZk4iM4FnKL9Wq/L48rULVPpAhGlDUY8X4+Sw/hRXNtsKTDFqi66e9nENEo2jAJMOfbX0JttpJjzWJg+bjuf7hcH72xAyVCA8Z/TGZoHHo41fm5njqQ7I5xICEGfWTO5LdAI4nzLT3fl6yPHxbH2Z4gPyRTIdwQOGz9t58azMfvgcPc8CxMaGGO+EpBn3sqGRzkCQNjOzlqban+wXH9VV+pFmckf5S1v/Y7+uflqdXT1bqS4VnppVtT0cofegGaNW557ByL+Bemvhl/6X0TKwndId5yToHptX31vP0eoTVVny8UVa2Pq4/+6vWVeBORYspDKhZyMebMym3GphIh0370hg3OpjFhs0NZBNuMSSZiEZpS9ydz/rnQyX3VUhg1F14t+XDtD7QEVrHhr1VTB/OY03TERNMv5S1j5CR5jzIx4SZ1Zk1yejAzWGYyf86yTtSNtlKTzPpe7Yrmx18vhtq2r78UclPvWTL1wHTYnmcYTJgmuFRkYzlp5kdEclX6WkmR0TyVXqayZGRTEdMM319lz3cOBkzMZ4P5+cRwdxITzP5EZ3UOWjxo+eIziCDtn37sN8e7Ft1gWbZkAnGm9eOA81ehCcY3O6/hJprRe+Sh8dXgv7ACY6cmwPbwkOZDJhsODygsfy0hf+g3TvJy/3Be+ukGhVbUy9fy4RGfD2jU4mSzkEykXur3Qy6pyUj7F4GTDTs52xF0wGsbeisv+5WI42jIRONr5qnbduq/u5rPdRK9QkAMnKiK9WuCtlJxAk8Jtj8p/ms2q3Lt9n7b5cvDN7PzGP0WMzms89VuVnbny5p/JrPVvut4/0+tdf+VdrnLVaiEXm3mM2fFvO4eMyKT5/mT90A9//uP5wUzOZPIEgBkTKz+ZMRpAyRimbzp0iQiohUPJs/xYJUTKSS2fwpmcfwGEFGxBIils7mT6mgLCVS2Wz+lAlSGZHKZ/OnXJDKiVQxmz8VkmMFXVe7zCCtPzAAHAIwj+PHNDdUkoIAdrXBSLaBAgF2xSESJSkYYFcdYtE6BQTswkMiTYhCAnbtQQIFKCqQaUsJFBjI9SWi4EChLxHFxzh8pKAwFB8D6loatkkcPlIEGQqPibSJG4qOcegUkkYKjknUeRuKjkn16VB4TKaGhqH4GAuCkWLdUHiMxcDAPEoewTDjFJ7IgmCMJBlRfCILgokkNyOKT+SymDihiCUyC4NJREmKUGRxMFKwRxShKFGnHlGEolSfOkUoyvSpU4SiXJ86hSgq9KlTiGIHkbSDYopQ7BCS9kVMAYodQFK4xxSfOFKXKGbFxqIQSaEZU3xiC0IE8yh9zAqmkuITWxAiM4+ix7RIqSTFJ7YgRJGok+ITWxCiWJSk+MQWhCgRJSk+iUUhSiXJhAKUWBiiTJSkCCUWhygXJSlEiWsGClGSQpS4hkCCKGEtgb6FEgpRkqpgJhSiJFPBTChESa6CmVCIkkIFM6EQpQsVzJRClIIKZkohSo0KZkohSiMVzJRClMYqmCnFKLVAxFJDmbLGLVXBTClEqcUhNlJGSilEqcUhFmtbSiFKLQ6xmA9TClG2UEMpoxBloIZSRiHKjBpKGYUoi9RQyihEWayGUkYhyhI1lDKKUZaqoZSxBjtTQymjGGW5GkoZxShzGEkNZ0Yhyi0OsVSDc4pQbmGIMyk+copQbtQCk1OEcgtDLN42UIDyWDdOAcoT3TgFKNc3UU4ByjM1jHN2F5SrYZxTgPJCDeOcIlQs1DAuKEQFqGFcUIgKo4ZxQSEqIjWMC4pREathXFCMikQN44JiVFggYqmpKShEhcUhWYi3lhSiIldDqWA3q4UaSgW/X12osdRcw7KgpuTmGpY1alJurmHZSE3LzTUsG6sR3VzDsoka0801LJuqUd1cw7KZGtfNNSybq5HdXMOyhRrbzTUk6+gEObqhRzWAGt/AyQZHKcgRDpxucKRCItJInG9wrEIihw5nHByxIO8I4KSD4xYS8V4IOO/g6IVEDjNOPTiCIRFpD849OIYhEYkPRj6A4xgS6d4JGP0AjmRIpAIDhvNDRp8XoyDAMQ0KDoyFAEc2KDgwIgIc3ZAUsl6GmSMclNTAyAhwlEO6kPUyzBzrkMp8EWMkwPEOqUKqMdQc85BKDCcwUgIc9ZBKNCcwVgIc95CKERZxWs8Ck6bixBgxAY5/UDYE4ybAMRCpGI6MnABHQYjELDB2AhwHkYqRy+gJcCREKhVJYPwEOBYikwOBMRTgiIhMzEuMowBHRWQSxw2MpQBHRmTyyjKiAhwdkYlxEHMm1oKSiXHAuApwjEQmxwFjK8BxElkmyzLEHCuhrC1jLMDxEpmILqMswBETmYgu4yzAMRO5SJsz0gIcNZGL4DLWAhIPYoy3AMdO5GIgMOICHD+Ri/kg4eS5RSUX44BxF+AYilwm2hlejqLI5Thg9AU4kkKJGUZggKMplJhhFAY4oiIXcwfjMMAxFYq7jMUAx1XkYngxGgMcWZGL4cV4DHBsRSGGFyMywPEVhVxEUv7Ew+JSyMWUsRngOItCDBpGZ0Cq34oBIzTA0RZKzWOUBjjiQqmljNQAR10oJYfRGuDIC6WWMmIDHH0h1xHGbIDjLwq5rWHcBmSe9oOxG+A4jEKkuiHjj6ocamJvxwgOcDRGIW8eRnGAYzIKMcoZyQGOy1DUMp4DHJtRiDuCER3g6AxYiFuCUR3gGA0lHhnbAY7TUGKB8R3gWA0FYMZ4QO4BjXEe4JgNWIglgrEe4LgNWIh5n/Ee4NgNWIh7mDEfUDTPgcXMz7gPcAwHLMTUz9gPKBrcxIhk/Ac4lgMWYo5mDAg4ngMWYkgyDgQc0wELMc4YCwKO7AD5gTgjQsDRHQAibowKgaJ5NizixsgQcJQHgIgbo0OMozwAJNwMo0PMonmEL+FmGB1iHOUB4uNxw+gQ4ygPUB5SsyfFjvIA+ekzo0OMozxAfq7M6BDjKA+QH+4yOsQ4ygOMhJthdIhxlAcY8aUSRoeYRfNUX8LNMDrENO9dGBE3RocYR3nIZdswOsS0L1+IGDM6xDjOQ24dDONDTPMChvgE2TA+xDSvYIiPXA3jQ0zzFob41NW0fIh74ehLeazL9c/Ni0dPT7P2B9Tn32a/tW8jFd2rUN9mxez9tz/mM8iavyayf/+4votk/2UtuXMrntu3y6+aMqTKdv7K4HP9+ureIkM+ABqZJq15UO13p/pdNVxfU/w2s3SMPPB5eSq7EyzL5mDJq4oYqcgXmgZ3vg6aM/Y8Vkc1v2RvP3K0wsTz7Kog8w+3H+G+uo9wiQLIrxqM8au4fD+MhuOVS/3D7SepJ/sxLtGA7OcD4/f7DRmKbGum20/+ULCgFbMdVxOzKmJu/MYd2YFcxrAl4B+6rern5mVDtGoGeWF3p6Lh8pp+L9zMAinQ1u06Xg9bvPzajrnqsdt/e3nlGqlB7iSxqsb+Bq00PELDY304OjgCgYEjMGmTj71jVLU0h3Gi3Y9DwqiR0HwRiCIpxpEUd5Gkg/mlPNpD9HbtkXYojhOkKdI2Yfd6PwojsnkX6sI1Z5fX7uxyhBnyP+2S90KNAafEvvO/717fRkuR46XQ8uflZGIEPBqYmMaHNGr+Zi2WRbe0oGHanLyxdidvoMDABSXV5mVfpUcrisYYbT2783OQKRwKiRYB6/2qIrM3yFqswd6dpsqGRtehETQLFGkVoFMhbb0Eu97VblArAVfVTyi4I9CycqdFTScowabqctrDbdeXw23RlHA0Gi1o+ikVpQG1FrtTZsV1NHgdu5BVm6D26wO0hfD4NO2aGM17N75XlxY4DLUp2KNr+5NHWTTSAt+O5A1ggmwWXfhA0s1fVdU2M0QV3rCmU5Fp+DcHW/Zmgmuzd+TlyH2UiHEliDTDL5fTicrmKCWEAFaQagi408pQD4f2MsRtFoRE24IvZd3vni2JcFVSeCz3OiLAucTeMqlDy+5TVGwXb7ZCg/s6WNo7QLqZhZY1Xsr6f04UMMtxIPOeJRPtLjBchbZXX8r6uN/Xza/L4NF4y+ZaE4ZGS5UT+59pCfylrJvzBbF13DQUWqhzpw3yOVq0daPNNnFbePM2BPN2CxZaSFxOWESxjFNQ1HUVsTaxVgNPZBle2VibG62IMcIybyti3ubhQgPHfosjbAjcVql3NfbAhusPGaCeBm2nuM2ISXujkXVLe+m3fNr37W/1oEmihUm7bLvQFuiq4+AO80Z6kI9pdxO06FKP8TlVuzMqUATjOMzSrg1WVbyQpcapL+qKXvtXVXG5kyW5G0ee6dYm0zKhcC+b4tJhulVJtejfrmnQ4MHt2BZlo1USsfdB66m20mr7leA5qBRI/3c4UPiiKpy0kKTtPurul4uuOIOWcbszk9Hq4uoeaRtS9Ajt7KQNjrRd4i7giqjzSAXcfa6Mb55wr7/QILLn8qLEhINdvVMlJ9agFSAhcqHLumDJNXV2866aA96RMrJztEm3h7ajYbhNiLTE0R30gzBAvsftmnc321mXbS+JpAuPS2pRqYXD8ngSulGEjDaw/Xki5CLCJm5XN21LXHd7XkDnohaAh7PUXQFOLuptzeFcr9DJCnh8jGNNResst1h45xRaoNrB7nt0bDbBZlW0m5FSd4KDLNWK+OHc78tIOlTL7+Es92WkLKjtx+FcH9jtO6YjzUKNHTdQmK991IlaOs94uSHEbucet3vNHOC0XWgLfWxPuMRDkcNaWHXDhAnnuHtPtfkeL98jk/2GOsnBgUt7HBVeKjzhXJ9wN14Cy+BNpeb9Y3Nsve30eJuZ4tmr7EmroF/RkHktdR/bk3n7N4q4kCRaQumG9/pjnMVjdfVpDsOUs7ZYJ3pnmuNdnGh2TtW/iXcGzS1q63Kk7YbTlm4E3L50xUMb2p7FjNYF303FXRVK/Ar4ZszwTWFX6+ybTYqS87PlRYgfODKjtr6rLU93IASObJy31R6rGbhyB3X3qCCcilRGvjmaEOV7XGlyrV7YUavL8TYYPBJiari0v+OHMgmCLWkrdtqin3U3oV2bpBIUVi9/NAiY1zKgrUMvBHBiiDXg7Kjl9YhV1ISj6bRed/fY9v0lXdupOaoWZSgc0N1egkxDpv2dNOQJTjPqRkK/SIOG4giCzn2VG+S8oEE7uet1o3Y1kvZvR3PmnXa1M2rOven3iQgnlSZox/LeiDi40JJ/M5i3GZhFMWor2ZzMjXYXbi5SbSEFWjLClaZtqZN2TbM2KIpFt4baVNrfieWsa4TWoUuZSQtI1irNL1SD5vUb4QSA1KdmrNH8emMtGBqqhcPbGxlCaqk05NN8dqgOpSUOZu+fPv3xx38AepX6keypAAA="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 18b4f8f..072daed 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -11,6 +11,7 @@ --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); @@ -28,11 +29,10 @@ --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: var(--light-color-ts-type-alias); + --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); - /* object literal not included as it is not used and will be removed in 0.25 */ --light-color-ts-type-alias: #d51270; /* reference not included as links will be colored with the kind that it points to */ @@ -51,6 +51,7 @@ --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); @@ -68,11 +69,10 @@ --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: var(--dark-color-ts-type-alias); + --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); - /* object literal not included as it is not used and will be removed in 0.25 */ --dark-color-ts-type-alias: #ff6492; /* reference not included as links will be colored with the kind that it points to */ @@ -93,6 +93,7 @@ --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); @@ -134,6 +135,7 @@ --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); @@ -182,6 +184,7 @@ body { --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); @@ -221,6 +224,7 @@ body { --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); @@ -262,12 +266,12 @@ h6 { line-height: 1.2; } -h1 > a, -h2 > a, -h3 > a, -h4 > a, -h5 > a, -h6 > a { +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); } @@ -401,7 +405,8 @@ dd { } body { background: var(--color-background); - font-family: "Segoe UI", sans-serif; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); } @@ -468,13 +473,12 @@ blockquote { padding: 0 0 0 20px; margin: 0; } -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, +.tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; - margin: 0; } .tsd-typography h5, .tsd-typography h6 { @@ -485,6 +489,19 @@ blockquote { .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; @@ -633,6 +650,28 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { 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; } @@ -698,12 +737,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } .tsd-navigation > a, .tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.5rem); + width: calc(100% - 0.25rem); + display: flex; + align-items: center; } .tsd-navigation a, .tsd-navigation summary > span, .tsd-page-navigation a { - display: inline-flex; + display: flex; + width: calc(100% - 0.25rem); align-items: center; padding: 0.25rem; color: var(--color-text); @@ -743,11 +785,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-left: -1.5rem; } -.tsd-nested-navigation > li > a, -.tsd-nested-navigation > li > span { - width: calc(100% - 1.75rem - 0.5rem); -} - .tsd-page-navigation ul { padding-left: 1.75rem; } @@ -900,8 +937,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -909,12 +947,15 @@ a.tsd-index-link { #tsd-search .results li.state { display: none; } -#tsd-search .results li.current, -#tsd-search .results li:hover { +#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: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -970,6 +1011,11 @@ a.tsd-index-link { 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; @@ -1070,7 +1116,9 @@ ul.tsd-type-parameter-list h5 { overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } @@ -1122,7 +1170,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { diff --git a/docs/classes/GenerationError.html b/docs/classes/GenerationError.html index 3075861..29031c7 100644 --- a/docs/classes/GenerationError.html +++ b/docs/classes/GenerationError.html @@ -1,219 +1,15 @@ -GenerationError | rmapi-js
-
- -
-
-
-
- -

Class GenerationError

-
-

an error that results from trying yp update the wrong generation.

+GenerationError | rmapi-js

Class GenerationError

an error that results from trying yp update the wrong generation.

If we try to update the root hash of files, but the generation has changed relative to the one we're updating from, this will fail.

-
-
-
-

Hierarchy

-
    -
  • Error -
      -
    • GenerationError
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
cause? -message -name -stack? -prepareStackTrace? -stackTraceLimit -
-
-

Methods

-
captureStackTrace -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Optional cause

-
cause?: unknown
-
-

message

-
message: string
-
-

name

-
name: string
-
-

Optional stack

-
stack?: string
-
-

Static Optional prepareStackTrace

-
prepareStackTrace?: ((err, stackTraces) => any)
-
-

Type declaration

-
-
-

Static stackTraceLimit

-
stackTraceLimit: number
-
-

Methods

-
-

Static captureStackTrace

-
    - -
  • -

    Create .stack property on a target object

    -
    -
    -

    Parameters

    -
      -
    • -
      targetObject: object
      • -
    • -
      Optional constructorOpt: Function
    -

    Returns void

    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Hierarchy

  • Error
    • GenerationError

Constructors

constructor +

Properties

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

Methods

captureStackTrace +

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

+

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/ResponseError.html b/docs/classes/ResponseError.html index d015ef6..7f6190c 100644 --- a/docs/classes/ResponseError.html +++ b/docs/classes/ResponseError.html @@ -1,246 +1,17 @@ -ResponseError | rmapi-js
-
- -
-
-
-
- -

Class ResponseError

-
-

an error that results from a failed request

-
-
-
-

Hierarchy

-
    -
  • Error -
      -
    • ResponseError
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
cause? -message -name -stack? -status -statusText -prepareStackTrace? -stackTraceLimit -
-
-

Methods

-
captureStackTrace -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      status: number
      • -
    • -
      statusText: string
      • -
    • -
      message: string
    -

    Returns ResponseError

-
-

Properties

-
-

Optional cause

-
cause?: unknown
-
-

message

-
message: string
-
-

name

-
name: string
-
-

Optional stack

-
stack?: string
-
-

Readonly status

-
status: number
-

the response status number

-
-
-
-

Readonly statusText

-
statusText: string
-

the response status text

-
-
-
-

Static Optional prepareStackTrace

-
prepareStackTrace?: ((err, stackTraces) => any)
-
-

Type declaration

-
-
-

Static stackTraceLimit

-
stackTraceLimit: number
-
-

Methods

-
-

Static captureStackTrace

-
    - -
  • -

    Create .stack property on a target object

    -
    -
    -

    Parameters

    -
      -
    • -
      targetObject: object
      • -
    • -
      Optional constructorOpt: Function
    -

    Returns void

    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +ResponseError | rmapi-js

Class ResponseError

an error that results from a failed request

+

Hierarchy

  • Error
    • ResponseError

Constructors

constructor +

Properties

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

Methods

captureStackTrace +

Constructors

constructor

Properties

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Readonly status

status: number

the response status number

+

Readonly statusText

statusText: string

the response status text

+

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

+

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamestackstatusstatusTextprepareStackTracestackTraceLimitcaptureStackTrace

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/formatEntry.html b/docs/functions/formatEntry.html index 9e21a40..d554592 100644 --- a/docs/functions/formatEntry.html +++ b/docs/functions/formatEntry.html @@ -1,96 +1,2 @@ -formatEntry | rmapi-js
-
- -
-
-
-
- -

Function formatEntry

-
-
    - -
  • -

    format an entry

    -
    -
    -

    Parameters

    -
      -
    • -
      __namedParameters: Entry
    -

    Returns string

    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +formatEntry | rmapi-js

Function formatEntry

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/parseEntry.html b/docs/functions/parseEntry.html index ed67c82..0311d53 100644 --- a/docs/functions/parseEntry.html +++ b/docs/functions/parseEntry.html @@ -1,96 +1,2 @@ -parseEntry | rmapi-js
-
- -
-
-
-
- -

Function parseEntry

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +parseEntry | rmapi-js

Function parseEntry

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/register.html b/docs/functions/register.html index 6241405..401f369 100644 --- a/docs/functions/register.html +++ b/docs/functions/register.html @@ -1,105 +1,7 @@ -register | rmapi-js
-
- -
-
-
-
- -

Function register

-
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/remarkable.html b/docs/functions/remarkable.html index 58ac61c..c3f8282 100644 --- a/docs/functions/remarkable.html +++ b/docs/functions/remarkable.html @@ -1,105 +1,7 @@ -remarkable | rmapi-js
-
- -
-
-
-
- -

Function remarkable

-
-

Returns Promise<RemarkableApi>

an api instance

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html new file mode 100644 index 0000000..c9daf82 --- /dev/null +++ b/docs/hierarchy.html @@ -0,0 +1 @@ +rmapi-js

rmapi-js

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 35fc952..3e6a185 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,18 +1,4 @@ -rmapi-js
-
- -
-
-
-
-

rmapi-js

-

rmapi-js

build +rmapi-js

rmapi-js

rmapi-js

build docs npm license

@@ -75,84 +61,4 @@

rmapi-js

that intensive or doesn't already require the whole file in memory, we opted to process strings or ArrayBuffers ignoring Readable and WriteableStreams for the time being.

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

rmapi-js

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/BaseMetadataEntry.html b/docs/interfaces/BaseMetadataEntry.html index 0129b9e..9fc9a69 100644 --- a/docs/interfaces/BaseMetadataEntry.html +++ b/docs/interfaces/BaseMetadataEntry.html @@ -1,128 +1,6 @@ -BaseMetadataEntry | rmapi-js
-
- -
-
-
-
- -

Interface BaseMetadataEntry

-
-

fields common to all MetadataEntries

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
hash -id -
-
-

Properties

-
-

hash

-
hash: string
-

the hash of the entry

-
-
-
-

id

-
id: string
-

the document id of the entry

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +BaseMetadataEntry | rmapi-js

Interface BaseMetadataEntry

fields common to all MetadataEntries

+
interface BaseMetadataEntry {
    hash: string;
    id: string;
}

Hierarchy (view full)

Properties

hash +id +

Properties

hash

hash: string

the hash of the entry

+

id

id: string

the document id of the entry

+

Settings

Member Visibility

Theme

On This Page

hashid

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CacheLike.html b/docs/interfaces/CacheLike.html index 431e620..4a064ce 100644 --- a/docs/interfaces/CacheLike.html +++ b/docs/interfaces/CacheLike.html @@ -1,143 +1,6 @@ -CacheLike | rmapi-js
-
- -
-
-
-
- -

Interface CacheLike

-
-

async storage, map like

-
-
-
-

Hierarchy

-
    -
  • CacheLike
-
-
-
- -
-
-

Methods

-
get -set -
-
-

Methods

-
-

get

-
    - -
  • -

    get value for key or undefined if missing

    -
    -
    -

    Parameters

    -
      -
    • -
      key: string
    -

    Returns Promise<undefined | string>

    -
-
-

set

-
    - -
  • -

    set value for key

    -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      • -
    • -
      value: string
    -

    Returns Promise<void>

    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +CacheLike | rmapi-js

Interface CacheLike

async storage, map like

+
interface CacheLike {
    get(key): Promise<undefined | string>;
    set(key, value): Promise<void>;
}

Methods

get +set +

Methods

get

  • get(key): Promise<undefined | string>

  • get value for key or undefined if missing

    +

    Parameters

    • key: string

    Returns Promise<undefined | string>

set

Settings

Member Visibility

Theme

On This Page

getset

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CollectionEntry.html b/docs/interfaces/CollectionEntry.html index bff57f2..34a6430 100644 --- a/docs/interfaces/CollectionEntry.html +++ b/docs/interfaces/CollectionEntry.html @@ -1,155 +1,12 @@ -CollectionEntry | rmapi-js
-
- -
-
-
-
- -

Interface CollectionEntry

-
-

a remarkable entry for a cloud collection

-
-
-
-

Hierarchy

-
    -
  • CollectionEntry
-
-
-
- -
-
-

Properties

-
documentId -hash -size -subfiles -type -
-
-

Properties

-
-

documentId

-
documentId: string
-

the unique id of the collection

-
-
-
-

hash

-
hash: string
-

the hash of the collection this points to

-
-
-
-

size

-
size: bigint
-

collections don't have sizes

-
-
-
-

subfiles

-
subfiles: number
-

the number of subfiles

-
-
-
-

type

-
type: "80000000"
-

collection type

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +CollectionEntry | rmapi-js

Interface CollectionEntry

a remarkable entry for a cloud collection

+
interface CollectionEntry {
    documentId: string;
    hash: string;
    size: bigint;
    subfiles: number;
    type: "80000000";
}

Properties

documentId +hash +size +subfiles +type +

Properties

documentId

documentId: string

the unique id of the collection

+

hash

hash: string

the hash of the collection this points to

+

size

size: bigint

collections don't have sizes

+

subfiles

subfiles: number

the number of subfiles

+

type

type: "80000000"

collection type

+

Settings

Member Visibility

Theme

On This Page

documentIdhashsizesubfilestype

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CollectionMetadataEntry.html b/docs/interfaces/CollectionMetadataEntry.html index efa3b2d..bd69e1d 100644 --- a/docs/interfaces/CollectionMetadataEntry.html +++ b/docs/interfaces/CollectionMetadataEntry.html @@ -1,240 +1,26 @@ -CollectionMetadataEntry | rmapi-js
-
- -
-
-
-
- -

Interface CollectionMetadataEntry

-
-

the metadata entry for a collection

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
deleted? -hash -id -lastModified -metadatamodified? -modified? -parent? -pinned? -synced? -type -version? -visibleName -
-
-

Properties

-
-

Optional deleted

-
deleted?: boolean
-

if file is deleted

-
-
-
-

hash

-
hash: string
-

the hash of the entry

-
-
-
-

id

-
id: string
-

the document id of the entry

-
-
-
-

lastModified

-
lastModified: string
-

last modified time

-
-
-
-

Optional metadatamodified

-
metadatamodified?: boolean
-

unknown significance

-
-
-
-

Optional modified

-
modified?: boolean
-

unknown significance

-
-
-
-

Optional parent

-
parent?: string
-

parent uuid (documentId) or "" for root or "trash"

-
-
-
-

Optional pinned

-
pinned?: boolean
-

unknown significance

-
-
-
-

Optional synced

-
synced?: boolean
-

unknown significance

-
-
-
-

type

-
type: "CollectionType"
-

the key for collection types

-
-
-
-

Optional version

-
version?: number
-

unknown significance

-
-
-
-

visibleName

-
visibleName: string
-

name of content

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +CollectionMetadataEntry | rmapi-js

Interface CollectionMetadataEntry

the metadata entry for a collection

+
interface CollectionMetadataEntry {
    deleted?: boolean;
    hash: string;
    id: string;
    lastModified?: string;
    metadatamodified?: boolean;
    modified?: boolean;
    parent?: string;
    pinned?: boolean;
    synced?: boolean;
    type: "CollectionType";
    version?: number;
    visibleName: string;
}

Hierarchy (view full)

Properties

deleted? +hash +id +lastModified? +metadatamodified? +modified? +parent? +pinned? +synced? +type +version? +visibleName +

Properties

Optional deleted

deleted?: boolean

if file is deleted

+

hash

hash: string

the hash of the entry

+

id

id: string

the document id of the entry

+

Optional lastModified

lastModified?: string

last modified time

+

Optional metadatamodified

metadatamodified?: boolean

unknown significance

+

Optional modified

modified?: boolean

unknown significance

+

Optional parent

parent?: string

parent uuid (documentId) or "" for root or "trash"

+

Optional pinned

pinned?: boolean

unknown significance

+

Optional synced

synced?: boolean

unknown significance

+

type

type: "CollectionType"

the key for collection types

+

Optional version

version?: number

unknown significance

+

visibleName

visibleName: string

name of content

+

Settings

Member Visibility

Theme

On This Page

deletedhashidlastModifiedmetadatamodifiedmodifiedparentpinnedsyncedtypeversionvisibleName

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CollectionTypeMetadata.html b/docs/interfaces/CollectionTypeMetadata.html index e9aeda3..c33ddcb 100644 --- a/docs/interfaces/CollectionTypeMetadata.html +++ b/docs/interfaces/CollectionTypeMetadata.html @@ -1,218 +1,22 @@ -CollectionTypeMetadata | rmapi-js
-
- -
-
-
-
- -

Interface CollectionTypeMetadata

-
-

metadata for collection types

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
deleted? -lastModified -metadatamodified? -modified? -parent? -pinned? -synced? -type -version? -visibleName -
-
-

Properties

-
-

Optional deleted

-
deleted?: boolean
-

if file is deleted

-
-
-
-

lastModified

-
lastModified: string
-

last modified time

-
-
-
-

Optional metadatamodified

-
metadatamodified?: boolean
-

unknown significance

-
-
-
-

Optional modified

-
modified?: boolean
-

unknown significance

-
-
-
-

Optional parent

-
parent?: string
-

parent uuid (documentId) or "" for root or "trash"

-
-
-
-

Optional pinned

-
pinned?: boolean
-

unknown significance

-
-
-
-

Optional synced

-
synced?: boolean
-

unknown significance

-
-
-
-

type

-
type: "CollectionType"
-

the key for collection types

-
-
-
-

Optional version

-
version?: number
-

unknown significance

-
-
-
-

visibleName

-
visibleName: string
-

name of content

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +CollectionTypeMetadata | rmapi-js

Interface CollectionTypeMetadata

metadata for collection types

+
interface CollectionTypeMetadata {
    deleted?: boolean;
    lastModified?: string;
    metadatamodified?: boolean;
    modified?: boolean;
    parent?: string;
    pinned?: boolean;
    synced?: boolean;
    type: "CollectionType";
    version?: number;
    visibleName: string;
}

Hierarchy (view full)

Properties

deleted? +lastModified? +metadatamodified? +modified? +parent? +pinned? +synced? +type +version? +visibleName +

Properties

Optional deleted

deleted?: boolean

if file is deleted

+

Optional lastModified

lastModified?: string

last modified time

+

Optional metadatamodified

metadatamodified?: boolean

unknown significance

+

Optional modified

modified?: boolean

unknown significance

+

Optional parent

parent?: string

parent uuid (documentId) or "" for root or "trash"

+

Optional pinned

pinned?: boolean

unknown significance

+

Optional synced

synced?: boolean

unknown significance

+

type

type: "CollectionType"

the key for collection types

+

Optional version

version?: number

unknown significance

+

visibleName

visibleName: string

name of content

+

Settings

Member Visibility

Theme

On This Page

deletedlastModifiedmetadatamodifiedmodifiedparentpinnedsyncedtypeversionvisibleName

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CommonMetadata.html b/docs/interfaces/CommonMetadata.html index f3f91dc..a3005da 100644 --- a/docs/interfaces/CommonMetadata.html +++ b/docs/interfaces/CommonMetadata.html @@ -1,198 +1,20 @@ -CommonMetadata | rmapi-js
-
- -
-
-
-
- -

Interface CommonMetadata

-
-

common metadata for documents and collections

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
deleted? -lastModified -metadatamodified? -modified? -parent? -pinned? -synced? -version? -visibleName -
-
-

Properties

-
-

Optional deleted

-
deleted?: boolean
-

if file is deleted

-
-
-
-

lastModified

-
lastModified: string
-

last modified time

-
-
-
-

Optional metadatamodified

-
metadatamodified?: boolean
-

unknown significance

-
-
-
-

Optional modified

-
modified?: boolean
-

unknown significance

-
-
-
-

Optional parent

-
parent?: string
-

parent uuid (documentId) or "" for root or "trash"

-
-
-
-

Optional pinned

-
pinned?: boolean
-

unknown significance

-
-
-
-

Optional synced

-
synced?: boolean
-

unknown significance

-
-
-
-

Optional version

-
version?: number
-

unknown significance

-
-
-
-

visibleName

-
visibleName: string
-

name of content

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +CommonMetadata | rmapi-js

Interface CommonMetadata

common metadata for documents and collections

+
interface CommonMetadata {
    deleted?: boolean;
    lastModified?: string;
    metadatamodified?: boolean;
    modified?: boolean;
    parent?: string;
    pinned?: boolean;
    synced?: boolean;
    version?: number;
    visibleName: string;
}

Hierarchy (view full)

Properties

deleted? +lastModified? +metadatamodified? +modified? +parent? +pinned? +synced? +version? +visibleName +

Properties

Optional deleted

deleted?: boolean

if file is deleted

+

Optional lastModified

lastModified?: string

last modified time

+

Optional metadatamodified

metadatamodified?: boolean

unknown significance

+

Optional modified

modified?: boolean

unknown significance

+

Optional parent

parent?: string

parent uuid (documentId) or "" for root or "trash"

+

Optional pinned

pinned?: boolean

unknown significance

+

Optional synced

synced?: boolean

unknown significance

+

Optional version

version?: number

unknown significance

+

visibleName

visibleName: string

name of content

+

Settings

Member Visibility

Theme

On This Page

deletedlastModifiedmetadatamodifiedmodifiedparentpinnedsyncedversionvisibleName

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Content.html b/docs/interfaces/Content.html index c2e1458..eaa0b5c 100644 --- a/docs/interfaces/Content.html +++ b/docs/interfaces/Content.html @@ -1,266 +1,35 @@ -Content | rmapi-js
-
- -
-
-
-
- -

Interface Content

-
-

content metadata

+Content | rmapi-js

Interface Content

content metadata

This is found in the .content file.

-
-
-
-

Hierarchy

-
    -
  • Content
-
-
-
- -
-
-

Properties

-
coverPageNumber -documentMetadata? -dummyDocument -extraMetadata -fileType -fontName? -formatVersion -lastOpenedPage -lineHeight -margins -orientation? -pageCount -pages -textAlignment? -textScale -transform? -
-
-

Properties

-
-

coverPageNumber

-
coverPageNumber: number
-

number to use for the coverage page, -1 for last opened

-
-
-
-

Optional documentMetadata

-
documentMetadata?: DocumentMetadata
-

document metadata

-
-
-
-

dummyDocument

-
dummyDocument: boolean
-

is this a dummy document

-
-
-
-

extraMetadata

-
extraMetadata: ExtraMetadata
-

extra metadata

-
-
-
-

fileType

-
fileType: FileType
-

file type

-
-
-
-

Optional fontName

-
fontName?: string
-

font

-
-
-
-

formatVersion

-
formatVersion: number
-

format version

-
-
-
-

lastOpenedPage

-
lastOpenedPage: number
-

last opened page

-
-
-
-

lineHeight

-
lineHeight: number
-

line height

-
-
-
-

margins

-
margins: number
-

page margins in points

-
-
-
-

Optional orientation

-
orientation?: "portrait" | "landscape"
-

orientation

-
-
-
-

pageCount

-
pageCount: number
-

number of pages

-
-
-
-

pages

-
pages: string[]
-

page ids

-
-
-
-

Optional textAlignment

-
textAlignment?: TextAlignment
-

text alignment

-
-
-
-

textScale

-
textScale: number
-

text scale

-
-
-
-

Optional transform

-
transform?: Transform
-

page transform

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +
interface Content {
    coverPageNumber: number;
    documentMetadata?: DocumentMetadata;
    dummyDocument: boolean;
    extraMetadata: ExtraMetadata;
    fileType: FileType;
    fontName?: string;
    formatVersion: number;
    lastOpenedPage: number;
    lineHeight: number;
    margins: number;
    orientation?: "portrait" | "landscape";
    pageCount: number;
    pages: string[];
    textAlignment?: TextAlignment;
    textScale: number;
    transform?: Transform;
}

Properties

coverPageNumber +documentMetadata? +dummyDocument +extraMetadata +fileType +fontName? +formatVersion +lastOpenedPage +lineHeight +margins +orientation? +pageCount +pages +textAlignment? +textScale +transform? +

Properties

coverPageNumber

coverPageNumber: number

number to use for the coverage page, -1 for last opened

+

Optional documentMetadata

documentMetadata?: DocumentMetadata

document metadata

+

dummyDocument

dummyDocument: boolean

is this a dummy document

+

extraMetadata

extraMetadata: ExtraMetadata

extra metadata

+

fileType

fileType: FileType

file type

+

Optional fontName

fontName?: string

font

+

formatVersion

formatVersion: number

format version

+

lastOpenedPage

lastOpenedPage: number

last opened page

+

lineHeight

lineHeight: number

line height

+

margins

margins: number

page margins in points

+

Optional orientation

orientation?: "portrait" | "landscape"

orientation

+

pageCount

pageCount: number

number of pages

+

pages

pages: string[]

page ids

+

Optional textAlignment

textAlignment?: TextAlignment

text alignment

+

textScale

textScale: number

text scale

+

Optional transform

transform?: Transform

page transform

+

Settings

Member Visibility

Theme

On This Page

coverPageNumberdocumentMetadatadummyDocumentextraMetadatafileTypefontNameformatVersionlastOpenedPagelineHeightmarginsorientationpageCountpagestextAlignmenttextScaletransform

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CreateMoveOptions.html b/docs/interfaces/CreateMoveOptions.html index 715a810..9b5ac09 100644 --- a/docs/interfaces/CreateMoveOptions.html +++ b/docs/interfaces/CreateMoveOptions.html @@ -1,130 +1,11 @@ -CreateMoveOptions | rmapi-js
-
- -
-
-
-
- -

Interface CreateMoveOptions

-
-

options for create and +CreateMoveOptions | rmapi-js

Interface CreateMoveOptions

options for create and move

-
-
-
-

Hierarchy

-
    -
  • CreateMoveOptions
-
-
-
- -
-
-

Properties

-
cache? -sync? -
-
-

Properties

-
-

Optional cache

-
cache?: boolean
-

whether to use the last known valid root hash

-
-
-

Default Value

true

-
-
-

Optional sync

-
sync?: boolean
-

whether broadcast syncing complete to other devices

-
-
-

Default Value

true

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +
interface CreateMoveOptions {
    cache?: boolean;
    sync?: boolean;
}

Properties

cache? +sync? +

Properties

Optional cache

cache?: boolean

whether to use the last known valid root hash

+

Default Value

true
+
+

Optional sync

sync?: boolean

whether broadcast syncing complete to other devices

+

Default Value

true
+
+

Settings

Member Visibility

Theme

On This Page

cachesync

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/DocumentMetadata.html b/docs/interfaces/DocumentMetadata.html index d90451e..a9cfe4c 100644 --- a/docs/interfaces/DocumentMetadata.html +++ b/docs/interfaces/DocumentMetadata.html @@ -1,125 +1,6 @@ -DocumentMetadata | rmapi-js
-
- -
-
-
-
- -

Interface DocumentMetadata

-
-

content document metadata

-
-
-
-

Hierarchy

-
    -
  • DocumentMetadata
-
-
-
- -
-
-

Properties

-
authors? -title? -
-
-

Properties

-
-

Optional authors

-
authors?: string[]
-

document authors

-
-
-
-

Optional title

-
title?: string
-

document title

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +DocumentMetadata | rmapi-js

Interface DocumentMetadata

content document metadata

+
interface DocumentMetadata {
    authors?: string[];
    title?: string;
}

Properties

authors? +title? +

Properties

Optional authors

authors?: string[]

document authors

+

Optional title

title?: string

document title

+

Settings

Member Visibility

Theme

On This Page

authorstitle

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/DocumentMetadataEntry.html b/docs/interfaces/DocumentMetadataEntry.html index deb8c65..3200778 100644 --- a/docs/interfaces/DocumentMetadataEntry.html +++ b/docs/interfaces/DocumentMetadataEntry.html @@ -1,272 +1,34 @@ -DocumentMetadataEntry | rmapi-js
-
- -
-
-
-
- -

Interface DocumentMetadataEntry

-
-

the metadata entry for a document

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
deleted? -fileType -hash -id -lastModified -lastOpened? -lastOpenedPage? -metadatamodified? -modified? -parent? -pinned? -synced? -type -version? -visibleName -
-
-

Properties

-
-

Optional deleted

-
deleted?: boolean
-

if file is deleted

-
-
-
-

fileType

-
fileType: FileType
-

the type of the document

-
-
-
-

hash

-
hash: string
-

the hash of the entry

-
-
-
-

id

-
id: string
-

the document id of the entry

-
-
-
-

lastModified

-
lastModified: string
-

last modified time

-
-
-
-

Optional lastOpened

-
lastOpened?: string
-

last opened time for documents

-
-
-
-

Optional lastOpenedPage

-
lastOpenedPage?: number
-

last opened page for documents

-
-
-
-

Optional metadatamodified

-
metadatamodified?: boolean
-

unknown significance

-
-
-
-

Optional modified

-
modified?: boolean
-

unknown significance

-
-
-
-

Optional parent

-
parent?: string
-

parent uuid (documentId) or "" for root or "trash"

-
-
-
-

Optional pinned

-
pinned?: boolean
-

unknown significance

-
-
-
-

Optional synced

-
synced?: boolean
-

unknown significance

-
-
-
-

type

-
type: "DocumentType"
-

the key for document types

-
-
-
-

Optional version

-
version?: number
-

unknown significance

-
-
-
-

visibleName

-
visibleName: string
-

name of content

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +DocumentMetadataEntry | rmapi-js

Interface DocumentMetadataEntry

the metadata entry for a document

+
interface DocumentMetadataEntry {
    createdTime?: string;
    deleted?: boolean;
    fileType: FileType;
    hash: string;
    id: string;
    lastModified?: string;
    lastOpened?: string;
    lastOpenedPage?: number;
    metadatamodified?: boolean;
    modified?: boolean;
    parent?: string;
    pinned?: boolean;
    synced?: boolean;
    type: "DocumentType";
    version?: number;
    visibleName: string;
}

Hierarchy (view full)

Properties

createdTime? +deleted? +fileType +hash +id +lastModified? +lastOpened? +lastOpenedPage? +metadatamodified? +modified? +parent? +pinned? +synced? +type +version? +visibleName +

Properties

Optional createdTime

createdTime?: string

created time

+

Optional deleted

deleted?: boolean

if file is deleted

+

fileType

fileType: FileType

the type of the document

+

hash

hash: string

the hash of the entry

+

id

id: string

the document id of the entry

+

Optional lastModified

lastModified?: string

last modified time

+

Optional lastOpened

lastOpened?: string

last opened time for documents

+

Optional lastOpenedPage

lastOpenedPage?: number

last opened page for documents

+

Optional metadatamodified

metadatamodified?: boolean

unknown significance

+

Optional modified

modified?: boolean

unknown significance

+

Optional parent

parent?: string

parent uuid (documentId) or "" for root or "trash"

+

Optional pinned

pinned?: boolean

unknown significance

+

Optional synced

synced?: boolean

unknown significance

+

type

type: "DocumentType"

the key for document types

+

Optional version

version?: number

unknown significance

+

visibleName

visibleName: string

name of content

+

Settings

Member Visibility

Theme

On This Page

createdTimedeletedfileTypehashidlastModifiedlastOpenedlastOpenedPagemetadatamodifiedmodifiedparentpinnedsyncedtypeversionvisibleName

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/DocumentTypeMetadata.html b/docs/interfaces/DocumentTypeMetadata.html index bc74603..e77a43f 100644 --- a/docs/interfaces/DocumentTypeMetadata.html +++ b/docs/interfaces/DocumentTypeMetadata.html @@ -1,238 +1,28 @@ -DocumentTypeMetadata | rmapi-js
-
- -
-
-
-
- -

Interface DocumentTypeMetadata

-
-

metadata for document types

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
deleted? -lastModified -lastOpened? -lastOpenedPage? -metadatamodified? -modified? -parent? -pinned? -synced? -type -version? -visibleName -
-
-

Properties

-
-

Optional deleted

-
deleted?: boolean
-

if file is deleted

-
-
-
-

lastModified

-
lastModified: string
-

last modified time

-
-
-
-

Optional lastOpened

-
lastOpened?: string
-

last opened time for documents

-
-
-
-

Optional lastOpenedPage

-
lastOpenedPage?: number
-

last opened page for documents

-
-
-
-

Optional metadatamodified

-
metadatamodified?: boolean
-

unknown significance

-
-
-
-

Optional modified

-
modified?: boolean
-

unknown significance

-
-
-
-

Optional parent

-
parent?: string
-

parent uuid (documentId) or "" for root or "trash"

-
-
-
-

Optional pinned

-
pinned?: boolean
-

unknown significance

-
-
-
-

Optional synced

-
synced?: boolean
-

unknown significance

-
-
-
-

type

-
type: "DocumentType"
-

the key for document types

-
-
-
-

Optional version

-
version?: number
-

unknown significance

-
-
-
-

visibleName

-
visibleName: string
-

name of content

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +DocumentTypeMetadata | rmapi-js

Interface DocumentTypeMetadata

metadata for document types

+
interface DocumentTypeMetadata {
    createdTime?: string;
    deleted?: boolean;
    lastModified?: string;
    lastOpened?: string;
    lastOpenedPage?: number;
    metadatamodified?: boolean;
    modified?: boolean;
    parent?: string;
    pinned?: boolean;
    synced?: boolean;
    type: "DocumentType";
    version?: number;
    visibleName: string;
}

Hierarchy (view full)

Properties

createdTime? +deleted? +lastModified? +lastOpened? +lastOpenedPage? +metadatamodified? +modified? +parent? +pinned? +synced? +type +version? +visibleName +

Properties

Optional createdTime

createdTime?: string

created time

+

Optional deleted

deleted?: boolean

if file is deleted

+

Optional lastModified

lastModified?: string

last modified time

+

Optional lastOpened

lastOpened?: string

last opened time for documents

+

Optional lastOpenedPage

lastOpenedPage?: number

last opened page for documents

+

Optional metadatamodified

metadatamodified?: boolean

unknown significance

+

Optional modified

modified?: boolean

unknown significance

+

Optional parent

parent?: string

parent uuid (documentId) or "" for root or "trash"

+

Optional pinned

pinned?: boolean

unknown significance

+

Optional synced

synced?: boolean

unknown significance

+

type

type: "DocumentType"

the key for document types

+

Optional version

version?: number

unknown significance

+

visibleName

visibleName: string

name of content

+

Settings

Member Visibility

Theme

On This Page

createdTimedeletedlastModifiedlastOpenedlastOpenedPagemetadatamodifiedmodifiedparentpinnedsyncedtypeversionvisibleName

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/FetchLike.html b/docs/interfaces/FetchLike.html index 24be119..fc51401 100644 --- a/docs/interfaces/FetchLike.html +++ b/docs/interfaces/FetchLike.html @@ -1,106 +1,3 @@ -FetchLike | rmapi-js
-
- -
-
-
-
- -

Interface FetchLike

-
-

stripped down version of fetch

-
-
-
-

Hierarchy

-
    -
  • FetchLike
-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +FetchLike | rmapi-js

Interface FetchLike

stripped down version of fetch

+
interface FetchLike ((url, options?) => Promise<ResponseLike>)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/FileEntry.html b/docs/interfaces/FileEntry.html index eb21ff4..593c770 100644 --- a/docs/interfaces/FileEntry.html +++ b/docs/interfaces/FileEntry.html @@ -1,155 +1,12 @@ -FileEntry | rmapi-js
-
- -
-
-
-
- -

Interface FileEntry

-
-

a remarkable entry for cloud data

-
-
-
-

Hierarchy

-
    -
  • FileEntry
-
-
-
- -
-
-

Properties

-
documentId -hash -size -subfiles -type -
-
-

Properties

-
-

documentId

-
documentId: string
-

the unique id of the file

-
-
-
-

hash

-
hash: string
-

the hash of the file this points to

-
-
-
-

size

-
size: bigint
-

size of the file

-
-
-
-

subfiles

-
subfiles: 0
-

files don't have subfiles

-
-
-
-

type

-
type: "0"
-

file type

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +FileEntry | rmapi-js

Interface FileEntry

a remarkable entry for cloud data

+
interface FileEntry {
    documentId: string;
    hash: string;
    size: bigint;
    subfiles: 0;
    type: "0";
}

Properties

documentId +hash +size +subfiles +type +

Properties

documentId

documentId: string

the unique id of the file

+

hash

hash: string

the hash of the file this points to

+

size

size: bigint

size of the file

+

subfiles

subfiles: 0

files don't have subfiles

+

type

type: "0"

file type

+

Settings

Member Visibility

Theme

On This Page

documentIdhashsizesubfilestype

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/GetRootHashOptions.html b/docs/interfaces/GetRootHashOptions.html index 8519824..9b0192c 100644 --- a/docs/interfaces/GetRootHashOptions.html +++ b/docs/interfaces/GetRootHashOptions.html @@ -1,117 +1,6 @@ -GetRootHashOptions | rmapi-js
-
- -
-
-
-
- -

Interface GetRootHashOptions

-
-

options for getRootHash

-
-
-
-

Hierarchy

-
    -
  • GetRootHashOptions
-
-
-
- -
-
-

Properties

-
cache? -
-
-

Properties

-
-

Optional cache

-
cache?: boolean
-

whether to use the last known valid root hash

-
-
-

Default Value

true

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +GetRootHashOptions | rmapi-js

Interface GetRootHashOptions

options for getRootHash

+
interface GetRootHashOptions {
    cache?: boolean;
}

Properties

cache? +

Properties

Optional cache

cache?: boolean

whether to use the last known valid root hash

+

Default Value

true
+
+

Settings

Member Visibility

Theme

On This Page

cache

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/HeadersLike.html b/docs/interfaces/HeadersLike.html index fe72c6a..9a6d8ec 100644 --- a/docs/interfaces/HeadersLike.html +++ b/docs/interfaces/HeadersLike.html @@ -1,123 +1,4 @@ -HeadersLike | rmapi-js
-
- -
-
-
-
- -

Interface HeadersLike

-
-

stripped down version of Headers

-
-
-
-

Hierarchy

-
    -
  • HeadersLike
-
-
-
- -
-
-

Methods

-
get -
-
-

Methods

-
-

get

-
    - -
  • -

    get a specific header value

    -
    -
    -

    Parameters

    -
      -
    • -
      key: string
    -

    Returns null | string

    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +HeadersLike | rmapi-js

Interface HeadersLike

stripped down version of Headers

+
interface HeadersLike {
    get(key): null | string;
}

Methods

get +

Methods

get

Settings

Member Visibility

Theme

On This Page

get

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PutEpubOptions.html b/docs/interfaces/PutEpubOptions.html index cdaf9b1..8f5055c 100644 --- a/docs/interfaces/PutEpubOptions.html +++ b/docs/interfaces/PutEpubOptions.html @@ -1,195 +1,20 @@ -PutEpubOptions | rmapi-js
-
- -
-
-
-
- -

Interface PutEpubOptions

-
-

options for uploading an epub document

-
-
-
-

Hierarchy

-
    -
  • PutEpubOptions
-
-
-
- -
-
-

Properties

-
cover? -fontName? -lastTool? -lineHeight? -margins? -orientation? -parent? -textAlignment? -textScale? -
-
-

Properties

-
-

Optional cover

-
cover?: "first" | "visited"
-

which page should be shone as the cover

-
-
-
-

Optional fontName

-
fontName?: string
-

the font name, should probably come from builtinFontNames

-
-
-
-

Optional lastTool

-
lastTool?: string
-

the tool to have enabled by default

-
-
-
-

Optional lineHeight

-
lineHeight?: number | "md" | "lg" | "df" | "xl"
-

the height of lines

-
-
-
-

Optional margins

-
margins?: number | "sm" | "md" | "rr" | "lg"
-

the margins of the epub 180 is good for articles, 125 for books

-
-
-
-

Optional orientation

-
orientation?: "portrait" | "landscape"
-

the page orientation

-
-
-
-

Optional parent

-
parent?: string
-

the parent id, default to root

-
-
-
-

Optional textAlignment

-
textAlignment?: TextAlignment
-

the text alignment

-
-
-
-

Optional textScale

-
textScale?: number | "sm" | "md" | "lg" | "xl" | "xs" | "xx"
-

the scale of text

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +PutEpubOptions | rmapi-js

Interface PutEpubOptions

options for uploading an epub document

+
interface PutEpubOptions {
    cover?: "first" | "visited";
    fontName?: string;
    lastTool?: string;
    lineHeight?: number | "md" | "lg" | "df" | "xl";
    margins?: number | "sm" | "md" | "rr" | "lg";
    orientation?: "portrait" | "landscape";
    parent?: string;
    textAlignment?: TextAlignment;
    textScale?: number | "sm" | "md" | "lg" | "xl" | "xs" | "xx";
}

Properties

cover? +fontName? +lastTool? +lineHeight? +margins? +orientation? +parent? +textAlignment? +textScale? +

Properties

Optional cover

cover?: "first" | "visited"

which page should be shone as the cover

+

Optional fontName

fontName?: string

the font name, should probably come from builtinFontNames

+

Optional lastTool

lastTool?: string

the tool to have enabled by default

+

Optional lineHeight

lineHeight?: number | "md" | "lg" | "df" | "xl"

the height of lines

+

Optional margins

margins?: number | "sm" | "md" | "rr" | "lg"

the margins of the epub 180 is good for articles, 125 for books

+

Optional orientation

orientation?: "portrait" | "landscape"

the page orientation

+

Optional parent

parent?: string

the parent id, default to root

+

Optional textAlignment

textAlignment?: TextAlignment

the text alignment

+

Optional textScale

textScale?: number | "sm" | "md" | "lg" | "xl" | "xs" | "xx"

the scale of text

+

Settings

Member Visibility

Theme

On This Page

coverfontNamelastToollineHeightmarginsorientationparenttextAlignmenttextScale

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PutPdfOptions.html b/docs/interfaces/PutPdfOptions.html index 5e76aeb..f059cf7 100644 --- a/docs/interfaces/PutPdfOptions.html +++ b/docs/interfaces/PutPdfOptions.html @@ -1,145 +1,10 @@ -PutPdfOptions | rmapi-js
-
- -
-
-
-
- -

Interface PutPdfOptions

-
-

options for uploading a pdf

-
-
-
-

Hierarchy

-
    -
  • PutPdfOptions
-
-
-
- -
-
-

Properties

-
cover? -lastTool? -orientation? -parent? -
-
-

Properties

-
-

Optional cover

-
cover?: "first" | "visited"
-

which page should be shone as the cover

-
-
-
-

Optional lastTool

-
lastTool?: string
-

the tool to have enabled by default

-
-
-
-

Optional orientation

-
orientation?: "portrait" | "landscape"
-

the page orientation

-
-
-
-

Optional parent

-
parent?: string
-

the parent id, default to root

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +PutPdfOptions | rmapi-js

Interface PutPdfOptions

options for uploading a pdf

+
interface PutPdfOptions {
    cover?: "first" | "visited";
    lastTool?: string;
    orientation?: "portrait" | "landscape";
    parent?: string;
}

Properties

cover? +lastTool? +orientation? +parent? +

Properties

Optional cover

cover?: "first" | "visited"

which page should be shone as the cover

+

Optional lastTool

lastTool?: string

the tool to have enabled by default

+

Optional orientation

orientation?: "portrait" | "landscape"

the page orientation

+

Optional parent

parent?: string

the parent id, default to root

+

Settings

Member Visibility

Theme

On This Page

coverlastToolorientationparent

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/RegisterOptions.html b/docs/interfaces/RegisterOptions.html index a62be56..25dbd90 100644 --- a/docs/interfaces/RegisterOptions.html +++ b/docs/interfaces/RegisterOptions.html @@ -1,147 +1,12 @@ -RegisterOptions | rmapi-js
-
- -
-
-
-
- -

Interface RegisterOptions

-
-

options for registering with the api

-
-
-
-

Hierarchy

-
    -
  • RegisterOptions
-
-
-
- -
-
-

Properties

-
authHost? -deviceDesc? -fetch? -uuid? -
-
-

Properties

-
-

Optional authHost

-
authHost?: string
-

The host to use for authorization requests

-
-
-
-

Optional deviceDesc

-
deviceDesc?: "desktop-windows" | "desktop-macos" | "desktop-linux" | "mobile-android" | "mobile-ios" | "browser-chrome" | "remarkable"
-

the device description to use

+RegisterOptions | rmapi-js

Interface RegisterOptions

options for registering with the api

+
interface RegisterOptions {
    authHost?: string;
    deviceDesc?: "desktop-windows" | "desktop-macos" | "desktop-linux" | "mobile-android" | "mobile-ios" | "browser-chrome" | "remarkable";
    fetch?: FetchLike;
    uuid?: string;
}

Properties

authHost? +deviceDesc? +fetch? +uuid? +

Properties

Optional authHost

authHost?: string

The host to use for authorization requests

+

Optional deviceDesc

deviceDesc?: "desktop-windows" | "desktop-macos" | "desktop-linux" | "mobile-android" | "mobile-ios" | "browser-chrome" | "remarkable"

the device description to use

Using an improper one will results in the registration being rejected.

-
-
-
-

Optional fetch

-
fetch?: FetchLike
-

a function for making fetch requests, see fetch for more info

-
-
-
-

Optional uuid

-
uuid?: string
-

the unique id of this device

+

Optional fetch

fetch?: FetchLike

a function for making fetch requests, see RemarkableOptions.fetch for more info

+

Optional uuid

uuid?: string

the unique id of this device

If omitted it will be randomly generated

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

authHostdeviceDescfetchuuid

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/RemarkableApi.html b/docs/interfaces/RemarkableApi.html index eb2c64e..bc4a310 100644 --- a/docs/interfaces/RemarkableApi.html +++ b/docs/interfaces/RemarkableApi.html @@ -1,88 +1,36 @@ -RemarkableApi | rmapi-js
-
- -
-
-
-
- -

Interface RemarkableApi

-
-

the api for accessing remarkable functions

-
-
-
-

Hierarchy

-
    -
  • RemarkableApi
-
-
-
- -
-
-

Methods

-
create -getBuffer -getCache -getEntries -getEntriesMetadata -getJson -getMetadata -getRootHash -getText -move -putBuffer -putCollection -putEntries -putEpub -putJson -putMetadata -putPdf -putRootHash -putText -syncComplete -uploadEpub -uploadPdf -
-
-

Methods

-
-

create

-
    - -
  • -

    high level api to create an entry

    +RemarkableApi | rmapi-js

    Interface RemarkableApi

    the api for accessing remarkable functions

    +
    interface RemarkableApi {
        create(entry, options?): Promise<boolean>;
        getBuffer(hash): Promise<ArrayBuffer>;
        getCache(): Promise<Map<string, ArrayBuffer>>;
        getEntries(hash?): Promise<Entry[]>;
        getEntriesMetadata(): Promise<MetadataEntry[]>;
        getJson(hash): Promise<unknown>;
        getMetadata(hash): Promise<Metadata>;
        getRootHash(options?): Promise<[string, bigint]>;
        getText(hash): Promise<string>;
        move(documentId, dest, opts?): Promise<boolean>;
        putBuffer(documentId, buffer): Promise<FileEntry>;
        putCollection(visibleName, parent?): Promise<CollectionEntry>;
        putEntries(documentId, entries): Promise<CollectionEntry>;
        putEpub(visibleName, buffer, opts?): Promise<CollectionEntry>;
        putJson(documentId, contents): Promise<FileEntry>;
        putMetadata(documentId, metadata): Promise<FileEntry>;
        putPdf(visibleName, buffer, opts?): Promise<CollectionEntry>;
        putRootHash(hash, generation): Promise<bigint>;
        putText(documentId, contents): Promise<FileEntry>;
        syncComplete(generation): Promise<void>;
        uploadEpub(visibleName, buffer): Promise<UploadEntry>;
        uploadPdf(visibleName, buffer): Promise<UploadEntry>;
    }

    Methods

    create +getBuffer +getCache +getEntries +getEntriesMetadata +getJson +getMetadata +getRootHash +getText +move +putBuffer +putCollection +putEntries +putEpub +putJson +putMetadata +putPdf +putRootHash +putText +syncComplete +uploadEpub +uploadPdf +

    Methods

    create

    • create(entry, options?): Promise<boolean>

    • high level api to create an entry

      After creating a collection entry with putCollection, putEpub, or putPdf, this is a high level API to try syncing the change to the remarkable.

      -
      -
      -

      Parameters

      -
      -

      Returns Promise<boolean>

      synced - if sync was successful

      - -
      -

      Remarks

      This API is provided to give a high level interface and to serve as an +

      Parameters

      Returns Promise<boolean>

      synced - if sync was successful

      +

      Remarks

      This API is provided to give a high level interface and to serve as an example of how to implement more advanced functionality, but it comes with a number of caveats:

        @@ -95,177 +43,37 @@

        Remarks

        This API is provided to give a high level interface and to se

        However, with recent changes in the way this library caches results, it won't be terribly inefficient to just do multiple retries of create after uploading the file itself.

        -

        Example

        const entry = await api.putEpub(...);
        await api.create(entry);
        -

        Throws

        error - if any error occurred, in this case, nothing will be changed

        -
    -
    -

    getBuffer

    -
      - -
    • -

      get array buffer associated with a hash

      -
      -
      -

      Parameters

      -
        -
      • -
        hash: string
        -

        the hash to get text data from

        -
        -
      -

      Returns Promise<ArrayBuffer>

      -
    -
    -

    getCache

    -

    getBuffer

    • getBuffer(hash): Promise<ArrayBuffer>

    • get array buffer associated with a hash

      +

      Parameters

      • hash: string

        the hash to get text data from

        +

      Returns Promise<ArrayBuffer>

    getCache

    • getCache(): Promise<Map<string, ArrayBuffer>>

    • get the current state of the cache for persisting

      This won't include items that weren't cached because they were too big, meaning it won't prevent duplicate puts of large content across sessions.

      -
      -

      Returns Promise<Map<string, ArrayBuffer>>

      -
    -
    -

    getEntries

    -

    getEntries

    • getEntries(hash?): Promise<Entry[]>

    • get entries from a collection hash

      If omitted, this will use getRootHash().

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional hash: string
      -

      Returns Promise<Entry[]>

      -
    -
    -

    getEntriesMetadata

    -

    getEntriesMetadata

    • getEntriesMetadata(): Promise<MetadataEntry[]>

    • get metadata on all entries

      +

      Returns Promise<MetadataEntry[]>

      Remarks

      this uses a newer api, that returns metadata associated with all entries and their hash and documentId.

      -
    -
    -

    getJson

    -

    getJson

    • getJson(hash): Promise<unknown>

    • get a json object associated with a hash

      This is identical to getText(hash).then(JSON.parse) and is only provided for consistency with putJson.

      -
      -
      -

      Parameters

      -
        -
      • -
        hash: string
      -

      Returns Promise<unknown>

      -
    -
    -

    getMetadata

    -
    -
    -

    getRootHash

    -
      - -
    • -

      get the root hash and the current generation

      +

      Parameters

      • hash: string

      Returns Promise<unknown>

    getMetadata

    getRootHash

    • getRootHash(options?): Promise<[string, bigint]>

    • get the root hash and the current generation

      If this hasn't changed, then neither have any of the files.

      -
      -
      -

      Parameters

      -
      -

      Returns Promise<[string, bigint]>

      -
    -
    -

    getText

    -
      - -
    • -

      get text content associated with hash

      -
      -
      -

      Parameters

      -
        -
      • -
        hash: string
        -

        the hash to get text data from

        -
        -
      -

      Returns Promise<string>

      -
    -
    -

    move

    -

    getText

    • getText(hash): Promise<string>

    • get text content associated with hash

      +

      Parameters

      • hash: string

        the hash to get text data from

        +

      Returns Promise<string>

    move

    • move(documentId, dest, opts?): Promise<boolean>

    • high level api to move a document / collection

      Use this as a high level api to move files in the document tree.

      -
      -
      -

      Parameters

      -
        -
      • -
        documentId: string
        -

        the document id of the document or collection to move

        -
        -
        • -
      • -
        dest: string
        -

        the new parent of this collection or document; this should +

        Parameters

        • documentId: string

          the document id of the document or collection to move

          +
        • dest: string

          the new parent of this collection or document; this should be the document id of an existing collection, an empty string for root, or the string "trash" to move to the trash

          -
          -
          • -
        • -
          Optional opts: CreateMoveOptions
        -

        Returns Promise<boolean>

        synced - true if synced successfully

        - -
        -

        Remarks

        This API is provided to give a high level interface and to serve as an +

      • Optional opts: CreateMoveOptions

        any extra options for moving

        +

      Returns Promise<boolean>

      synced - true if synced successfully

      +

      Remarks

      This API is provided to give a high level interface and to serve as an example of how to implement more advanced functionality, but it comes with a number of caveats:

        @@ -277,426 +85,86 @@

        Remarks

        This API is provided to give a high level interface and to se

      However, with changes to the way this caches results, it won't be terribly inefficient to just retry calling move if there's a failure.

      -

      Example

      const [root] = await api.getRootHash();
      const entries = await api.getEntries(root);
      const { documentId } = entries.find(...);
      await api.move(documentId, "trash");
      -

      Throws

      error - if any error occurred, in this case, nothing will be changed

      -
    -
    -

    putBuffer

    -
      - -
    • -

      put a raw buffer in the cloud

      -
      -
      -

      Parameters

      -
        -
      • -
        documentId: string
        • -
      • -
        buffer: ArrayBuffer
      -

      Returns Promise<FileEntry>

      -
    -
    -

    putCollection

    -
      - -
    • -

      create a new collection (folder)

      -
      -
      -

      Parameters

      -
        -
      • -
        visibleName: string
        • -
      • -
        Optional parent: string
        -

        the documentId of the parent collection (folder)

        -
        -
      -

      Returns Promise<CollectionEntry>

      -
    -
    -

    putEntries

    -
    -
    -

    putEpub

    -
      - -
    • -

      upload an epub

      -
      -
      -

      Parameters

      -
        -
      • -
        visibleName: string
        -

        the name to show for the uploaded epub

        -
        -
        • -
      • -
        buffer: ArrayBuffer
        -

        the epub contents

        -
        -
        • -
      • -
        Optional opts: PutEpubOptions
        -

        extra options you can specify at upload

        -
        -
      -

      Returns Promise<CollectionEntry>

      -
      -

      Remarks

      this only uploads the raw data and returns an entry that could be +

    putBuffer

    putCollection

    putEntries

    putEpub

    • putEpub(visibleName, buffer, opts?): Promise<CollectionEntry>

    • upload an epub

      +

      Parameters

      • visibleName: string

        the name to show for the uploaded epub

        +
      • buffer: ArrayBuffer

        the epub contents

        +
      • Optional opts: PutEpubOptions

        extra options you can specify at upload

        +

      Returns Promise<CollectionEntry>

      Remarks

      this only uploads the raw data and returns an entry that could be uploaded as part of a larger collection. To make sure devices know about it, you'll still need to update the root hash, and potentially notify other devices.

      -

      Example

      This example shows a full process upload. Note that it may fail if other devices are simultaneously syncing content. See putRootHash for more information.

      const entry = await api.putEpub(...);
      await api.create(entry);
      -
    -
    -

    putJson

    -

    putJson

    • putJson(documentId, contents): Promise<FileEntry>

    • put json into the cloud

      This uses a stable (sorted keys) json serilization to preserve consistent hashes.

      -
      -
      -

      Parameters

      -
        -
      • -
        documentId: string
        • -
      • -
        contents: object
      -

      Returns Promise<FileEntry>

      -
    -
    -

    putMetadata

    -

    putMetadata

    • putMetadata(documentId, metadata): Promise<FileEntry>

    • put metadata into the cloud

      This is a small wrapper around putText.

      -
      -
      -

      Parameters

      -
        -
      • -
        documentId: string
        -

        this should be the documentId of the item that this is +

        Parameters

        • documentId: string

          this should be the documentId of the item that this is metadata for; it should not end in .metadata

          -
          -
          • -
        • -
          metadata: Metadata
          -

          the metadata to upload

          -
          -
        -

        Returns Promise<FileEntry>

        -
    -
    -

    putPdf

    -
      - -
    • -

      upload a pdf

      -
      -
      -

      Parameters

      -
        -
      • -
        visibleName: string
        -

        the name to show for the uploaded pdf

        -
        -
        • -
      • -
        buffer: ArrayBuffer
        -

        the pdf contents

        -
        -
        • -
      • -
        Optional opts: PutPdfOptions
        -

        extra options you can specify at upload

        -
        -
      -

      Returns Promise<CollectionEntry>

      -
      -

      Remarks

      this only uploads the raw data and returns an entry that could be +

    • metadata: Metadata

      the metadata to upload

      +

    Returns Promise<FileEntry>

putPdf

  • putPdf(visibleName, buffer, opts?): Promise<CollectionEntry>

  • upload a pdf

    +

    Parameters

    • visibleName: string

      the name to show for the uploaded pdf

      +
    • buffer: ArrayBuffer

      the pdf contents

      +
    • Optional opts: PutPdfOptions

      extra options you can specify at upload

      +

    Returns Promise<CollectionEntry>

    Remarks

    this only uploads the raw data and returns an entry that could be uploaded as part of a larger collection. To make sure devices know about it, you'll still need to update the root hash, and potentially notify other devices.

    -

    Example

    This example shows a full process upload. Note that it may fail if other devices are simultaneously syncing content. See putRootHash for more information.

    const entry = await api.putPdf(...);
    await api.create(entry);
    -
-
-

putRootHash

-

putRootHash

  • putRootHash(hash, generation): Promise<bigint>

  • write the root hash, incrimenting from the current generation

    This will fail if the current generation isn't equal to the passed in generation. Use this to preven race conditions. If this rejects, refetch the root hash, resync the updates, and then try to put again.

    -
    -
    -

    Parameters

    -
      -
    • -
      hash: string
      -

      the hash of the new root collection

      -
      -
      • -
    • -
      generation: bigint
      -

      the current generation this builds off of

      -
      -
    -

    Returns Promise<bigint>

    the new generation

    - -
    -

    Remarks

    Updating the root hash can be dangerous as it changes the full +

    Parameters

    • hash: string

      the hash of the new root collection

      +
    • generation: bigint

      the current generation this builds off of

      +

    Returns Promise<bigint>

    the new generation

    +

    Remarks

    Updating the root hash can be dangerous as it changes the full state of what's on the the remarkable. However, it's also the only way to change what's actually visible. If you're unsure if you're doing the right thing, make sure to first save your inital root hash. Then you can always recover by doing:

    let [, gen] = await api.getRootHash();
    await api.putRootHash(backup, gen);
    -

    Throws

    GenerationError if the current cloud generation didn't match the expected pushed generation.

    -
-
-

putText

-

putText

  • putText(documentId, contents): Promise<FileEntry>

  • put a raw text in the cloud encoded as utf-8

    this is no different than using putBuffer(..., new TextEncoder().encode(contents))

    -
    -
    -

    Parameters

    -
      -
    • -
      documentId: string
      • -
    • -
      contents: string
    -

    Returns Promise<FileEntry>

    -
-
-

syncComplete

-
    - -
  • -

    indicate that a sync is complete and push updates to other devices

    -
    -
    -

    Parameters

    -
      -
    • -
      generation: bigint
    -

    Returns Promise<void>

    -
    -

    Remarks

    after successfully putting a new root hash, use this to indicate +

    Parameters

    • documentId: string
    • contents: string

    Returns Promise<FileEntry>

syncComplete

  • syncComplete(generation): Promise<void>

  • indicate that a sync is complete and push updates to other devices

    +

    Parameters

    • generation: bigint

    Returns Promise<void>

    Remarks

    after successfully putting a new root hash, use this to indicate that other devices should pick up the change.

    -
-
-

uploadEpub

-
    - -
  • -

    upload an epub

    -
    -
    -

    Parameters

    -
      -
    • -
      visibleName: string
      -

      the name to show for the uploaded epub

      -
      -
      • -
    • -
      buffer: ArrayBuffer
      -

      the epub contents

      -
      -
    -

    Returns Promise<UploadEntry>

    -
    -

    Remarks

    this uses a newer api that performs a full upload and sync, but +

uploadEpub

  • uploadEpub(visibleName, buffer): Promise<UploadEntry>

  • upload an epub

    +

    Parameters

    • visibleName: string

      the name to show for the uploaded epub

      +
    • buffer: ArrayBuffer

      the epub contents

      +

    Returns Promise<UploadEntry>

    Remarks

    this uses a newer api that performs a full upload and sync, but doesn't allow adding the same level of extra content data. Useful if you just want to upload a document with no fuss.

    -

    Example

    await api.uploadEpub("My EPub", ...);
    -
-
-

uploadPdf

-

uploadPdf

  • uploadPdf(visibleName, buffer): Promise<UploadEntry>
  • Experimental

    upload a pdf

    this currently uploads invalid pdfs, but it's not clear why, which is why this is marked as experimental. Potentially some tweak in the formatting of buffer will fix it.

    -
    -
    -

    Parameters

    -
      -
    • -
      visibleName: string
      -

      the name to show for the uploaded epub

      -
      -
      • -
    • -
      buffer: ArrayBuffer
      -

      the epub contents

      -
      -
    -

    Returns Promise<UploadEntry>

    -
    -

    Remarks

    this uses a newer api that performs a full upload and sync, but +

    Parameters

    • visibleName: string

      the name to show for the uploaded epub

      +
    • buffer: ArrayBuffer

      the epub contents

      +

    Returns Promise<UploadEntry>

    Remarks

    this uses a newer api that performs a full upload and sync, but doesn't allow adding the same level of extra information.

    -

    Example

    await api.uploadPdf("My PDF", ...);
    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

creategetBuffergetCachegetEntriesgetEntriesMetadatagetJsongetMetadatagetRootHashgetTextmoveputBufferputCollectionputEntriesputEpubputJsonputMetadataputPdfputRootHashputTextsyncCompleteuploadEpubuploadPdf

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/RemarkableOptions.html b/docs/interfaces/RemarkableOptions.html index 7d9fa71..85ce726 100644 --- a/docs/interfaces/RemarkableOptions.html +++ b/docs/interfaces/RemarkableOptions.html @@ -1,192 +1,41 @@ -RemarkableOptions | rmapi-js
-
- -
-
-
-
- -

Interface RemarkableOptions

-
-

options for a remarkable instance

-
-
-
-

Hierarchy

-
    -
  • RemarkableOptions
-
-
-
- -
-
-

Properties

-
authHost? -cacheLimitBytes? -fetch? -initCache? -subtle? -syncHost? -
-
-

Properties

-
-

Optional authHost

-
authHost?: string
-

the url for making authorization requests

-
-
-

Default Value

"https://webapp-prod.cloud.remarkable.engineering"

-
-
-

Optional cacheLimitBytes

-
cacheLimitBytes?: number
-

the maximum size in bytes to cache the value of a stored object

+RemarkableOptions | rmapi-js

Interface RemarkableOptions

options for a remarkable instance

+
interface RemarkableOptions {
    authHost?: string;
    cacheLimitBytes?: number;
    fetch?: FetchLike;
    initCache?: Iterable<readonly [string, ArrayBuffer]>;
    subtle?: SubtleCryptoLike;
    syncHost?: string;
}

Properties

authHost? +cacheLimitBytes? +fetch? +initCache? +subtle? +syncHost? +

Properties

Optional authHost

authHost?: string

the url for making authorization requests

+

Default Value

"https://webapp-prod.cloud.remarkable.engineering"
+
+

Optional cacheLimitBytes

cacheLimitBytes?: number

the maximum size in bytes to cache the value of a stored object

Since the remarkableApi is based around hashes, the value of a hash should never change (barring collisions in ASH256). Any known hash value that's less than this amount will be cached locally to prevent future network requests. In addition, all successful puts and gets will be cached to prevent duplicate puts in the future.

To save memory and disable fetch caching, set to 0.

-
-
-

Default Value

1 MiB

-
-
-

Optional fetch

-
fetch?: FetchLike
-

the fetch method to use

+

Default Value

1 MiB
+
+

Optional fetch

fetch?: FetchLike

the fetch method to use

This should loosely conform to the WHATWG fetch, but is relaxed enough that node-fetch also works. This will default to the global definitions of fetch.

In node you can either use "node-fetch", or node --experimental-fetch for node 17.5 or higher.

-
-
-

Default Value

globalThis.fetch

-
-
-

Optional initCache

-
initCache?: Iterable<readonly [string, ArrayBuffer]>
-

a set of values to use to initialize the cache

+

Default Value

globalThis.fetch
+
+

Optional initCache

initCache?: Iterable<readonly [string, ArrayBuffer]>

a set of values to use to initialize the cache

If this is inaccurate, then you could encounter errors with other methods. Often this will come from getCache.

-
-
-
-

Optional subtle

-
subtle?: SubtleCryptoLike
-

a subtle-crypto-like object

+

Optional subtle

subtle?: SubtleCryptoLike

a subtle-crypto-like object

This should have a digest function like the api of crypto.subtle, it's default value. In node try import { webcrypto } from "crypto"; global.crypto = webcrypto or pass in webcrypto.subtle.

-
-
-

Default Value

globalThis.crypto.subtle

-
-
-

Optional syncHost

-
syncHost?: string
-

the url for making synchronization requests

-
-
-

Default Value

"https://internal.cloud.remarkable.com"

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Default Value

globalThis.crypto.subtle
+
+

Optional syncHost

syncHost?: string

the url for making synchronization requests

+

Default Value

"https://internal.cloud.remarkable.com"
+
+

Settings

Member Visibility

Theme

On This Page

authHostcacheLimitBytesfetchinitCachesubtlesyncHost

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/RequestInitLike.html b/docs/interfaces/RequestInitLike.html index 6ba117b..6cc7809 100644 --- a/docs/interfaces/RequestInitLike.html +++ b/docs/interfaces/RequestInitLike.html @@ -1,135 +1,8 @@ -RequestInitLike | rmapi-js
-
- -
-
-
-
- -

Interface RequestInitLike

-
-

stripped down version of RequestInit

-
-
-
-

Hierarchy

-
    -
  • RequestInitLike
-
-
-
- -
-
-

Properties

-
body? -headers? -method? -
-
-

Properties

-
-

Optional Readonly body

-
body?: string | ArrayBuffer
-

request body

-
-
-
-

Optional Readonly headers

-
headers?: Record<string, string>
-

request headers

-
-
-
-

Optional Readonly method

-
method?: RequestMethod
-

request method

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +RequestInitLike | rmapi-js

Interface RequestInitLike

stripped down version of RequestInit

+
interface RequestInitLike {
    body?: string | ArrayBuffer;
    headers?: Record<string, string>;
    method?: RequestMethod;
}

Properties

body? +headers? +method? +

Properties

Optional Readonly body

body?: string | ArrayBuffer

request body

+

Optional Readonly headers

headers?: Record<string, string>

request headers

+

Optional Readonly method

method?: RequestMethod

request method

+

Settings

Member Visibility

Theme

On This Page

bodyheadersmethod

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ResponseLike.html b/docs/interfaces/ResponseLike.html index 755f500..a5d7e2e 100644 --- a/docs/interfaces/ResponseLike.html +++ b/docs/interfaces/ResponseLike.html @@ -1,176 +1,14 @@ -ResponseLike | rmapi-js
-
- -
-
-
-
- -

Interface ResponseLike

-
-

stripped down version of Response

-
-
-
-

Hierarchy

-
    -
  • ResponseLike
-
-
-
- -
-
-

Properties

-
headers -ok -status -statusText -
-
-

Methods

-
arrayBuffer -text -
-
-

Properties

-
-

headers

-
headers: HeadersLike
-

headers in response

-
-
-
-

ok

-
ok: boolean
-

true if request was successful

-
-
-
-

status

-
status: number
-

http status

-
-
-
-

statusText

-
statusText: string
-

text associated with status

-
-
-
-

Methods

-
-

arrayBuffer

-
    - -
  • -

    get response body as an array buffer

    -
    -

    Returns Promise<ArrayBuffer>

    -
-
-

text

-
    - -
  • -

    get response body as text

    -
    -

    Returns Promise<string>

    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +ResponseLike | rmapi-js

Interface ResponseLike

stripped down version of Response

+
interface ResponseLike {
    headers: HeadersLike;
    ok: boolean;
    status: number;
    statusText: string;
    arrayBuffer(): Promise<ArrayBuffer>;
    text(): Promise<string>;
}

Properties

headers +ok +status +statusText +

Methods

arrayBuffer +text +

Properties

headers

headers: HeadersLike

headers in response

+

ok

ok: boolean

true if request was successful

+

status

status: number

http status

+

statusText

statusText: string

text associated with status

+

Methods

arrayBuffer

text

Settings

Member Visibility

Theme

On This Page

headersokstatusstatusTextarrayBuffertext

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SubtleCryptoLike.html b/docs/interfaces/SubtleCryptoLike.html index 4f370b6..c269117 100644 --- a/docs/interfaces/SubtleCryptoLike.html +++ b/docs/interfaces/SubtleCryptoLike.html @@ -1,125 +1,4 @@ -SubtleCryptoLike | rmapi-js
-
- -
-
-
-
- -

Interface SubtleCryptoLike

-
-

stripped down version of subtle crypto

-
-
-
-

Hierarchy

-
    -
  • SubtleCryptoLike
-
-
-
- -
-
-

Methods

-
digest -
-
-

Methods

-
-

digest

-
    - -
  • -

    a digest function

    -
    -
    -

    Parameters

    -
      -
    • -
      algorithm: "SHA-256"
      • -
    • -
      data: ArrayBuffer
    -

    Returns Promise<ArrayBuffer>

    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +SubtleCryptoLike | rmapi-js

Interface SubtleCryptoLike

stripped down version of subtle crypto

+
interface SubtleCryptoLike {
    digest(algorithm, data): Promise<ArrayBuffer>;
}

Methods

digest +

Methods

digest

  • digest(algorithm, data): Promise<ArrayBuffer>

  • a digest function

    +

    Parameters

    • algorithm: "SHA-256"
    • data: ArrayBuffer

    Returns Promise<ArrayBuffer>

Settings

Member Visibility

Theme

On This Page

digest

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/UploadEntry.html b/docs/interfaces/UploadEntry.html index c0dcb9c..7cef5d2 100644 --- a/docs/interfaces/UploadEntry.html +++ b/docs/interfaces/UploadEntry.html @@ -1,125 +1,6 @@ -UploadEntry | rmapi-js
-
- -
-
-
-
- -

Interface UploadEntry

-
-

an simple entry produced by the upload api

-
-
-
-

Hierarchy

-
    -
  • UploadEntry
-
-
-
- -
-
-

Properties

-
docID -hash -
-
-

Properties

-
-

docID

-
docID: string
-

the document id

-
-
-
-

hash

-
hash: string
-

the document hash

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +UploadEntry | rmapi-js

Interface UploadEntry

an simple entry produced by the upload api

+
interface UploadEntry {
    docID: string;
    hash: string;
}

Properties

docID +hash +

Properties

docID

docID: string

the document id

+

hash

hash: string

the document hash

+

Settings

Member Visibility

Theme

On This Page

docIDhash

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index d8729d7..bc4c294 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,155 +1,55 @@ -rmapi-js
-
- -
-
-
-
-

rmapi-js

-
-

Create and interact with reMarkable cloud.

+rmapi-js

rmapi-js

Create and interact with reMarkable cloud.

After getting a device token with the register method, persist it and create api instances using remarkable. Outside of registration, all relevant methods are in RemarkableApi.

-
-
-

Example

A simple fetch

+

Example

A simple fetch

import { register, remarkable } from "rmapi-js";

const code = "..."  // eight letter code from https://my.remarkable.com/device/browser/connect
const token = await register(code)
// persist token
const api = await remarkable(token);
const rootEntries = await api.getEntries();
for (const entry of rootEntries) {
  const children = await api.getEntries(entry.hash);
  for (const { hash, documentId } of children) {
    if (documentId.endsWith(".metadata")) {
      const meta = api.getMetadata(hash);
      // get metadata for entry
      console.log(meta);
    }
  }
}
-

Example

A simple upload

import { remarkable } from "rmapi-js";

const api = await remarkable(...);
const entry = await api.putEpub("document name", epubBuffer);
await api.create(entry);
-
-
-
-

Index

-
-

Classes

-
GenerationError -ResponseError -
-
-

Interfaces

-
BaseMetadataEntry -CacheLike -CollectionEntry -CollectionMetadataEntry -CollectionTypeMetadata -CommonMetadata -Content -CreateMoveOptions -DocumentMetadata -DocumentMetadataEntry -DocumentTypeMetadata -FetchLike -FileEntry -GetRootHashOptions -HeadersLike -PutEpubOptions -PutPdfOptions -RegisterOptions -RemarkableApi -RemarkableOptions -RequestInitLike -ResponseLike -SubtleCryptoLike -UploadEntry -
-
-

Type Aliases

-
Entry -ExtraMetadata -FileType -Metadata -MetadataEntry -RequestMethod -TextAlignment -Transform -
-
-

Variables

-
builtinFontNames -builtinLineHeights -builtinMargins -builtinTextScales -builtinTools -
-
-

Functions

-
formatEntry -parseEntry -register -remarkable -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Index

Classes

GenerationError +ResponseError +

Interfaces

BaseMetadataEntry +CacheLike +CollectionEntry +CollectionMetadataEntry +CollectionTypeMetadata +CommonMetadata +Content +CreateMoveOptions +DocumentMetadata +DocumentMetadataEntry +DocumentTypeMetadata +FetchLike +FileEntry +GetRootHashOptions +HeadersLike +PutEpubOptions +PutPdfOptions +RegisterOptions +RemarkableApi +RemarkableOptions +RequestInitLike +ResponseLike +SubtleCryptoLike +UploadEntry +

Type Aliases

Entry +ExtraMetadata +FileType +Metadata +MetadataEntry +RequestMethod +TextAlignment +Transform +

Variables

builtinFontNames +builtinLineHeights +builtinMargins +builtinTextScales +builtinTools +

Functions

formatEntry +parseEntry +register +remarkable +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/Entry.html b/docs/types/Entry.html index ddfc2ad..7fce0a1 100644 --- a/docs/types/Entry.html +++ b/docs/types/Entry.html @@ -1,87 +1,2 @@ -Entry | rmapi-js
-
- -
-
-
-
- -

Type alias Entry

-
Entry: CollectionEntry | FileEntry
-

a remarkable entry for cloud items

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +Entry | rmapi-js

Type alias Entry

Entry: CollectionEntry | FileEntry

a remarkable entry for cloud items

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ExtraMetadata.html b/docs/types/ExtraMetadata.html index f8dfc99..4a93397 100644 --- a/docs/types/ExtraMetadata.html +++ b/docs/types/ExtraMetadata.html @@ -1,87 +1,2 @@ -ExtraMetadata | rmapi-js
-
- -
-
-
-
- -

Type alias ExtraMetadata

-
ExtraMetadata: Record<string, string | undefined>
-

extra content metadata

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +ExtraMetadata | rmapi-js

Type alias ExtraMetadata

ExtraMetadata: Record<string, string | undefined>

extra content metadata

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/FileType.html b/docs/types/FileType.html index 4a638de..5e599de 100644 --- a/docs/types/FileType.html +++ b/docs/types/FileType.html @@ -1,87 +1,2 @@ -FileType | rmapi-js
-
- -
-
-
-
- -

Type alias FileType

-
FileType: "notebook" | "pdf" | "epub" | ""
-

remarkable file type; empty for notebook

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +FileType | rmapi-js

Type alias FileType

FileType: "notebook" | "pdf" | "epub" | ""

remarkable file type; empty for notebook

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/Metadata.html b/docs/types/Metadata.html index 1fd9796..07d737d 100644 --- a/docs/types/Metadata.html +++ b/docs/types/Metadata.html @@ -1,88 +1,3 @@ -Metadata | rmapi-js
-
- -
-
-
-
- -

Type alias Metadata

-
Metadata: CollectionTypeMetadata | DocumentTypeMetadata
-

metadata for a document or collection (folder)

+Metadata | rmapi-js

Type alias Metadata

Metadata: CollectionTypeMetadata | DocumentTypeMetadata

metadata for a document or collection (folder)

This is found in the the .metadata file.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/MetadataEntry.html b/docs/types/MetadataEntry.html index 9ce5b3c..4eddbd2 100644 --- a/docs/types/MetadataEntry.html +++ b/docs/types/MetadataEntry.html @@ -1,87 +1,2 @@ -MetadataEntry | rmapi-js
-
- -
-
-
-
- -

Type alias MetadataEntry

-
MetadataEntry: CollectionMetadataEntry | DocumentMetadataEntry
-

a full metadata entry returned by getEntriesMetadata

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +MetadataEntry | rmapi-js

Type alias MetadataEntry

MetadataEntry: CollectionMetadataEntry | DocumentMetadataEntry

a full metadata entry returned by RemarkableApi.getEntriesMetadata

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/RequestMethod.html b/docs/types/RequestMethod.html index ae79e97..29292e6 100644 --- a/docs/types/RequestMethod.html +++ b/docs/types/RequestMethod.html @@ -1,87 +1,2 @@ -RequestMethod | rmapi-js
-
- -
-
-
-
- -

Type alias RequestMethod

-
RequestMethod: "POST" | "GET" | "PUT" | "DELETE"
-

request types

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +RequestMethod | rmapi-js

Type alias RequestMethod

RequestMethod: "POST" | "GET" | "PUT" | "DELETE"

request types

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/TextAlignment.html b/docs/types/TextAlignment.html index 40c7bed..8e0e89e 100644 --- a/docs/types/TextAlignment.html +++ b/docs/types/TextAlignment.html @@ -1,87 +1,2 @@ -TextAlignment | rmapi-js
-
- -
-
-
-
- -

Type alias TextAlignment

-
TextAlignment: "justify" | "left"
-

text alignment types

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +TextAlignment | rmapi-js

Type alias TextAlignment

TextAlignment: "justify" | "left"

text alignment types

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/Transform.html b/docs/types/Transform.html index 952e4a5..4e9d248 100644 --- a/docs/types/Transform.html +++ b/docs/types/Transform.html @@ -1,87 +1,2 @@ -Transform | rmapi-js
-
- -
-
-
-
- -

Type alias Transform

-
Transform: Record<`m${1 | 2 | 3}${1 | 2 | 3}`, number>
-

document matrix transform

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +Transform | rmapi-js

Type alias Transform

Transform: Record<`m${1 | 2 | 3}${1 | 2 | 3}`, number>

document matrix transform

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/builtinFontNames.html b/docs/variables/builtinFontNames.html index 9dda495..d7b6434 100644 --- a/docs/variables/builtinFontNames.html +++ b/docs/variables/builtinFontNames.html @@ -1,87 +1,2 @@ -builtinFontNames | rmapi-js
-
- -
-
-
-
- -

Variable builtinFontNamesConst

-
builtinFontNames: readonly ["Maison Neue", "EB Garamond", "Noto Sans", "Noto Serif", "Noto Mono", "Noto Sans UI"] = ...
-

font name options

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +builtinFontNames | rmapi-js

Variable builtinFontNamesConst

builtinFontNames: readonly ["Maison Neue", "EB Garamond", "Noto Sans", "Noto Serif", "Noto Mono", "Noto Sans UI"] = ...

font name options

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/builtinLineHeights.html b/docs/variables/builtinLineHeights.html index 79f0d10..4efd6fe 100644 --- a/docs/variables/builtinLineHeights.html +++ b/docs/variables/builtinLineHeights.html @@ -1,110 +1,6 @@ -builtinLineHeights | rmapi-js
-
- -
-
-
-
- -

Variable builtinLineHeightsConst

-
builtinLineHeights: {
    df: -1;
    lg: 150;
    md: 100;
    xl: 200;
} = ...
-

line height options

-
-
-

Type declaration

-
    -
  • -
    Readonly df: -1
    -

    default

    -
    -
    • -
  • -
    Readonly lg: 150
    -

    half

    -
    -
    • -
  • -
    Readonly md: 100
    -

    normal

    -
    -
    • -
  • -
    Readonly xl: 200
    -

    double

    -
    -
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +builtinLineHeights | rmapi-js

Variable builtinLineHeightsConst

builtinLineHeights: {
    df: -1;
    lg: 150;
    md: 100;
    xl: 200;
} = ...

line height options

+

Type declaration

  • Readonly df: -1

    default

    +
  • Readonly lg: 150

    half

    +
  • Readonly md: 100

    normal

    +
  • Readonly xl: 200

    double

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/builtinMargins.html b/docs/variables/builtinMargins.html index 967c54b..5c133d8 100644 --- a/docs/variables/builtinMargins.html +++ b/docs/variables/builtinMargins.html @@ -1,110 +1,6 @@ -builtinMargins | rmapi-js
-
- -
-
-
-
- -

Variable builtinMarginsConst

-
builtinMargins: {
    lg: 200;
    md: 125;
    rr: 180;
    sm: 50;
} = ...
-

margin options

-
-
-

Type declaration

-
    -
  • -
    Readonly lg: 200
    -

    large

    -
    -
    • -
  • -
    Readonly md: 125
    -

    medium

    -
    -
    • -
  • -
    Readonly rr: 180
    -

    default for read on remarkable

    -
    -
    • -
  • -
    Readonly sm: 50
    -

    small

    -
    -
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +builtinMargins | rmapi-js

Variable builtinMarginsConst

builtinMargins: {
    lg: 200;
    md: 125;
    rr: 180;
    sm: 50;
} = ...

margin options

+

Type declaration

  • Readonly lg: 200

    large

    +
  • Readonly md: 125

    medium

    +
  • Readonly rr: 180

    default for read on remarkable

    +
  • Readonly sm: 50

    small

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/builtinTextScales.html b/docs/variables/builtinTextScales.html index 4b2f8d4..59bfa01 100644 --- a/docs/variables/builtinTextScales.html +++ b/docs/variables/builtinTextScales.html @@ -1,120 +1,8 @@ -builtinTextScales | rmapi-js
-
- -
-
-
-
- -

Variable builtinTextScalesConst

-
builtinTextScales: {
    lg: 1.2;
    md: 1;
    sm: 0.8;
    xl: 1.5;
    xs: 0.7;
    xx: 2;
} = ...
-

text scale options

-
-
-

Type declaration

-
    -
  • -
    Readonly lg: 1.2
    -

    large

    -
    -
    • -
  • -
    Readonly md: 1
    -

    medium / default

    -
    -
    • -
  • -
    Readonly sm: 0.8
    -

    small

    -
    -
    • -
  • -
    Readonly xl: 1.5
    -

    extra large

    -
    -
    • -
  • -
    Readonly xs: 0.7
    -

    the smallest

    -
    -
    • -
  • -
    Readonly xx: 2
    -

    double extra large

    -
    -
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +builtinTextScales | rmapi-js

Variable builtinTextScalesConst

builtinTextScales: {
    lg: 1.2;
    md: 1;
    sm: 0.8;
    xl: 1.5;
    xs: 0.7;
    xx: 2;
} = ...

text scale options

+

Type declaration

  • Readonly lg: 1.2

    large

    +
  • Readonly md: 1

    medium / default

    +
  • Readonly sm: 0.8

    small

    +
  • Readonly xl: 1.5

    extra large

    +
  • Readonly xs: 0.7

    the smallest

    +
  • Readonly xx: 2

    double extra large

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/builtinTools.html b/docs/variables/builtinTools.html index 46e98ac..924a43a 100644 --- a/docs/variables/builtinTools.html +++ b/docs/variables/builtinTools.html @@ -1,87 +1,2 @@ -builtinTools | rmapi-js
-
- -
-
-
-
- -

Variable builtinToolsConst

-
builtinTools: readonly ["Ballpoint", "Ballpointv2", "Brush", "Calligraphy", "ClearPage", "EraseSection", "Eraser", "Fineliner", "Finelinerv2", "Highlighter", "Highlighterv2", "Marker", "Markerv2", "Paintbrush", "Paintbrushv2", "Pencilv2", "SharpPencil", "SharpPencilv2", "SolidPen", "ZoomTool"] = ...
-

tool options

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +builtinTools | rmapi-js

Variable builtinToolsConst

builtinTools: readonly ["Ballpoint", "Ballpointv2", "Brush", "Calligraphy", "ClearPage", "EraseSection", "Eraser", "Fineliner", "Finelinerv2", "Highlighter", "Highlighterv2", "Marker", "Markerv2", "Paintbrush", "Paintbrushv2", "Pencilv2", "SharpPencil", "SharpPencilv2", "SolidPen", "ZoomTool"] = ...

tool options

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/package.json b/package.json index b8f9735..9550210 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "rmapi-js", - "version": "3.1.0", + "version": "4.0.0", "description": "JavaScript implementation of the reMarkable 1.5 api", "repository": "git@github.com:erikbrinkman/rmapi-js.git", "author": "Erik Brinkman ",