From e4add16e8f05704cf3b63aa148cc20f8865b0fef Mon Sep 17 00:00:00 2001 From: Gildas Date: Thu, 5 Dec 2024 16:13:12 +0100 Subject: [PATCH] update doc --- api/assets/hierarchy.js | 1 + api/assets/icons.js | 2 +- api/assets/icons.svg | 2 +- api/assets/main.js | 10 +- api/assets/navigation.js | 2 +- api/assets/search.js | 2 +- api/assets/style.css | 2693 +++++++++-------- api/classes/BlobReader.html | 20 +- api/classes/BlobWriter.html | 16 +- api/classes/CodecStream.html | 10 +- api/classes/Data64URIReader.html | 20 +- api/classes/Data64URIWriter.html | 22 +- api/classes/EventBasedCodec.html | 14 +- api/classes/FS.html | 172 +- api/classes/HttpRangeReader.html | 22 +- api/classes/HttpReader.html | 22 +- api/classes/Reader.html | 24 +- api/classes/SplitDataReader.html | 22 +- api/classes/SplitDataWriter.html | 14 +- api/classes/SplitZipReader.html | 24 +- api/classes/SplitZipWriter.html | 16 +- api/classes/SyncCodec.html | 10 +- api/classes/TextReader.html | 20 +- api/classes/TextWriter.html | 22 +- api/classes/TransformStreamLike.html | 12 +- api/classes/Uint8ArrayReader.html | 22 +- api/classes/Uint8ArrayWriter.html | 22 +- api/classes/Writer.html | 24 +- api/classes/ZipDeflate.html | 16 +- api/classes/ZipDirectoryEntry.html | 158 +- api/classes/ZipEntry.html | 44 +- api/classes/ZipFileEntry.html | 100 +- api/classes/ZipInflate.html | 14 +- api/classes/ZipReader.html | 34 +- api/classes/ZipReaderStream.html | 16 +- api/classes/ZipWriter.html | 28 +- api/classes/ZipWriterStream.html | 36 +- api/functions/configure.html | 4 +- api/functions/getMimeType.html | 4 +- api/functions/initShimAsyncCodec.html | 4 +- api/functions/terminateWorkers.html | 4 +- api/hierarchy.html | 2 +- api/index.html | 16 +- api/interfaces/Configuration.html | 66 +- api/interfaces/Entry.html | 112 +- .../EntryDataOnprogressOptions.html | 12 +- .../EntryGetDataCheckPasswordOptions.html | 58 +- api/interfaces/EntryGetDataOptions.html | 58 +- api/interfaces/EntryMetaData.html | 104 +- api/interfaces/EntryOnprogressOptions.html | 8 +- api/interfaces/EventBasedZipLibrary.html | 12 +- api/interfaces/FileSystemEntryLike.html | 6 +- api/interfaces/FileSystemHandleLike.html | 6 +- api/interfaces/GetEntriesOptions.html | 18 +- api/interfaces/HttpOptions.html | 36 +- api/interfaces/HttpRangeOptions.html | 14 +- api/interfaces/Initializable.html | 8 +- api/interfaces/ReadableReader.html | 6 +- api/interfaces/URLString.html | 206 +- api/interfaces/WorkerConfiguration.html | 16 +- api/interfaces/WritableWriter.html | 10 +- .../ZipDirectoryEntryExportOptions.html | 170 +- .../ZipDirectoryEntryImportHttpOptions.html | 110 +- api/interfaces/ZipLibrary.html | 16 +- .../ZipReaderConstructorOptions.html | 78 +- .../ZipReaderGetEntriesOptions.html | 20 +- api/interfaces/ZipReaderOptions.html | 40 +- api/interfaces/ZipWriterAddDataOptions.html | 186 +- api/interfaces/ZipWriterCloseOptions.html | 16 +- .../ZipWriterConstructorOptions.html | 152 +- api/interfaces/dataHandler.html | 6 +- api/interfaces/registerDataHandler.html | 6 +- api/modules.html | 90 +- api/variables/ERR_BAD_FORMAT.html | 4 +- .../ERR_CENTRAL_DIRECTORY_NOT_FOUND.html | 4 +- api/variables/ERR_DUPLICATED_NAME.html | 4 +- api/variables/ERR_ENCRYPTED.html | 4 +- .../ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND.html | 4 +- api/variables/ERR_EOCDR_NOT_FOUND.html | 4 +- .../ERR_EXTRAFIELD_ZIP64_NOT_FOUND.html | 4 +- api/variables/ERR_HTTP_RANGE.html | 4 +- api/variables/ERR_INVALID_COMMENT.html | 4 +- .../ERR_INVALID_ENCRYPTION_STRENGTH.html | 4 +- api/variables/ERR_INVALID_ENTRY_COMMENT.html | 4 +- api/variables/ERR_INVALID_ENTRY_NAME.html | 4 +- .../ERR_INVALID_EXTRAFIELD_DATA.html | 4 +- .../ERR_INVALID_EXTRAFIELD_TYPE.html | 4 +- api/variables/ERR_INVALID_PASSWORD.html | 4 +- api/variables/ERR_INVALID_SIGNATURE.html | 4 +- api/variables/ERR_INVALID_VERSION.html | 4 +- .../ERR_ITERATOR_COMPLETED_TOO_SOON.html | 4 +- .../ERR_LOCAL_FILE_HEADER_NOT_FOUND.html | 4 +- api/variables/ERR_SPLIT_ZIP_FILE.html | 4 +- .../ERR_UNDEFINED_UNCOMPRESSED_SIZE.html | 4 +- .../ERR_UNSUPPORTED_COMPRESSION.html | 4 +- api/variables/ERR_UNSUPPORTED_ENCRYPTION.html | 4 +- api/variables/ERR_UNSUPPORTED_FORMAT.html | 4 +- api/variables/fs-1.html | 16 +- 98 files changed, 2765 insertions(+), 2735 deletions(-) create mode 100644 api/assets/hierarchy.js diff --git a/api/assets/hierarchy.js b/api/assets/hierarchy.js new file mode 100644 index 00000000..4b75baa0 --- /dev/null +++ b/api/assets/hierarchy.js @@ -0,0 +1 @@ +window.hierarchyData = "H4sIAAAAAAAAE6VYwU7cMBD9l5xNGyexE3OjC7R7qFpBEVIrDmHXQERIVo5RoYh/7zhpN3bwxvYiISLIm3nPM5MXOy+RaFvZRYe/csYQIQUqcIxIlqAsjhGDnxTRGKUE/k7hHoV7DOU0v0KR4Dc1X8mqbSD+JUqw+t2UDzw6jBZtc1PdPopS3Y5QdF816+gwIRRFj6IGQNVILm7KFe8+GtgPd/KhhoBVXXaQNpLd+kAFH2wDolcUpUTjumzFPRchjJYID164eVfVa8EbKFeCEcEY0QSqgeMr0ERjTdP5c7NatGu+2irBSfFfSc8BMragneTDPwxiSlGe9XxU4/tZbY6hHaXkc4QjysEI6fPMTL9sfNL/Q7nTM71ay6aSVVlXf8rrmjt6Z2BDu5alKWIwyzSFeaaqiizVdJzxcq3SqisXDiEmOFQJIz07mbBrrJYCO6gs04JjhjDMKoaF44wgTBlK4ekFbrilkf/gT9ItYES5O4wNQ/hUt9fu/CPKI3+qt+64lCXNLs6WbpIJ1IMp09t0AR0tjoQon91UU6wHF8l1G9nUlYTHys1kIj14KJvyqLp4Eo3QoGEk/eDB/GnUX6T0WN6ICiFMi96Z4TIlLJvb6VO+i3WEuquaGnaiwr9thhfkvJdoyFAjwXHK1CLhfW1bpD+/Dg8VAeseNOjLvxSVVAaprk43NcH7+Lpm6nCZ6Jjvs4PUMllZEqNM7ZJy3BMm8cRL3aQjyj1XmeF1yiXd+UeUR/4ssXmpm2QC9WAixOJvbiIT6cFDU5u/eRKN0KChIP1LHWbC+rpwc0+x7mXCHtTcpg1OBVvbTorHlWyFnwHMRO5rSCSNbdI+c3nSSFHxLlDZm0C/owIxRjuUfR9SoxrqkACV6AuSMVtBAsvwDh1wWOl1kELToZb3/JXLUs28Q4SBDVbAequEy5Tdh9Wv2bDCaXLooFLrV2VLROgyKRlOgyTeoWRxx1f33yHZ71asw2XZwv2KA+dUc/4Gkzlar/0LtCPKUwBhNgGLuu089ynWGE9yY9c5JtrDKXdFho4KNAThmPan+Zy9mdy+vs1GtLeCd55+tTsweI6HLxtbgQV+M9B7iXu3MHBTBJM0aJp8AzHtxP6JYt5OLK/1As7NDA+ExkkQkp1WNfch3eI8vozgyVNyXAmupuzZh8gEB53OcMyG7wLprIDlw6YV0v9s407g9wCrQZzTdfKk0u6pyQj21GN+QDk9n+vM6bmr8a+vfwFgsgeqjBUAAA==" \ No newline at end of file diff --git a/api/assets/icons.js b/api/assets/icons.js index 3dfbd322..58882d76 100644 --- a/api/assets/icons.js +++ b/api/assets/icons.js @@ -3,7 +3,7 @@ function addIcons() { if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); - svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; svg.style.display = "none"; if (location.protocol === "file:") updateUseElements(); } diff --git a/api/assets/icons.svg b/api/assets/icons.svg index a19417dc..50ad5799 100644 --- a/api/assets/icons.svg +++ b/api/assets/icons.svg @@ -1 +1 @@ -MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/api/assets/main.js b/api/assets/main.js index 99097a05..d26cd1d5 100644 --- a/api/assets/main.js +++ b/api/assets/main.js @@ -1,9 +1,9 @@ "use strict"; -window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; -"use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;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),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=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 ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.appendChild(document.createElement("span")).textContent=t.text}}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse"}; +"use strict";(()=>{var De=Object.create;var le=Object.defineProperty;var Fe=Object.getOwnPropertyDescriptor;var Ne=Object.getOwnPropertyNames;var Ve=Object.getPrototypeOf,Be=Object.prototype.hasOwnProperty;var qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var je=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ne(e))!Be.call(t,i)&&i!==n&&le(t,i,{get:()=>e[i],enumerable:!(r=Fe(e,i))||r.enumerable});return t};var $e=(t,e,n)=>(n=t!=null?De(Ve(t)):{},je(e||!t||!t.__esModule?le(n,"default",{value:t,enumerable:!0}):n,t));var pe=qe((de,he)=>{(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,c],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[c+1]*i[d+1],c+=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 c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=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 de=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse"};var ce=[];function G(t,e){ce.push({selector:e,constructor:t})}var J=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){ce.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!ze(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function ze(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ge=$e(pe(),1);async function H(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).text();return JSON.parse(i)}async function fe(t,e){if(!window.searchData)return;let n=await H(window.searchData);t.data=n,t.index=ge.Index.load(n.index),e.classList.remove("loading"),e.classList.add("ready")}function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.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",()=>{fe(e,t)}),fe(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{re(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),We(t,i,r,e)}function We(t,e,n,r){n.addEventListener("input",ue(()=>{Ue(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Je(e,t):i.key=="ArrowUp"?(me(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(me(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),re(t))})}function re(t){t.classList.remove("has-focus")}function Ue(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=ye(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ye(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=c+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function me(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Je(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),re(e)}}function ye(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(ne(t.substring(s,o)),`${ne(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ne(t.substring(s))),i.join("")}var Ge={"&":"&","<":"<",">":">","'":"'",'"':"""};function ne(t){return t.replace(/[&<>"'"]/g,e=>Ge[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var A="mousedown",Ee="mousemove",B="mouseup",X={x:0,y:0},xe=!1,ie=!1,Xe=!1,D=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Xe=!0,A="touchstart",Ee="touchmove",B="touchend");document.addEventListener(A,t=>{ie=!0,D=!1;let e=A=="touchstart"?t.targetTouches[0]:t;X.y=e.pageY||0,X.x=e.pageX||0});document.addEventListener(Ee,t=>{if(ie&&!D){let e=A=="touchstart"?t.targetTouches[0]:t,n=X.x-(e.pageX||0),r=X.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var Y=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(A,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var se;try{se=localStorage}catch{se={getItem(){return null},setItem(){}}}var C=se;var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var Z=class extends I{key;value;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()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.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 oe=new Map,ae=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},K=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(oe.has(i))s=oe.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new ae(i,a),oe.set(i,s)}s.add(this.el)}};function Se(t){let e=C.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),we(t.value)})}function we(t){document.documentElement.dataset.theme=t}var ee;function Ce(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Te),Te())}async function Te(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await H(window.navigationData);ee=document.documentElement.dataset.base,ee.endsWith("/")||(ee+="/"),t.innerHTML="";for(let n of e)Ie(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ie(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',ke(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 c of t.children)Ie(c,l,i)}else ke(t,r,t.class)}function ke(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=ee+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.appendChild(document.createElement("span")).textContent=t.text}}var te=document.documentElement.dataset.base;te.endsWith("/")||(te+="/");function Pe(){document.querySelector(".tsd-full-hierarchy")?Ye():document.querySelector(".tsd-hierarchy")&&Ze()}function Ye(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=tt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ze(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Qe),Qe())}async function Qe(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await H(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),Ke(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function Ke(t,e,n){let r=e.roots.filter(i=>et(e,i,n));for(let i of r)t.appendChild(Oe(e,i,n))}function Oe(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=te+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=te+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=Oe(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function et(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function tt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}G(Y,"a[data-toggle]");G(K,".tsd-accordion");G(Z,".tsd-filter-item input[type=checkbox]");var _e=document.getElementById("tsd-theme");_e&&Se(_e);var nt=new J;Object.defineProperty(window,"app",{value:nt});ve();Ce();Pe();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/api/assets/navigation.js b/api/assets/navigation.js index 4d19607e..60e58480 100644 --- a/api/assets/navigation.js +++ b/api/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE5WYb2/bNhDGv4tfZyuaZUHRd4olJwJkSaDkZskwCIxFO0RkyaCYrt6w7z7KTq2/d0e/KtB77vfwyPORyp//zrT4oWdfZ3dF9cIEz4WaXc32XL+a/1sXvK5F/amN/fqqd4URvMkyn339fP3lv6se4VFJDRFOMYwwr3KxTrQSfDdGdIIYw+Wa396smA8VMxBYsaCyBgKM5X0Xpb7jtciPhYxZAwHGWiTj9EWCZTxovWe83ApoVwYCkoVhSAKUTWcm+0LqZtchxEBgxYJOdyAgWc8S3Jd+fES6OglNQi72Sqy5FvlsAo+u9By/HH8o10BXnkNY9an5B6q8jVEEqLg2hhIUL+tNpXanERHINzGBGosw5kqW+oujFD9A1Q0VdjSo0qECo0EMOtP0iSs2hWmCcXYbowjS9JGu1MErtTpMg3oSggdjbLIXshAw4RwlKH4J78pHjCBAbQL/8qfyoRtwICBYUIPAY2IqH1lLV4Df6uVGbt8V17IqW5LpdaE2fH282juKPur699sOKjfD+IGXedEtrAPqxDHMoFU6gIk2mUht7oSo3Ktqq0RdR/tm2TXMm5STJvfiePfMX8X6LTab/nelctIKSbI1tPWwxS6F5o0eBv5UkKgL9vyy/T4/vUxbB/JFcag9JoQYuJk8yaHWYndcVP9S6nAndHbYU7NbcFshBjZH2yxACnSDRyoM2bwIMVgnTmGO71OK1RVhQL+UWvJC/sNfiunN6ykwVDOUG81w+ndYfQkGU2IrzYEplxh1EzoMu2KBmdSy3E7CzlEM8VipN6HoaT6hQ7HmGmm2ZnhfdYk9CQYbPTu8H/tKaaxp8JSLzPxdk0l1PJ1GmGITym4unV8S5pRqrd6btRBLhvRWNnZzBZZbmVih7YCnRnPynLoQAa0Vfl5UNTrOJpV2aOtjhfTodclYdue42SJiSydtyd+5ks3P1NyTPUWf9dv1ADX3wpQ5Qeb6zJunEXvKwig1qavQhdhICmHmruLAnzup52ahs/Qgg4GMgHrhnD3FRgzhzgIKFM1dlgWRcY5Y9uzHtzf0ZqBJVoaWFtbQP8zhLHwvcK1LADMIq4c0jTPmhPfgSbYKAuWH35zAd7N5tFya9oJ4A5kl9KMB/CjMkpR54X36QBlMpFibpeYXYVlHT3yRAfb7GStt0W0nuE7qkPy+/HKT9Cmmi+jLLU1iJ0keIwb2/FBniU38+9BJV4xc9VloCf7mscQ0G4X9kFHQ1GPHcWQaKw68Zo6mUZQlEWIApxBmzegLsoUfeNmD57iexUBDUgizxFwMaTOljtkQv68ikMbUW/ihKXgVNsUzL0m85gCfQT6SQpolqziOWLO/PzORYwfkF5i0c8zGo1VfYIE/RMZKBL2ppzCb+pfPSNL641un8x25eS/Xx4fUp3OwD7i96QC2Qi/lTqSH/SSiE0Yg0nyvJq9y59TjP+e3rLEKQZqn4U6WXIvTN109BRxqRri//gfNNQFlZRwAAA==" \ No newline at end of file +window.navigationData = "H4sIAAAAAAAAE5WYb2/bNhDGv4tfZyuaZUHRd4olJwJkSaDkZskwCIxFO0RkyaCYrt6w7z7KTq2/d0e/KtB77vfwyPORyp//zrT4oWdfZ3dF9cIEz4WaXc32XL+a/1sXvK5F/amN/fqqd4URvMkyn339fP3lv6se4VFJDRFOMYwwr3KxTrQSfDdGdIIYw+Wa396smA8VMxBYsaCyBgKM5X0Xpb7jtciPhYxZAwHGWiTj9EWCZTxovWe83ApoVwYCkoVhSAKUTWcm+0LqZtchxEBgxYJOdyAgWc8S3Jd+fES6OglNQi72Sqy5FvlsAo+u9By/HH8o10BXnkNY9an5B6q8jVEEqLg2hhIUL+tNpXanERHINzGBGosw5kqW+oujFD9A1Q0VdjSo0qECo0EMOtP0iSs2hWmCcXYbowjS9JGu1MErtTpMg3oSggdjbLIXshAw4RwlKH4J78pHjCBAbQL/8qfyoRtwICBYUIPAY2IqH1lLV4Df6uVGbt8V17IqW5LpdaE2fH282juKPur699sOKjfD+IGXedEtrAPqxDHMoFU6gIk2mUht7oSo3Ktqq0RdR/tm2TXMm5STJvfiePfMX8X6LTab/nelctIKSbI1tPWwxS6F5o0eBv5UkKgL9vyy/T4/vUxbB/JFcag9JoQYuJk8yaHWYndcVP9S6nAndHbYU7NbcFshBjZH2yxACnSDRyoM2bwIMVgnTmGO71OK1RVhQL+UWvJC/sNfiunN6ykwVDOUG81w+ndYfQkGU2IrzYEplxh1EzoMu2KBmdSy3E7CzlEM8VipN6HoaT6hQ7HmGmm2ZnhfdYk9CQYbPTu8H/tKaaxp8JSLzPxdk0l1PJ1GmGITym4unV8S5pRqrd6btRBLhvRWNnZzBZZbmVih7YCnRnPynLoQAa0Vfl5UNTrOJpV2aOtjhfTodclYdue42SJiSydtyd+5ks3P1NyTPUWf9dv1ADX3wpQ5Qeb6zJunEXvKwig1qavQhdhICmHmruLAnzup52ahs/Qgg4GMgHrhnD3FRgzhzgIKFM1dlgWRcY5Y9uzHtzf0ZqBJVoaWFtbQP8zhLHwvcK1LADMIq4c0jTPmhPfgSbYKAuWH35zAd7N5tFya9oJ4A5kl9KMB/CjMkpR54X36QBlMpFibpeYXYVlHT3yRAfb7GStt0W0nuE7qkPy+/HKT9Cmmi+jLLU1iJ0keIwb2/FBniU38+9BJV4xc9VloCf7mscQ0G4X9kFHQ1GPHcWQaKw68Zo6mUZQlEWIApxBmzegLsoUfeNmD57iexUBDUgizxFwMaTOljtkQv68ikMbUW/ihKXgVNsUzL0m85gCfQT6SQpolqziOWLO/PzORYwfkF5i0c8zGo1VfYIE/RMZKBL2ppzCb+pfPSNL641un8x25eS/Xx4fUp3OwD7i96QC2Qi/lTqSH/SSiE0Yg0nyvJq9y59TjP+e3rLEKQZqn4U6WXIvTN109BRxqRri//gfNNQFlZRwAAA==" \ No newline at end of file diff --git a/api/assets/search.js b/api/assets/search.js index cd3def8b..0699d615 100644 --- a/api/assets/search.js +++ b/api/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE72dXZPbNrKG/4t96/UKXxS1d17b2bgqiVO2s+fspram5BmOrcqMNEfSJHG29r8fEiAkoPkCbJDy3iS2RXY3wRdf/QDgv5/sd78dnvzl538/+WWzvXnyl0o/e7Jd3zdP/vLkere93Xx63DdPnj153N+1/3L7uL0+bnbbw59Pvz3/fLy/ay+4vlsfDk1r6cmT/zwDxjbbzfH95839i8OX7fXL3U1zDawOL+KaPzb7+812fWz+Z7f/pdkfgHF6Cdf0p+b4/ea++fDlARVE8GvWoDTVyeI3m7vm/ZfDsbl/vT3uv3y3+eVsebNt47xdXzeHP4PLJrj4dr29uWvGfZyvyzoRsj45+bBfbw+3u/39++O+Wd9HPvqb/wyuydo3QoYCPBz3j9fH3Z5t92l8U+Dj2ZOH9b7ZHhOBB4+4kOe33/5+s/54x3+wp8Eds73/tt8cy7wHd0zxHmroZV/H153SkXiiC/KqCR/qfv07raVZo0+jG/BTxbEmHJMW4ENbb3ePR2YQyZtnBPSbNfX+er95OHILg95T5r4yRp3f8NXVMWzVChw/P93K8P88jjlRGDfN7V1bvDOied6b+JOYEpd/pER4m+3s8HoTXyW868+P21/eb/7gBhheP0PBr4pe2vnqGS7fFL2I89UzXL7c3T/sm8OhvcS1mkzn6L5ZhX09MRB854xQHg/N/zQfy5pxes/Z/fFw86fN4U+b7eem7b6amynhTH1HiVvnBRd2o+6BRztTcBm/Sx19HSnrmZcSPid6hpmvIhcRv97kAwtfw775tGnHuftX6+PajXX3KCxwGXvQfZM3fTPB5Otf2+f86/rQ3Pxz8/Dd5uN+vf+CbKPr+PLJtOJJw6ONOQy9vE1PBzDWtI8FEMxkzpfGU1M/3Ca/X2QGg2yyZi802EA5C31+pofHw2ee0/7KWd52207ePH+na4s9BjUjXx8uXAtKtT9L8aU6H1X3+0HKxb+e96w8C1fRsTWWls+hJXS1fnhotjdjrk5X8b2EBdSWIH353tH5p4sUETHHKqMgukQh3d6huk59+aumekm8CuoGvIvcEAr6JS+HVpbAdf/TpV5OaI77cnx0pS8n8jX6cka8pF9O5Kb85Qz9hi/H1ioyyPO+g9/Y4503281xs77b/BFlvYLGMbogbzYsni6zzDP3tL8Uv4g4PvwM7/oEYPd/PBKMr+D3UINkZN7meCqShIrfMXkO/3oZwXMrXhgzp9INw2WlbIuLJu3jEGZakP1DLrUysJ3WKrKdVWjedvfYP7WqqV/s9+svoyUUXcotp5AQNL8fE/I5/3QZHhCb42GAc3TF2X/iDsop17KO+4YSo34HMiv2OS496nMgv3k+RySJSjohy/LyDqT617vdx4RUzz9dRKrEHEuqQXSlUqXuiqU67htKlfotkir0OS5V6rNIquM+R6SKSnqCVHF5B1LtclOV/undm4Reye8XES2yyVIuDbZUvtBxsYaZUUAhwwiK1Jz2Pi5p6L1I10zvI+JOvocJCs+8jUDmZ8MJndMLLiJ0aJSl9EG8pVLHrou1zo0Dih3HUKT2jP9xuWP/RXrn+h8RfPptTFB87p2EmbqHu82xnXQnBB//fJmc3dAkL3EXR1oqdeS2WOi8GKDMkf8ikSd9j0sc+S4SOM/3iLxTb2CCuNPvgUq7a/hz2j7/fjlxE5t8dQfBTpI3dTxN3+NRpAVOIyhXOPTOlDj1Xq7xce8ckaP3MFXlOKIg+ffTu+/eH/eb7SeUozv9yF5i+e3xmOoMzj9dpK4Qc6xqEkRXWkOou+LKMe4b1gvqt6hKQJ/jtYH6LKoI4z5H6gAq6Qnyx+VNpbrefqJ57yiO8++XEy2xyVduEOwk+VLH0zQ8HkVayDSCcjVD70xJU+/luh73zhE3eg9TFY4jChr47qq3D3bxP2rig5+Llm9Zx9/GNSdj9unglrTOfbQJ57e7/XXTP/f/PTYHvBJ5EAC8bXIQD/umW/XRPU1vjhUEvG1yENe7+4+bbdOtin29u75hRTC8Z7L79pX+77fvuG/fXcpX9ojzz1ZHvFd/vnaOe1qprJZGalZ4TVH1yhTswCYqXdhOzCvSoV9UrkzH0YLTfgtI93/cmsRX8AtysB0lb3N8MwoJNb1hJLWyHXk9X17qNBjNkMLz/Q2jxLhjlzBkzpAlX0bJnULF76NwJBDaz4LpvO0utCbT0dPHaBhoOu/xU2Nnc1lP52u474TA74SMzj9dDH6XyimIrnjzGXEHZTUGYydIjfotBtHzJIgeOyXDeZGkpEkjQPIs9kwheEKy558uBsFLJRtEVypZ6m60JYS+eACa3SKO+0gJgboZa6dwySGknHj75PfLIuVSHdBgS8UAHRc3YukoCqDu5OaM6X2sTUsWxZSGjRlTStQwltImLqMNwNkSao9/vihnK9U6ibRU6shtsdKTMfBZ12Sdp58fsaXc+zz/flm2NOmNBsFOeqXU8Wh/lvZaQHPYPVvmGeECj8R7oxdceIFH6ZsbxFv66rDr4vqYiaNkgcXkOsn1P9b5pItjSu/DjSrV/eBoSvufnEbiTS0uy5zYO0F+v4jwkU3uHpco2FJYAh1DWDLBa7KyQa+j7WTGK3p9aa+XfWUTXlYmy33fXTrqy1820c/Dvun2GjU3sLYRb/TiiT7d9iaeS3It3yNtTV5vj/tNcxjzF10529vfmm2zXzM0g2+Z6P/6bnfI1LReOf1FBT7ifb3u95dnsWeoQOZyfl67+f24X18ff4SKLXD2NGFopCTAk+YDfYFkPiHOF0VVgB/m9efm+pcfW2O/7fY3b7d3qS3a+SCRFV4nPDXk95tP2/UxPPGuON7QxFcL9qEvlElhBjd/1QA/fN7vHj99nhzj+f6vFuZ+/duPc4oyvv+rhXnoNHU3KcLTrV/vVTsE/zLqGYredWzgqwV6tAff+YHdpM7k6dDGVwv3dnPXdH98vb3e3STWE47GC4x8vRbUDRhnxTu0cclwo6HMTdP6aDoiMinS6PavVqaj5zqNxjnt0K1pobLOfeJEPP1ALqYQ0Hjzb6eBMme4ObiaP9osqtnYzwUq9vBxL1CvE9HOrta5YKfU6kSccyo1O8Td9mG/+9TJe0qI0d2XDDGoEqya8JUrwBTdhw99SXlPUDU3lALxlmmWHQBqCjkNYPFbL5sUFswEodYvN93jzvGmhMGayI3P3qa65kzRWPOyKQFwJ1+sGdeUABjTqrG51KSC506YeLOkKSGUTIXY8x9mINHplt259t83x3UqkRVdwG9qdre3hwY2okODT08X40eJYxzp0Zgug8tnOG3rwjdlfuM7LvC8P334pi585v6WGc5vNvumG9fjg1CHnsPrZ7htttf7Lw9ubMVxG14/w+0fm4eXnZ0d0214/Qy3/rzo5ia19Br4Htw0I4DH7aQQwG0zgmjvPH6/6/LjXP/xHTNdv7huvRwKvUc3zVFA28R3jXeBe3LLvLbtu+KyH9w0P4DiN4DumxfGy/L3MLxrXksQ8eLRJiCLjdlPXeQ1umH+sxZ0a/EdM1wfcpMR4PgwOgnh9WodCfxm09yxu7Xwhnnv+HWpb3rPvG610vwu1V47w92vzf6QOPgfODxfPd/l9+0w/K/coRK9Z4b7+8Or3aFL5LbNUGLLGAhgeNeMEKyrdsrWjXlfHI/7zcdHdhOaundeVZscTureWcPowy8/PN5/7GZz6z23pR3edYFBZie55vh5x20H0H1lYQxmoUnP2VlndmEhtDS6VcNFM21im5zQ5tLDWYejE9vMhHayU87ENj+hnf282RHAyIR2svPxiW1uQjvZ7fjENjehnex2fGKbm9BOdsucVY5OaCcHwJ7YMia0k4PgTGzzE9pZrhnTqtEJ7XQFcCZUIxPaOW0bZ2I7OqGdGwD7DeQntHPCYE1sxye0c1qC7BQzPaGd9dQsr4kJ7dxnZXRrqQntZNfjE9vchHZ6rzY+ucxOaOe8Y8bEdmxCO6dbzUxsUxPaye7GJrbpCe1clyMT27EJ7WT33Int+IR2cghlE1vuhHZOVSsOZ3xCO2MYzZvYjk9oZw8yxye2nAltSRiDie3f3Hwzs6QDXMaf9HbL7HKFDOw+Pd9T8IzkOSYtrspEVLyqqiio8NNMvHhKvtKUD6V8EU4yrOk7MkpDzC7NycdXvgOjILjcgp1kWMU7LgoDyizjycZUusOiIKyRxT3JsKbsqCgIK73kJxlR4Q6Kklc3shAo/e6m7JgoCIyxPCgZ29QdEgXhjS6KTwY3bTF8WWisRfC5CKcvfh/pkhIjg5dRo84bJqB7Lj5mSDqZNYCAjzt7NJGLddbQoixcxjgjF+nUQcdIkPNGIOmALzMcKQ6ePTYZiXzeQKUkbO6oJR3wrCFMaajM8Uw+2jmDm5KAC0Y66YDnDntKAuaNgdKxzhgQFQmhYHSUUcLcoVJJyIXjpnTUlxhElQReNKJKhz1/eFUYdPFYKxv7ZQZeY48QnyLjDglKHwIU/p4dYBWcKDOwyT1XJgo21RxmDgEaOuYcAsTx+kfyKD/oNry81G804nIVdbfnvbun4eWlfitj1HkAf3V1/PLALOST1+enP/1JPD9ZYAXyHBi5jARy0T33pv4k5gTqnzURb+4EqcJ4OcdLlUc7OFSNH62/ml+AKb/Jo39AczK2SSlVpVHbmHZ52fZwQkuYEtTn9eHlbr9/7NbKdF1D4nCo0C++he8/elXrm5sxf+6SifZHpFAkgvRWVPf7i5ubEXyRuJS/Wyy77CpnnbGzKPUc5UsSsoEwDmsrCSPPzrORMJaHFwbDWS+VDYm9JagwsOzChmxE42v3C0NJQv9sGGXLAApDYmxzTUc29UygkgDvWhep3b/pyPxdXyWkj4+37ayvubH3FIdG7/4qIf7SNA9v94mvVGXDC+/8OorLpGHyaitNvRQGNr7TPR3bxCPGilp7t663n/ZuPx1TBwJkWn1k4qsEm920P9LifrV6O7KaNt+gTFjgOSG8/HrP0QgnLP8sHfqMrAbNj3+mLA4tHxTZwzI/bO6bw3F9/zBlbDSw8FVCzS6tHxsSFC62Lwwts14wG1jpCsJpYaXXFHKCK1xlWDoOPjQ/bTfdYT/dmrkf2n8sng49xTa+Srg37SWvmsP1fvMQzrvZUyt6+38hyLHzgLjRTjoDtiRsxhLUbLhTF6VOaDFZ60JHW83pK0ULQ2avrM2GPG+tbemI6PHhYbfvvpFSafvdjc5r+QApYeUrNWU3f0xou+xNX23qkD8MKz97mHBW8YQROt6hxxmYF+zZKwwtvSM1G1fhHtXyNNr48uuxhNrEBdnjoUa51GY7cmBl9t1OOK2yJLjMQq382y1cn1Uc1sgJmrnIphyfWRZcYhHWSFwla6/KR46jpwhnx4zTThAuDJF7enA20lknB4+9ZsQnbIqSQyfCC/lsYjyxO7A7clwJjnxuEncYBffAwmwwU6r9MJQ5lT4VGNTCbnDmdDbQweUX1QW2zlbH8FlmayQRUaFS2IGNJ/hTEQ2T/DND4Sf2UyGlk/szQ+Ml9FNh4aT+XEVxkuVFnzeZGRA3gV/6nZCZYRUm7pMfA8on72cGyUjYF3y8ZG6TwEzUJxsGxvGCE8NiJuhzkTEOHZwQHDsxn/yoB+cowinyL0rIZz6FlUnKzwyRl4jPdNUjR7lOCImTgE8FNHYu3fRwGIn3kaBGzqybEFppwj3zQZNs0n1mmAWJ9uTHbNLJ9osGx0uw86JkHcJfGm5JYj0VJvcIw4ktXll2Otfq8c8TnBBqeSI9Fep4Mn3uCKU4gZ4csIwm0Wc3SSOJ83QbRJLnFxiicxLmpR/4u8yIeCRRPjIQzpzYPiEkRoI8Fc/IlwmmjOWKEuOZr7Qxj9/khTglIZ55h2Ofw2EGRbdL26TgKZOUSfCkr77cFum0eZh8Dx8/8zDTt0Fn44HZt7kh5bY6Z6OhifbyQKgy+KqYpYjRlzDzBeSemWzNsNef4gh2ALw+nWmUeqiCjRlnY9x9Ga9zhzLZ/+Xd9JdMs9+NT0fs95dMs7+BuzoC65tsQ5y13V+Yt3+6aJqP5EJ+7K1k2X7W7/Xnzd1Ne+2YxM6Xsf3QbTHbsYfy10zz8Kk5fvN4d8cQcnzlZG/vmrt2FvOrnbSOeyRXT/O6OXRzvLaRXm+Pb2/HFE8vnurTp2d/3O+OzXU4gEw5RndM1E24Y3hUpPG10zzuG4aE9vnvRKFaF3cS3eQn2VGcfrxUZxEb5HYY5xjZm8PSPlnbwUY97u2H0xjuThdO9/WbHQczfJ0uLPJFm5NoVJ92dr5ylre/3u0+8rz1V87y1o0aK/3Tuzc8l+Hls/z+1I4C6xf7/ZqjUHr9LM/dJCq1E3noN7h6djnzi3iWt33zcNeOrpk6iq+e7ZVZV+KrZ3stUTG4Zbb/IjWje2ZH8C5zegH2/45xiMVoS5zqkInLQZc8sohlvH/jVafBxGWuXzyZIV43RUviRn2mJznEL5jozPXNmfyQKCZ/+YETT25SRIdSaGI0wT9vskSdDyZMcz2PTKKG/QicSF0girHJ1TCS5ARrbjTjky5aM9MTr/mxsCZjg4DyE7LZeh2bpA0qTWqiNjeS9ORt0D1dpLeIJ3Wv/BwnObOLr7jU9A5Y5c7xSMhTJnrIO2u2l/RNG4OXXSP71y+ptgAFMLhrZhTrm5tXpYVA7pkfQWrYm3A+Nu5l+00N8hN+x0b5/BLPDbhTJc4ZcbMjyA+5EyHwxtzsGL49Hh9e7rbHxPAsEUR81/wockP/RAicsT/bf7TuYNz32OKCIr/vvxyOzX1Jo/4U3nnJaL5db2+KS4TcOjOezX23oKOkcYjuuIj34iZieNtF4ihvKMB9F4lkQnOBbrxILKWNxuCui0TRXl4WgLthpu/m99LaEd1xEe/FtWN420XiKK8d4L6LRJLLy6bj4ORnS6IoUGR4w8xRfGpqhNyWzo6Y84hEQg1OIQqzarwIcGoNNgVFM1Oe93SSDUVQnmnjRcFJt6F45uTceJHlEm9wkjsh+8arp8kUHAyjNA/HnvnmknGJae+UjBw7nrG0XCKmqbk5Zi8/mqCD9Xtylo4bFStVh0Obla9jKnwsaYcr3MTMHS+mdPoOBVOew0tHEW9Zjq97cxoe53cuj9zF38Bsz4m9Pv64bx7s9qsI65b7fJqwN7HYhsWRf4wXDxd9CmLuaz8E65M83EeY/lGemQ8wtrmIH/2k87smhj6y15kV9JTzS2eEm9/3wY54wplJE4Me377NCnriUawTg87um2bFW37m6VRRjJ8AwVPFxFOfJ4bN+FwPN/KpH+yZHvzt5s4ODV53+102209zoge2vnqL7Q6sv0T0Q1NfIfhoCHfTjGxRYsUdWfna5c05AooV9eTToKYHzj0Yihv/rDOipj/Gu/X2U/NtvLh32gPElr56S7PbXzuX75r/e2wOx1n6gdb+Sx1UV2S91wt0U7G1/0KD+XGzbbqc1Ovd9axxzNDUf0H9//vtu5mqdxa+dqifbbWaJfGzia/REeVm8a9tIr1kBh/dwZ+97/tk14/r5JlDY36eEhvMxH/8iKljHDb3zYfw+2iFoQX3XzIst2Fj3ut5So1cMsA/MqfKjQb2R+nXZCYEWDzTAHFeZpbBCjd3At1onMVfmpkQIOdcutFAJ393ZkLAY6fVjQY76Ss0U5RaknBAKp2daeA1SYWpEdQgXSItwgqWfd7daMzzvlczIfSCbA4Id24mh9dYjZ6NN95kTfuWzcRgR0/MY8U77cs2E0JmnKM3GvDU79xMqWzM0/XG69qcr95MG8Rkz9zjDGTKv4EzIdD8SXyjYU74Is70ILPn83FDLf8+zoSA+af2jYY982s5E4JnneU3Gvf0b+fMDrkMwo3GfgESx5swss79G583Tv+uzsQWmnvEHquVnvXJmgkPUHJG4OgDzP7mzpRRXcHJgeODvLlf4JnUWCbPE2S0jmXf45k4iSqhzYl51GzSXDI7SZ49yJ2UzFkIxQo0eyLhaJTlX+6ZMlZmnlM4PmCe8x0fXuBlpxdyVDAbC7JC3aWPGGTpoPwbP5OCHPnmByPOKR//mBRq+sM/jCgLv//DrFTB5t1v3p+C84sOv3l/ke25vRnWftw2ilQqarcbLhv3pvsfGTbJYsv73a/DxZYnq/7nUrtZqxNt3m4C+VCb/Y+lNruzjb68SZs9/176tm68/pK2wyt4ss4+R26DdPA4qR3R0/xmt0R7r8k90JN9wk3Qgbui3iHrCe7dCjwNdmpNL8fkPq2wHOGurMk+M3uyAqeJHViTveZ2JwZuU3sRJ/tN7kQMnMJ9h5M9wg3LgbeiGcyop9wWZeI0tSf5Av4Tm5JhAGAX8rQIMtuQvePEvuM5/sarbG6n8RzPjIqb3Vs8xzen+uZ3E8/xPlqJM/uH5/j9J9iuGbv854afuU97y2wZ9u4Se4Tn+BtXcm5X8BzPDCVn9wHP8Z3cCBx7hjt/5/jNaQnv9WV7G9/s6x0V7ZvKjHPRdt7TELdkf07aB9iwe6p6/Elh2n5iS673UbgHN+1ndNOt9zh5l23ad3Jb7WlyWrqPNq1yvHH25Khop2x2zpPcGhtMeIr3wmY9Zje/Bl4n7XbN9EH57a2n2jBtP2vO7/gG1rPz6TtWM1rKblE9i3fKntRcXiQrq8Jdp5Efdc4Z3Z6Tdr+u95uujzn8+fbwJ5HNOlXGqPMa16urY7iQE9h5eroE5zBuk1nmICOWtvvcXpUy/bx3nvAw3I/LcIhumu5/eAp73nV4Pd9r8NZfv3t39e2HDz9evXvxw99eA6/xBVktELN/ffHq6pu3775/8SFh9nxBidnXb1++enf1w9sP7b0//fAqYZtcVe7gu7cvX3x4++7qn29+rDTTXeKeEucvX//w4d2L765evXn3+mVr6x+jrjN3lDjuYv/u6ps3372++vb1i1evx4s4c0dRcf9vG/43b15/94pb1skbitz+8PLdP3788Drpxf9eYvSnH97/9OOPb9+1t3kDb97+kPCAL57q7uXb73989/r9e56/4OoSh29++PuL7968unr/5m8/vPjw07tUgzG4boqTH1+8f/8/b9+lXhC9rMTFq59+/O5NW1fbkvjhxfeppyBXTXmGtpy/b+vnyCP0V01x0FX+f+QeYnjhdDe8p4muneLs76/fZWRMrpr0NOcW5MM/fhwtufjqmQ5fvfjwgu+wu3ra+/LtydX7D+9e//C3D9+OvrXBHVObomynP7ywxM37tkZ+6Jp92+8kXMQXFRXfh9fvbA/etY/fve5i/PD27dX7t2k1pu8oK75Xr79580N7908/+Lb5ddd+/jP1kJk7kON/PXvS+m1+f/KXf5+Wsv7liXyunq/aK283zd1Ne+HPPkvTb9Nu/3Szu360f/xXf9nf7Vi3u9hd/efFk2c/L56Z1fNVZf71r2c/+5vtD/YfvI3zv9gbRfs3gW4UgxtFdKNs/ybRjXJwo4xuVO3fFLpRDW5U0Y26/ZtGN+rBjTq60bR/M+hGM7jRRDdW7d8qdGM1uLGKbly2f1s+U4vnYhnfuBzcuIxurNu/1c/U8rlc1tGN9eDGOrqxVdDPq2eqfr6sZHTjanDjKhZApwcBtSOG4hFEPVY+WD9AQLGCRKcLATUkhiISsYpEpw0BdSSGQhKxkkSnD9FqSTzXq7i4xFBMIlaT6DQizDNdP1+RlySGghKxokSnE1HBm4eiErGqRKcVsYTPPBSWiJUl6nTYQ3GJWF1ilQ57KDARK0xahdWwrRgqTMYKk1ZhK3jzUGGStFG2kVo80+p5vYzvBa1ULDDZSUYKdO9QXzLWl+wUI3HrONSXjPUlTTLoobxkLC9ZJYMeqkvG6pKdXiSsUXKoLhmrS3Z6kbB1lkN1yVhdstOLhC20HKpLxupSi6Su1VBdKlaXEkldq6G6VKwuZdUF+wc1lJcivaBKdREK9IOxvJSVF2wH1FBeKpaXsvKCtVEN9aVifSmrL1gb1VBgKhaYWqbf1FBgKhaYqtNvaigwFQtMdZJRsI9TQ4GpWGB6kXpTeqgvHetLd4pRAnU0eqgvHetLd4pRsBXRQ33pWF86qS891JcmA61OMaptCfTz2lTxzWCsFetLm/QjD/WlY33pTjEKD/KG+tKxvnRy1KWH8tKxvHSdfuShvHQsL71KP/JQXjqWl+kUo/DwdKgvE+vLWH3BJsgM9WVifRmrr7bAzHO1insLM9SXifVl7DAeNiNmKDATC8x0koHDXDPUlyGDeauvFXpTBoznY32ZKiURM5SXieVllsmgh/IysbxMJxjd9uniuVmQoIfyMrG8zCr9nobyMrG8qk4wWiDP1VBeVSyvqhOMhi1QNZRXFcurkqmyrobqqmJ1VSpV1tVQXFUsrkony7oaqquK1VWZZFlXQ3VVZLpYpcsazBhjeVWdYjQcflVDfVWxvqo6WdZDeVWxvKpVsqyH6qpidS0XybJeDtW1jNW1FMmyXg7VtYzVtZTJsl4O5bWM5bXsFKNhN7Mc6msZ62upU2W9HMprGctraVJlvRyqaxmra1mly3qoriVJSCzTZQ1yErG6lnW6rIfyWsbyWnaK0bB/Ww71tYz1VSfHXvVQXnUsr1qkyroeqquO1VXLZFnXQ3XVsbpqlSzreqiuOlZXrZNlXQ/lVcfyqjvFaDgcqIf6qmN91cm+sR7Kq47lVSf7xnqorpqkvNJ9Yw2yXrG66nTfWA/VVcfqWqX7xtVQXqtYXivbN8JJ2Gqor1Wsr1Wyb1wN5bWK5bVK9o2robpWsbpW6b5xNVTXKlbXKt03robqWsXqWqX7xtVQXqtYXivbN8LB5mqor1Wsr5XVF5yzrob6WpG06ir5okBilWZWF6k35X6K7w7+rb9dJF+W+43eT9Kri/T43v1G7ycZ1oVKvjL3G72fJFkXnXxMIrMM0qwLkmddmFTZu5/o7STTuqjSpQ9SrQuSa10sM6UPsq0Lkm5d1JnSBwnXBcm4LlaZ0gc51wURn83Um0RqHqhvkNnv1GQkmmcJmNsn6rP5egNn1AKl92l+36bsjcb3A/XRFL/N2huD7wfqo1l+m7g3FWQEKM9PE/02d2+W+H6gP5rrt+l7A9s8gbL9NN1vM/ip+IH+aMbfJvFT8QP9kaS/sHl8A5tdAdL+guT9hU3lQ6IlQOJfkMy/sNn8Cjc+IPkvSPZf2Ix+JaB8AAAQhAAImZwlCIAABGEAwub1E08PxEcwgLCp/UTjA0iAIChA2Ox+JSHvATBAEBogbIK/UoBDCIADBOEBwqb4Kzg/E4AICIIEhEpOGwRgAoJAAaHS0gNUQBAsIFSm3wVgQBAyIGy2P1H4AA4IQgeETfjjwgd4QBA+IGzKv4ITNgEIgSCIQKjkPEIARiAIJBA2758ofKA8ggmEynS7ABQIQgqETf4nCg8oj7ACYfP/FZyBCYALBOEFwiIAXHgAGAhCDISFALjwADIQhBkInZ65CoANBOEGwqKAhHIBORAEHQhLA3DhA3YgCDwQlgdUmI8DfCAIPxBpgCAAQRAEIQhLBRKFD5RHIILQ6amsABhBEI4gLBqo8IABkARBUIIwaekBliAITBAmLT1AEwTBCcJkpAeAgiBEQVhKUOHhBoAKglAFYdKTDYAVBOEKwrKCxNMD5RG0IEw6PScAXRAELwhLDBIVDwAGQQiDMOlWDyAGQRiDsNhgiQdbgDIIghlElZYe4AyCgAZh4QGe6QHUIAhrEJYf4HcHaIMguEFYgrDEEy0AHAQhDqJKKw8gB0GYg7AYYYlfPaAOgmAHYUnCEi+kAuBBEPIgHHrAYzUAHwShD8IShSUebgAAIQiBEBYqLHGPCxiEIBBCWK6wxPMcgCEE4RDCooUlbnYBiRAERQhLF5aQZwoAIwShEcIShnqB7wfyI0RCOCQhnumq1Q99fqA/QiWEBQ21xPcD/REwISxrqNumRz6vxIrcj1a1Ef1Z3FBrfD/QH8ETwhKH2uD7gf4IoRCWOtQVvB9ACkEohXCYYgnzPABUCEIqhIUPdQ3LH7AKQWCFsPyhXuF1gUB/hFcIiyBWC3w/0B9BFsJSiJXA9wP9EWohLImAy+UE4BaCgAthYQRcMScAuhCEXQiLI1Z4DSugF4LgC2GJRKr0gfoIwRAWSiRKHzAMQSCGsFwiUfoAYwjCMYRlEytcewHKEIRlCMsnVrj3ADhDEJ4hLKJIlB8gGoIgDWEpRar8gPoI1RAWVKTKD8iPgA1hWcUK934AbQjCNoTFFYnWG9ANQfCGsMgi0XoDwiEI4pAOccD3LwHjkIRxSMsscOstAeOQhHFIyyxw6y0B45CEcUjLLHDrLQHjkIRxSMsscOstAeOQhHFICy1w6y0B5JAEckhLLVZw9CMB5ZCEckhLLVZL7B+s+iWUQ1pqsarR6EMCyiEJ5ZCWWqzg6EcCyiEJ5ZD97gU4/JEAc0iCOaTbwbBoa1A79VoIYgCtMCcKdLsYFrAKSQA6JAEd0u1kWChsAGiQkA7pdjMsICqRAHVIgjqk29GwMGjZOEAdkqAO6TY1LCr8BECFhHVIt7FhgWUIYIcksEO6zQ0LXI8A7ZCEdki3wWGBhQhwh6R7HNwmB4GFiLY50H0ObqODgMRBoq0Og70OdiICJ4ISbncgOrQEQwhI/CTa80A3PViGIQREfhLte6AbHyzFEHhfjkSbH+juB4sxhDDYABAi3QJhOYYQFX4EIES6DcKSDCGWsDlBOyHoVgiLMoTASka7IQj7kG4/hFhBA4B+SEI/pNsT0Y2okQEgRMI/pHL7uuCgRAIAIgkAkRZoCImbVEBAJCEg0iINIbESAQORhIFIyzSE1DgCoEQCQaSlGiKxpwVgEEkwiLRcA2bkJMAgkmAQabFGol8HGEQSDCIt10j064CDSMJBpOUaiX4dcBBJOIjUItOvAxIiCQmRWmb6dcBCJGEhUqtMvw5giCQwRGqd6dcBDZGEhkhtMv064CGS8BCpq3S/DniIJDxE6mWmXwdERBIiInWd6dcBE5GEiUi9yvTrAIpIAkWkWWT6dUBFJKEi0ohMvw64iCRcRFrQkerXARmRhIxISzoS/TogI5KQEWl0pl8HaEQSNCKNyfTrAI5IAkekqTL9OsAjkuARaZaZfh3wEUn4iDR1pl8HgEQSQCLNKtOvA0QiCSKR1SLTrwNGIgkjkZXI9OuAkkhCSWQlM/064CSScBJZqUy/DkiJJKREVjrTrwNUIgkqkZXJ9OsAlkgCS2RVZfp1QEskoSXS0g+BN31KgEskwSXS4g8hcZMIeIkkvERa/oEzbhLwEkl4ibT8o/vKAQoAABNJgIm0AASnnCQAJpIAE2kBCE45SQBMJAEm0gKQRMoJABNJgIl0wASnnAAwkQSYSAdMcMoJABNJgIl0wASnnAAwkQSYSAdMcMoJABNJgIl0wCTx/oEACTCRFoDg/emAl0jCS6TlH3iLOsAlkuASWbvZCT4QAPASSXiJrGWmAgJgIgkwkRaAJCogACaSABNZ60wFBMREEmIi6zSxk4CYSEJMZJ0mdhIgE0mQiazTxE4CZiIJM5F1mthJwEwkYSayThM7CZiJJMxErtLETgJmIgkzkas0sZOAmUjCTOQqTewkYCaSMBNpGQiugACZSIJMpEUguAICYiIJMZGWgAi8mV4CZCIJMpGr5PpACYiJJMRErpJbjSQAJpIAE2kBiFB4OA6IiSTERFoCIvC2fAmQiSTIRFkEggfDCiATRZCJWiT3tSlATBQhJmqRXKelADBRBJioRXKxjAK8RBFeoiz/wKstFOAlivAStTDp16cAMFEEmKhFUn0K8BJFeImy/EMofH4VACaKABO1cPqDxFMBYqIIMVGWgKRKEBxmQYiJcsQEHzigADFRhJioHDFRgJgoQkyUSCeqFQAmigAT5YAJng0qAEwUASaqByYoL6IAL1GElyiRyVMrAEwUASbKARM8m1QAmCgCTJRIjwEV4CWK8BLleImCu0MU4CWK8BLleInCMgS8RBFeohwv6Q6QAAYAL1GElyiLP/AoRAFcogguUTJNjhXAJYrgEuVwSXcQBXoAoEKCS5SlH3gYogAtUYSWKEdLcHZOAVqiCC1Rjpbg7JwCtEQRWqIcLcHZOQVoiSK0RDlaohe4DIEMCS1RjpbgHKsCtETRw6NUJi2j0PlR9AAplUnLKHSGFD1EytESDU+PUegcqcFBUlaI3SkdyAA6TIoI0dGS7ugJZAAokZ4o1dMSmFlS6FApeqpUT0vglEShg6XoyVLuaCmcmlLocCl6upQ7XkrjJh0dMEVPmLIARGjcKaFDpggxUZaA4FmRAsREEWKiemKCyxAQE0WIiXJ7R3BrAICJIsBEOWCCc2sKABNFgIlywETjTgkAE0WAiXLABE/tFQAmigATZQEIntorAEwUASbKARM8tVcAmCgCTJTlH3BqpwAuUQSXKEs/4NROAViiCCxRDpbgMw0UgCWKwBLVwxI8rgGwRBFYoiz7SIxrACtRhJUok87NKMBKFGElyrESfNKAAqxEEVaielaSKAF0vh6RoEUfqRIAEiSoRDlUkhjZAVSiCCpRDpUkRnYAlSiCSpRDJYmRHUAliqASVaXXFCpAShQhJcqCj8TIDoASRUCJcqAkMbIDoEQRUKKq9KJCBTiJIpxEOU6SGNkBTqIIJ1GOkyRGdoCTKMJJlOMkiZEd4CSKcBLlOEliZAc4iSKcRDlOkhjZAU6iCCdRVWYhjQKgRBFQopaZhTQKgBJFQImy4CM1sgOkRBFSopYyM7IDqEQRVKKWKjOyA6xEEVailjozsgOwRBFYopYmM7IDtEQRWqKWVWZkB3CJIrhELZeZkR3gJYrwErWsMyM7AEwUASbK7TDBIztATBQhJqpeZEZ2gJkowkyURSCJkR1AJoogE9UjEzyyA8hEEWSiapUZ2QFmoggzUY6Z4EN8FGAmijATVeeGhgCaKAJNVJ0ZGgJoogg0UXVuaAioiSLURNXu/G58iC3AJopgE1WnwbEC2EQRbKJW7qBluNFRAW6iCDdRq+QuTwWwiSLYRFkMIgzOGwJuogg3URaECKOwAaBCQk6URSHCaGwAqJCwE+XYicFHIAN2ogg7Uav0ii4F4Iki8ESt3BHM+BhlgE8UwSfK4ROzxAaACgk+UQ6fmBobQIcx09OYnQzhlh8N+Ikm/EQv3JnfcM+PBgRFE4KiLRIRFdz0owFD0YShaAtFBN6urQFF0YSiaEtFRAWVrAFG0QSjaIdRKri0UAOMoglG0WmMogFG0QSjaIdRMEPQAKNoglG0O10LLuvTgKJoQlG0pSL4eB8NKIomFEU7ioJPSdGAomhCUbSjKPikEA0oiiYURbt9J/i0Cw0wiiYYRTuMgg+M0ACjaIJRtMMo+MwFDTiKJhxFi+RxHxpQFE0oinYUBR87oAFF0YSi6P57GrBH0wCjaIJRtMMoS3xEO8AommAU7TAK3n2vAUbRBKNoh1Hw9nsNMIomGEW7bSe4V9WAo2jCUbSU6V5VA5CiCUjRDqTgXlUDkKIJSNFu3wnuVTUgKZqQFC3T+580ACmagBTtQAruVTUAKZqAFO1ACu5VNQApmoAU7UAK7lU1ACmagBTtQEqiVwUgRROQoh1ISfSqAKRoAlJ0/ykO3KsCkKIJSNEOpCR6VQBSNAEp2oGURK8KQIomIEU7kLKEZw5qAFI0ASlaJY8C0QCjaIJRtMMoiV4VYBRNMIp2GGUJl0lrgFE0wSjaYZRudQIyAHRIMIp2GGUJN55ogFE0/ViHdg0iHhmgD3bQL3Y4joIP1NDoox30qx1u50mNxxbowx30yx0OpNRwwb5GX+8YfL7D6rBOfMADfcGD6NCBlBoPD9FXPOhnPNzOkxrXBPQlD/opD0dSaqxE9DkP+j0Pt/WkxkpEn/Sg3/RwW09qrET0WQ9CU7SjKTVWIqApmtAU7WjKCisR0BRNaIp2W09WWIkAp2iCU7TFI2KFlQh4iiY8RTuessJKBDxFE56iHU9ZYSUCnqIJT9Fu78kKKxEAFU2AinZAZYWVCICKJkBFO6CywkoEQEUToKIdUEkM0QBQ0QSoaLf3JDFEA0RFE6Ki3d6TxBANIBVNkIp2SCUxRANIRROkot3eEzxEA0hFE6SiHVJJDNEAUtEEqWiHVBJDNIBUNEEq2iGVxBANIBVNkIp2SCUxRANIRROkoh1SSQzRAFLRBKloh1QSQzSAVDRBKtohlcQQDSAVTZCKdkglMUQDSEUTpKIdUlnhSS9AKpogFZ05rksDoqIJUdGZ47o0ACqaABWdOa5LA56iCU/RmeO6NMApmuAUnTmuSwOaoglN0ZnjujSAKZrAFJ05rksDmKIJTNGZ47o0YCmasBSdOa5LA5aiCUvRmeO6NEApmqAUnTmuSwOSoglJ0ZnjujQAKZqAFJ05rksDjqIJR9Hp47o0wCiaYBSdPq5LA4iiCUTRlongQ+01YCiaMBRtmQg+1F4DhqIJQ9EWieBD7TVAKJogFG2ZCD7UXgOGoglD0RaJ4EPhNUAomiAUbYkIPhReA4KiCUHRjqCscMoQEBRNCIq2QEQucM4PEBRNCIpeOf3hnB9AKJogFG2JiFzgnB9AKJogFL3KHBGiAULRBKFod2YXboIAQdGEoBhHUPASIQMIiiEExTiCgpcIGUBQDCEoxhEUvETIAIJiCEExi/QeUAMAiiEAxbhju2AvYgA/MYSfmH4bClwiZAA/MYSfmEV6E6gBAMUQgGIWmaMZDAAohgAUs8gczWAAQTGEoJhF5mgGAxCKIQjFOISClwgZgFAMQSim34gClwgZgFAMQSjGIRS8RMgAhGIIQjH9ThS4RMgAhGIIQjH9h8jhEiEDEIohCMW4rSh4iZABEMUQiGIcRMFLhAyAKIZAFOMgCl4iZABEMQSiGAdR8BIhAyCKIRDFOIiClwgZAFEMgSjGQRS8RMgAiGIIRDEOouAlQgZAFEMginGbUeCo2ACGYghDMTJzWI0BDMUQhmIsEsFLhAxAKIYgFCMzByYZwFAMYSjGMRS8RMgAhmIIQzGOoeAVPgYwFEMYirFIBK+PMQChGIJQjEMoeIWPAQjFEIRiLBGRC1wVAUIxBKEYlVxgYwBAMQSgGPc98wVkiQYAFEMAilFuYzL+ljEAKIYAFOM+bL7A3zMGAMUQgGLcx80XEIobgFAMQSjGfeB8kfiuMZAhQShGZVY2GIBQDEEopkcoMN9oAEIxBKGYHqHAfKMBCMUQhGJ6hAIz3wYgFEMQinEIBSdJDEAohiAU0yMUmCUxAKEYglBMj1Bg5tsAhGIIQjE9QoEzRQMQiiEIxfQIBU4VDUAohiAU0yMUOFc0AKEYglBMj1DgZNEAhGIIQjE9QsFKBAjFEIRieoSClQgQiqGfRu8RClYi+jo6/Ty6QyiYwRj0hXT6ifQeoWAloq+k08+k9wgFKxF9KZ1+Kr1HKFiJ6HPpg++lO4SClQg/mU6U2CMUrET03XT64fQeoWAloo+n06+n9wgFKxF9QJ1+Qd0hFMxgDPqIOkEopkcoMHNtAEIxBKGYHqHAzLUBCMUQhGJ6hAIZjAEIxRCEYhxCwQzGAIZiCEMxVXrbvAEIxRCEYnqEAhmMAQjFEIRieoQCGYwBCMUQhGJ6hAIZjAEIxRCEYhxCwQzGAIRiCEIxPUKB+VcDEIohCMX0CAUmYA1AKIYgFNMjFKxkgFAMQSjGIRTMYAxAKIYgFLN0w0Q8zgUMxRCGYtyuFDxdAwzFEIZiliYXABAigSjGbUrBC30MoCiGUBTjNqXg9bcGYBRDMIpZuo2iMJFqAEcxhKMYd4qXgIlUA0CKISDF9Od4wUSqASTFEJJiLBmRAiZSDUAphqAUY9GIFHDxpAEsxRCWYiwbkQJPeABMMQSmmNodpYQnPICmGEJTjKUjUuAJD8AphuAU43CKwBMeAFQMASqmByp4wgOQiiFIxVhEIgVWImAqhjAVYxmJlFiJAKoYAlWMhSRSYiUCqmIIVTGWkkiJlQiwiiFYxVhMIiVWIuAqhnAV4470kliJAKwYAlaMO9QLnzdtAFgxBKwYB1bwwZYGgBVDwIpxYEViJQKwYghYMQ6sSKxEAFYMASvGchKJjwY0AKwYAlaMBSUSH21mAFkxhKxUFpRIBZVYAbJSEbJSWVAi8eFiFSAr/t/+9ezJZvtrsz82N2+2N83vT/7y889Prq6OXx6aJ8/+/eRq4/6xbeqsoyd/+fcTodv//ufZk+58MfuHrpts/9D+qffo/tn7sr91ztc3N5FNFRjtTqti2vh4t/sY2Vmuzna6VZkuKC24Bm/Wx3WlH/ebyGq9CK0Kb1WyrW72zfVxt/8Sx7oMrKq6t6pWXKu3m7v4xdQ6DNP4MKsSg4cvh2PT/UCCrU1ou/K2l+W2P6+3NzTwKjS+9MbZMvh8PD5c77bH7p8juzK0q7xdtkT3zfpm/ZEGq0Kj2hs1XKPH5vc4ymUd6mDlDS64Bh8322O93u/X5I2JME7pzSqe2YeHZhtVURWa66uA15hmatYabWwlC00vwxal4r31ruZ3r6fZh5Z08G4qnjY7Q7/tN8fYUBXIvfs4NcvS4+1ts29urLW4dQtqeneImWszja/yC17zdP25uf7lYX04/Lbbx61nFep80eu825rg/rA8Nc4THO22d5GuQll133G0JrpPgtk/yGUvje7A2N47r/Ss08Pm03Z9fNxHxRfW4u7Lj73HlfcovcfKe+S1eNefN3dtFd9GRWmCpqjbuOosSm+68vW94j7V47Z9qj9iPSzDB+LZudttYxsm1JQv/m5PTx+ob/4rZmHc7Q6Rg2UUpPD9/KnD51X5691Nc304tjX1PmpMgupleA1d++vHzbbpyrLZXUf6N2Fl9UOSbtkS0+496TeWoeCq/tV3nzpyfzB9BevOlCzw0GzbwthsP4WeVsHAovuoZS/thf+Dr0M1r8vqf3083taRVkTQLHYfTOqfgynh3f3DvjkcmpuBjhdBwy19wUtmV+jtbnbb++b4eRc3aTI0rfpykP5lKN+Zd6dEOJ3LYq9DWYqgJ5ZcWW5vN58e9+tjazEunODVltmKCjkww7bSPtljN96MRH2207cRyncUC99h+PbTNx3u/1VfxFXfyCz7F1339/l2d9Vf51tmsfC9g5ecUF7ZyjfjfighvNfum/D9H/ztlf8X36h15zn3zZD/w8oPSfy/aC+aDlGzyq1VQ/cS29EJUXmoCuE7Ou27cd/kKi9Ow2wb6TCoS+wHTbp/G77d6TZU9O+F90CnuQwYJwW1a8kbEZ6sgcFS0GcK5ri1M3fTHK73mwci1G4h0rkYvEiV7+a7xUflDuDAQoTDxe5Ayt6TnygIXtfZeXKTmug5ohaMN6ht+8q2v6QThFU44qpPIy5fKXxd0DWzYJp8G7gK1c60eHtHK03YJfuQa19pfUHzrMPJ80KEYfpBp5/mKHFqDvyAyLc4hu328Mv28f5jsz8c1/t4xibD/tTrRjKHhHYcMHjJ3aqlsxb9tLI7w6jv3nhabI3vvzwcm7gzXciwsPw45tSH+jZY+Ra9W9lV4K3X0fbT8XM87QmkpKT35rsTs+CWF81FSBMWP7dgWitdTd1tH/a7T538dy7y+C2EITNHXdb0p+bYWY+nTsCBDKtXzatfoQNoM5COZE57rc123LWmvdAqNLYoKNx8wZpFWLC85rDZ768+rm+ubnf7+3VUW2Q4uuqoEtfcdRfq+u7q1KhcbXfH1sFjnOyQ4YjZ1Lxxfmf/5vHhbnPdNoY3V/b20KYMmiyz4nWTnU1YpzveE0TIrEqdtXbytL+627VB7vZXf2weKp0qAxl6YEr15CFhMyyDuqAMfm9f2+2mubvJhxzOK7nVtzXfJRCv9uvtp/iNLVahyvii3Wx/Xd9tbq7A3LIjRIEK+KXqbZ7b3CvU6HbsI7DPbAwi+21dxpHr0DKzhxhYHlaLsKqt+FXtZPYsDdqWdSQpsM1szLBtikFk2OqaFb8Cetsok9cRzEDA/HbNG4XjXBmO6UxB4+ut/toOgsj0VoadcAcC2TbbyYNterpR6F3TtZTH3e7qsCP2w3xzteC3FF3LdnfV4Yarz3bek2oqQjXXfDUf2gb+2DVCV5S/dNAvKBL+y2tDa24327YkHrfnbMsVTbd0SC8oEn7T8bg9PD487DqwdxWM/ePiCJuNmt9shLbPTVNsOqyENb8ShqbBECAcSZkVU9S/tn/7uG5L1yYmI3vh+JvZCp2stXK423zcr+OBajROZcrh9+6BB1hzFTIn008ODDOB52xisrkKkaFPuBjDfEnWcAI/rUJg6FNJ3aJMvuUu0zDAb+H4VBufqjLM92/ttm8rNhmC2BOVMdw3drRQ67i5b9qZ4n1sWofDXuknwJUPm5kY7Hzst+u7rsVZH4/7zcdHMt0ORxXS50ykpxXKT36VBzZGcAus7QCvjylyF4Jx4fOCmrkGoLfdNkcJLLgKjZ+Sk8ym+tRzx5nwsEp6qiO9jLqPPHGMd++BjmNWUe7YZwmZNN8bRIygDovB5wNE7ZOsK1/qzD7MuxpAgkXwLqXoMwGSuXSCLB242/wSFU7YyhTac5k1ajAcfDANkv5/EfZKTMJ7e/d4iEbbKloL4F8Ez9Zuf93YKce++b/HtumI5sthKlj4jI1mDghvD/GThgNsdWLBPrPE5LOfmmG3FCZ+teAppbPzZUPeRTj4YCZ0WjsW4H78Qmtit+8pWFDh21rFey99niXKb4cvwzfiwuf9hF+yIfxyCGE8m/bONTNp3Tsf9tNV2EUxuWNrrKuMmyaSwzLMzFY8QZ0tfWq2bvgemQzz/0tel3Y2CbJF4ahEMGearcHbx7u7gRhMoC3l0ZT2b1GfoA0zb9a6uW97ejobDEEC186+uVsfN78OepJua0CwnMPTOeljP40emEtlWleDbHO4vkUzRyGtncRYrwpXMDH70NYaHN9V4cMLXm/xeX243u33j12SDEhehM20WvBetJs8xo1yuCRCeILp1/NoplC7XBPQvAkpD/ONdKZsF4Ls1aE95jN7e0NiaCKczXwtnbkhewxeMHPaFncX3f6loEr7btcDBu1xsal47eTmHs656rDJ1X5WwFzq5mwmVpOGtcVjZMNcBuMMpxY8hutJtAfp3XZCvmm45jFEkNp4gGN4gnd2U6sUw+pu/ODE8MYSzvJgOheuhvOLdYzhaXazHbLMsHs7LT9z/1cndMa0voleWLgw8FSsvWm/2MGvvVr2zb6fAvgZgF8kJBbS/8EPUfwER/ilgMIvMxYe/gkvQOFLSjDn6N2zbNZ3mz+oWlSYGGW+yNbW4fPmfn34sr0epGbClpFpbnS+HOJjXzqy8ozSj9uUX25oBLPeH7o1B+10dr097m5jFYV1c+H5tB+Pa7+6xjDHZJuDTyA/7HfH5poy3yqssl4a2utVV77dYY7Xfmmatq6Rprw7fSlIb3iu7xVsFryG5259OK6vr5vDYbj2JqggUvRvRfrWWHmBq9NyR+begc7l/e5m6C+kn76yS782SUnj/fkcHHM0cdf82tzFRRfmG09LI04JLWbG+379O00ThzoTkvcGWjOtkn4h4x0RDUl4hsDYWIZrNTSTwtzvfiVGwlZF8Rrz+8PN7tBlvNtxNu3SQtIifbWQfnGC8qvHlM9qGeYYajiaD5cz+TVyWp6W0PvKUvHe+O729tDE64PCOuLXu0jf0qvTmpjajwckr/TsUriYp4XVnTej3W3JPgIRGpF+abr0i1/Vqa7VviowU+fn9QdR4YRz99WpofcT9Pq0Bsa3JKfVvX5Zo/IdrWGu4upWwwxWDIXvyDf10i9eVT5zoPzyLiN5antY7+kYMFwNrU4riP0STH1aflPxRm9dL3P8vN89fooyX+FeI7H0D+S7NelrjaxPMjyt+vLzJX+XYTZSCJiGm3GEHyFJP2eWPskl61ML7gdsfjWlXp6aXGaBJPPVYSzMdEJrrINIg9X34eRD+Ior/ep7eXpSvwpQ+b5R+WGkMqd1gb6pYSLJPqZuAtynJqOJYPjihZ9zMZezPJD8aVgtmG36fv0bWJwgwsUq0k8FJXPQ39lMrf4NO0Hp1SOZU6rWcApEhAMNv4RYMjFWaxYiiHBt2cI3ccwFua3NzDgsXG8l/UBPMkf3vWk43opWm/qQmXPh1i5sE8IMp29tpB8CS4/ApG/XlV9hrXzmQC9PI1imgMCkOejmTsmD/v/96/bTDd8b+ch8hfWNll8KLny7Jvwid+Fbc+m3KinmugAf8TA/o6JkPNsYMRLCed8HMcfmzhpIaclwHatmrm3qrOHcg45WmPSvoi9Yv9rc91F+eOK35vhF12Jxeje8xnXffNoc2tlpatF4uLKY+4AujdwOcuO2NQR6mrlAad8MB94ha1NcQQyGwSFE0b4j06c9KD7LYZbMlrV5uFtfN8MN4OFDMxfw97Zwti7cDKaZ1Lw3CFNp4WZXzdxk1Nsb7hyO9uRy5WJtJdJx4RhGM3Me+90uXpkTbgszzLU0duFaNEMON4ULvzJd+vomfWZG+iqp/BBX+XZVn9azM9cx410i4Uox6TMA0g+vFBPt0Wm6jlb69a1P/wR+VuSf0c8T/GDa57yFH28LZhrCLl7rdA7S8sFQjLks9WQNbAkK6QOzO7fm/tggZBBIgbnU2RsDoYVDa+bhCP1CNLv02FoenL0Q7qhSp7n3aW7BrOgw/RkuK2SuJ2kf+X7TSrkBWZ1woDzFWLfQafdIprdhyolp9PcjeNHhCkeeCDtD4CWHsxRmAqEdp28Pt91+n25PVFRmIbIRvjZKv79Rnua/p/QOc8uAc7nbxzuwwnWekjlpO1ly0dP1MkEF4in+3D+AtxSMCJh7L87mwLsKFzgxZ2zhQtnhtuRwkZfffSZPGZ7ToTWnnXO+Ude+5zAVM4z9XVveZMGWDsTCHKQ+Hm7+iJuTMInjF5ioc8aEVzceD/m9fjEF6cvJj2z97EOe+l7f7SjPjDRzoXAbh8XKn4dYOWw5Tpv2mEvUW7OP203XXvrZMNnMJcJC9JO800iTubig9fJb8xE1pNGc2A8LfOn54clpAro6pRr92hPmWug2gN8/x6UWDo1O2ys9RNDMTRRgVb+IdsD7FSfSz47UaevmCR8xm/ve1337/j/GI85ov6m3L/1MXJ0A6+kQE+b6EvfCktvzowWzPCH0ErA7isn6kuB1MKMDS1/CdRH9K/X5JnHSlS8P4RGl8Pl94XUlfApQmFOawGvPZ0EUM9np4xy22uEiJcEc3oC2P0RMpxUczLm0NYcnMlU0IvFFpU7Q2w+gmQk3O/CLZRsm9P1qMulhjhInnOD1e8qCMNe8tC7tbopd3LWF+QGffZWn7cK+xqoTTWZyu9Yb2MUdDkSYp511hvzeymawczdcfKj9AkrDPK9nYNqt5ke7TcNMqGZuThqYPy+1gS7CVTzMpEXrYlgm4cIvxcyjt4a6Lm9oLBz3aj8+NUteN91aBctfwqP5mNOlxHaYcG8129Bw+BlmPQRzoHYyFJyOAt5qeBSb4L9UZzq/pDVskJjjm5NlZC9McjNHmSd7w5FgmDYTTBINZ9ci3Lcn/blUirnX/2SyP4oRVbzw7CjFXCh5smtBG9z4H5IoZsLibDUrKqEjbM4WrLMNTugIEwKSk9j917MnD23Tc7fZtvf8/K///Of/ATR30ieAHgIA"; \ No newline at end of file +window.searchData = "H4sIAAAAAAAAE72dXZPbNrKG/4tz6+MVvigpd17b2bgqsVO2c87ZTW1NyTMcW5UZaY6kSeJs7X8/JEBQQPMF2CDlvUlsi+xugi+++gHAfz057H8/Pvn2l389+XW7u3nybaWfPtlt7usn3z653u9ut58eD/WTp08eD3fNv9w+7q5P2/3u+Jf+t2efT/d3zQXXd5vjsW4sPXny76fA2Ha3Pb3/vL1/fvyyu36xv6mvgdXhRVzzp/pwv91tTvX/7A+/1ocjME4v4Zr+VJ9+3N7XH748oIIIfs0alKbqLX63vavffzme6vtXu9Phyw/bX8+Wt7smztvNdX38C7hsgovvN7ubu3rcx/m6rBMhV72TD4fN7ni7P9y/Px3qzX3ko7v5L+CarH0jZCjA4+nweH3aH9h2v4lvCnw8ffKwOdS7UyLw4BEX8vz2m99vNh/v+A/2TXDHbO+/H7anMu/BHVO8hxp60dXxTat0JJ7ogrxqwoe63/xBa2nW6DfNDb/3N+CnimNNOCYtwIem3u4fT8wg+ptdKKf+5hkBOVPvrw/bhxO3MLqS6O8pc18Zo85v+OrqFLZqBY77Oxnun8WPmSiLm/r2rind6cGcDRTH9Kx7nERo293M0M4GLh3a9efH3a/vt39yg7PXH931M4T7suhlFb2ZlMvXRS+hqMRTLl/s7x8O9fHYXOIaS24hn+87+vtmFfb1xEBu6guH8nis/6f+WNZ6N/f8Xn9EDfjpePNf2+N/bXef66bXqm+mhDP1HTW35stmSnBh7+kKabQPBZfxe9LR15Gynnkp4XOiZ5j5KnIR8cWaDyx8DYf607YZ3h5ebk4bN8Q9oLDAZeyx9k3e9M0Ek69+a57zr5tjffOP7cMP24+HzeELso2u48sn04onDY825jD08jY9HcBY0z4WQDCBOV8az0j9KJv8fpGJC7LJmrTQYAPlLPT5mR4ej595TrsrZ3nb71p58/z11xZ7DGpGvj5cuBaUan+W4kt1Pqru94NMi38971npFa6iY2ssLZ9DS+hq8/BQ727GXPVX8b2EBdSUIH353tH5p4sUETHHKqMgukQh3d6huk59+aumekm8CuoGvIvcEAr6JS+HVpbAdffTpV5OaI77cnx0pS8n8jX6cka8pF9O5Kb85Qz9hi/H1ioyyPO+g9/Y453Xu+1pu7nb/hklu4LGMbogbzYsnjahzDP3TXcpfhFxfPgZ3nV5v/b/eCQYX8HvoQY5yLzN8QwkCRW/Y/Ic/vUygudWvDBmTqUbhsvK1BYXTdrHMcy0IPvZ1MrAdlqryHZWoXnb7WP/3Khm9fxw2HwZLaHH9tJNdym3nEIwUP9xSsjn/NNlMEBsjpf9P0dXnPQn7qCcci3ruG8oMep3ILNin+PSoz4H8pvnc0SSqKQTsiwv70Cqf73bf0xI9fzTRaRKzLGkGkRXKlXqrliq476hVKnfIqlCn+NSpT6LpDruc0SqqKQnSBWXdyDVNjdV6Z/fvU7olfx+EdEimyzl0mBL5QsdF2uYGQUUMoygSM1p7+OSht6LdM30PiLu5HuYoPDM2whkfg4moXN6wUWEDo2ylD6It1Tq2HWx1rlxQLHjGIrUnvE/Lnfsv0jvXP8jgk+/jQmKz72TMFP3cLc9NZPuhODjny+Tsxua5CXu4khLpY7cFgudFwOUOfJfJPKk73GJI99FAuf5HpF36g1MEHf6PVBptw1/Ttvn3y8nbmKTr+4g2Enypo6n6Xs8irTAaQTlCofemRKn3ss1Pu6dI3L0HqaqHEcUJP9+fvfD+9Nhu/uEcnT9j+yVld+fTqnO4PzTReoKMceqJkF0pTWEuiuuHOO+Yb2gfouqBPQ5Xhuoz6KKMO5zpA6gkp4gf1zeVKqb3Sea947iOP9+OdESm3zlBsFOki91PE3D41GkhUwjKFcz9M6UNPVerutx7xxxo/cwVeE4oqCBb696+2DX/KMmPvi5aPmWdfx9XHMyZttVUof2ls/+lrTOfbQJ57f7w3XdPff/PdZHvAB5EIC9zYZwON82OYiHQ92u+mgLoIuCFUR3W1sIh/62yUFc7+8/bnd1u4r21f76hhVBd09b8Wp3z2T3zSv93+/fcd/+H58PRcoece50xHv152vnuKeVykpwpGaF1xRVr0zBDmyi0oXtxLwiHfpF5cp0HC047XZ+tP/HrUl8Bb8gB7tQ8jbH96CQUNP7RFIr25HX5vIsfU07DUYzpPB8f8MoMe7YJQyZM2TJl1Fyg1Dx+ygcCYT2s2A6b7sNrc509PQxagaaznv8VNvZXNZTc012qWJWQi1yTMjo/NPF4HepnILoivecEXdQVmMwdoLUqN9iED1PguixUzKcF0lKmjQCJM9izxSCJyR7/uliELxUskF0pZKl7kZbQuiLB6DZLeK4j5QQqJuxdgqXHELKibdPfr8sUi7VAQ22VAzQcXEjlo6iAOpObs6Y3sfatGRRTGnYmDGlRA1jKW3iMtoAnC2h9vjni3K2Uq2TSEuljtwWKz0ZA591TdZ5+vkRW8q9z/Pvl2VLk95oEOykV0odj/Znaa8FNIfds2WeES7wSLw3esGFF3iUvrlBvKWvDrsuro+ZOEoWWEyuk1z/Y51Pujim9D7cqFLdD46mtP/JaSTe1OKyzIm9E+T3iwgf2eTucYmCLYUl0DGEJRO8Jisb9DraTma8oteX9nrZVzbhZWWy3PftpaO+/GUT/Twc6navUX0Daxvx1l+cncaM+nTbm3gu/bXFHmlr8mp3Omzr45i/5sq6v3K2t7/Vu/qwYWjm7PZTcMtE/9d3+2OmpnXK6S4q8BHv63W/vziLPUMFMpfz89r1H6fD5vr0E1RsgbNvOkOFagZPmg/0OZL5hDjLqgA/zOvP9fWvPzXGft8fbt7u7lJbtPNBWisPnZW9s8LrhKeG/H77abc5hQfdFcd7DEx8tWB9oUwKM7j5qwb44fNh//jp8+QYT/39Xy3Mw+b3n+YUZXP/f6I0rabuJkXY3/r1XrVD8C+inqHoXTsDw17jwoGe7Hl3fmA3qTP5xts49ja+Wri327u6/eOr3fX+JrGecDReb6Q+G/l6LagbMM6Kt7PxlcKNhjLtkVg3dUtEJkXqbj+5279amY6e6zQa57RDt6aFyjr3iRPx9AO5mEJA482/9WNrznBzcDV/tFlUs7GfC1Ts4eNeoF4nop1drXPBTqnViTjnVGp2iPvdw2H/qZX3lBCjuy8ZYlAlWDXhK1eAKboPH/qS8p6gam4oBeIt0yw7ANQUchrA4rdeNiksmAlCrV9uused400JgzWRG5+9TXXNmaKx5mVTAuBOvlgzrikBMKZVY3OpSQXPnTDxZklTQiiZCrHnP8xAotMt2+Psf6xPm1QiK7qA39Tsb2+PNWxEhwa/6S/GjxLHONKjMV0Gl89w2tSF78r8NndcxrW38vOH71aFz/x4ul3Nc36zPdTtuB4fhDr0HF4/w23Tzx++PLixFcdteP0Mt39uH160dvZMt8311/76GW79FKy+SS29Br7PN2UXYLMCeNxNCiG8bX4QzZ2nH/dtnp3rv73jft9m1C/g+vl14+VY6H1jb5ofwHXTxLeNd4F7f8t8501L9UNx2Tc3Xaz4uwCK30AXw6VeQmPuRfl7aO663KugvHi0CchiY/ZTF3ltH/gSjjsjBd1ad8f8Xu2Ym4wAx+OTEF6v1pLA77b1Hbtba2+47W6Y945flfpu7rmU+6abrDS/S7XXznD3WzNmThz8Dxyer57v8sdmGP5X7lCpu+e+uefjzOHS/fHl/thmhJtmKLFlDARwf7zZH6/Du2aEYF01U7Z2lPz8dDpsPz6ym1B/bzts3QT3zqtqk8Px914wnJvt8dc3j/cf22ng5sBtadu7dvauY3fXBQaZrUzr0+c9tx0I7rv395WFMZiFJj1nZ53ZhYXQ0uhWDRfNtIltckKbSw9nHY5ObDMT2slOORPb/IR29vNmRwAjE9rJzscntrkJ7WS34xPb3IR2stvxiW1uQjvZLXNWOTqhnRwAe2LLmNBODoIzsc1PaGe5ZkyrRie00xXAmVCNTGjntG2cie3ohHZuAOw3kJ/QzgmDNbEdn9DOaQmyU8z0hHbWU7O8Jia0c5+V0a2lJrSTXY9PbHMT2um92vjkMjuhnfOOGRPbsQntnG41M7FNTWgnuxub2KYntHNdjkxsxya0k91zJ7bjE9rJIZRNbLkT2jlVrTic8QntjGE0b2I7PqGdPcgcn9hyJrQlYQwmtn9zs9LMkg5wGX/S2y6zyxUysPvN+Z6CZyTPMWlxVSai4lVVRUGFn2bixVPylaZ8KOWLcJJhTd+RURpidmlOPr6J4whecLkFO8mwivcIFAaUWcaTjal0h0VBWCOLe5JhTdlRURBWeslPMqLCHRQlr25kIVD63U3ZMVEQGGN5UDK2qTskCsIbXRSfDG7aYviy0FiL4HMRTl/8PtIlJUYGL6IugTdMQPdcfMyQdDJrAAEfd/ZoIhfrrKFFWbiMcUYu0qmDjpEg541A0gFfZjhSHDx7bDIS+byBSknY3FFLOuBZnXJpqMzxTD7aOYObkoALRjrpgOcOe0oC5o2B0rHOGBAVCaFgdJRRwtyhUknIheOmdNSXGESVBF40okqHPX94VRh08VgrG/tlBl5jjxCfIuMOCUofAhT+nh1gFZwoM7DJPVcmCjbVHGYOARo65hwCxPH6Z/IoP+i2ufx3f3mp32jE5Srq/sB7d9+El5f6rYxR5wH81dXpywOzkHuv/U0s38/6+85/usxbJwGVigAF9qx7tkR8uUOiRuPjnBlVHt/gpDR+fKUBpbwmT/MBLcTYvqNULUXNXdrlZZu4CY1bSkCfN8cX+8PhsV3+0rb2ifOeQr/NLdf+lno3evBT/tC6zc3NmD93yUT7I1IoEkF6d6n7/fnNzQiRSFzK3wCWXUmVs87YLJR6jvJVBtlAGOevlYSRx+HZSBhLrguD4SyByobE3uVTGFh2rUI2Itae4JJQkhw/G0YZ2S8MibFzNR3Z1GN+SgK8a1ykNvSmI/N3fZWQPj7eNhO5+sbeUxyav/v37u6vEuKvdf3w9pD48FQ2vPbO/YF+f+qSistkVvJqK82mFAY2vnk9HdvEU8OKWnu3VLebF+8+nVJ7/DOtfm/ieDbxVYLN7sMfaXG/Wr0dWSCbb1AmrNmcEF5+CedohBNWdJYOfUYWeObHP1PWe5YPiuz5lx+293VTIPcPU8ZG1sIpsPBVQs2ulh8bEhSuny8MLbMEMBtY6aLAaWGllwlygitcOFg6Dj7WP++27fk97dK5N80/Fk+H2sTlo7PhN6QUnQxVEm67b+llfbw+bB/CeTd7atX8w014+38gyLEjfrjRTjrWtSRsxqrSbLhT15lOaDFZSz1HW83piz8LQ2Yvls2GPG/5bOmI6PGhGVe3nz2ptP2URht7+QDJWbFTwmNr5Xb79YTxeLz5c0LbZW/6alOH/PlW+dnDhOOHJ4zQ8aY7zsC8YBteYWjpTabZuAq3nZan0cZXVI8l1CausR4PNcql2gMBc2dQZt/thAMoS4LLrL3Kv93CJVfFYY0cipmLbMqJmGXBJdZVjcRVspyqfOQ4ejBwdsw47VDgwhC5BwJnI511GPDYa0Z8wuY3OXQivJDPJsYTuwO7IyeQ4MjnJnGHUXDPIMwGM6XaD0OZU+lTgUEt7AfHSGcDHVx+UV1g62x1DJ9ltkYSERUqhR3YeII/FdEwyT8zFH5iPxVSOrk/MzReQj8VFk7qz1UUJ1le9MWSmQFxE/iln/6YGVZh4j75fZ988n5mkIyEfcH3SOY2CcxEfbJhYJwYODEsZoI+FxnjHMEJwbET88nvdHBOF5wi/6KEfObrVpmk/MwQeYn4TFc9cjrrhJA4CfhUQGNHzU0Ph5F4Hwlq5Bi6CaGVJtwz3yjJJt1nhlmQaE9+nyadbL9ocLwEOy/KgjU0/HBLEuupMLmnEk5s8cqy07lWj39E4IRQyxPpqVDHk+lzRyjFCfTkgGU0iT67SRpJnKfbIJI8v8AQnZMwL/1m32VGxCOJ8pGBcOYQ9gkhMRLkqXhGPjYwZSxXlBjPfHiNeaImL8QpCfHMOxz7wg0zKLoD2iYF+0xSJsGTvvpyu57T5mHyPXz8zMNM39mcjQdm3+aGlNu9nI2GJtrLA6HK4KtiliJGX8LMF5B7ZrI1w17fxxHsAHjVH1OUeqiCjRlnY9x9Ga9y5yzZ/+XddJdMs9+OT0fsd5dMs7+FuzoC69tsQ5y13V2Yt99fNM1HciE/9laybD/r9/rz9u6muXZMYufL2H7otpjd2EP5a6Z5+FSfvnu8u2MIubny9nzlZG/v6rtmFvObnfyOezx0V8/yuj2288Wmkd7sTm9vxxR/vOkv3t/O8OnTuz8d9qf6OhxAphz7hO5DcMdE3YSbgEdFGpxiMdnjoWZI6FD8Hkkn0U6jkh1F/+OlOovYILfDOMfI3hyW9snaDjbq8WC/hcZw11843ZelSRxf/YVFvmhzEo3q086aK8cG8Bxvf73bf+R5++iunOWtHTVW+ud3r3kub+zlj4ftXL8/N6PA1fPDYcNRaHP9Y3v9prt+lud2EpXahzz0+/thfB8yt5z5RTzL26F+uGtG10wddVfP1lJnh1lXuqtn15fOTomKu1suo+TOWJGau3supOjO2rvM6QTYP+dIgtGWONUhE5eDLnlkEct4/8arToO6NNcvnswQr9uiJXGjPtOTHOIXTHTm+uZMfkgUkz/mwIknNymiQyk0MZrgnzdZos4HE6a5nkcmUcN+BE6kLhDF2ORqGElygjU3mvFJF62Z6YnX/FhYk7FBQPkJ2Wy9jk3SBpUmNVGbG0l68jboni7SW8STupd+jpOc2cVXXGp6B6xy53gk5CkTPeSdNdtL+qaNwYu2kf3rl1RbgAJo7rJN88cvYxN1XhSbm5uXpYXQ3HPBcmispYa9Cedj416239QgP+F3bJTPL/HcgDtV4pwRNzuC/JA7EQJvzM2O4fvT6eHFfndKDM8SQXxu7rru75ofRW7onwiBM/Zn+4/WHYz7HltcUOT3/Zfjqb4vadR9CEd7Z93declovt/sbopLxIXz2d86M57tfbugo6RxcHdcpn1wtoqbCHfbBVsJZ7C8oXD3XbKtcBYnNBfuxou2GM5kaaPh7rpcu+HsNZeXBfDnNrvQlee7/qO0drg7LlM7nK3i2uFuu2DtcAbLa4e775K1w1nM5WXTcXDysyVRFCjS3TBVkaw0GnJbOjtiziMSCTU4hSjMqvEiwKk12BQUzUx53tNJNhRBeaaNFwUn3YbimZNz40WWS7zBSe6E7BuvniZTcDCM0jwce+abS8Ylpr1TMnLseMbScomYpubmmL38aIIO1u/JWTpuVKxUHQ5tVr6OqfCxpB2ucBMzd7yY0uk7FEx5Di8dRbxlOb7udT+uzu9cHrmLv4HZnhN7ffrpUD/Y7VcR1i33+U1n78Hbm9e1Dosj/xjPHy76FJuH/+hDsL6yw32E6d/ZmfkAY5uL+NFPOr9rYugje51ZQc9vrIrCze/7YEc84cykiUGPb99mBT3xKNaJQWf3TbPiLT/zdKooxk+A4Kli4qnPE8NmfIGHG/nUb/BMD95vJX3V7nfZ7j7Nid7bqs+2vnqL7Q6sv0T0namvG3w0hLupR7YoseJ2VkqP75pY3pwjoFhRTz4Nanrg3IOhuPHPOiNq+mO82+w+1d/Hi3unPcChtfR5uPr3K7U0+8O1C/5d/X+P9fE0Sz/Wmn2Aw9naf6iDagu/e4YLdFPtCzj01v4DDebH7a5uc1mv9tezxjGdqTa9VTtT/wH1/+/372aq/o/P/wm1u2o1S+JnE1+jI8rN4l/ZRHrJDD66gz9798munzbJM4fG/HzjbTxs8gcO5R4xdYzD9r7+EH7yrDC09v6xr59NCMtt2Jj3erpdH/veyCUD/DNzqtxoYH+Wfk1mQoDFMw0Q52VmGaxwcyfQjcZZ/KWZCQFyzqUbDXTyd2cmBDx2Wt1osJO+QjNFqSUJB6TS2ZkGXpNUmBpBDdIl0iKsYNnn3Y3GPO97NRNCL8jmgHDnZnJ4jdXo2XjjTda0b9lMDHb0xDxWvNO+bDMhZMY5eqMBT/3OzZTKxjxdb7yuzfnqzbRBTPbMPc5ApvwbOBMCzZ/ENxrmhC/iTA8yez4fN9Ty7+NMCJh/at9o2DO/ljMheNZZfqNxT/92zuyQyyDcaOwXIHG8CSPr3L/xeeP07+pMbKG5R+yxWulZn6yZ8AAlZwSOPsDsb+5MGdUVnBw4Psib+wWeSY1l8jxBRutY9j2eiZOoEtqcmEfNJs0ls5Pk2YPcScmchVCsQLMnEo5GWf7lniljZeY5heMD5jnf8eEFXnZ6IUcFs7EgK9R99uM+4zoo/8bPpCBHvvnBiHPKxz8mhZr+8A8jysLv/zArVbB597v3fXB+0eF37y+yPbczw9qP20SRSkXt98Nl49509yPDJllseb//bbjYsrfqfy61m7U60ebtNpAPtdn9WGqzPQXpy+u02fbsoy+ZYwPTb+vG6y9pO7yCJ+vsc+Q2SAePk9oRPc1vdku095rcAz3ZJ9wEHbgr6h2ynuDercDTYKfW9HJM7tMKyxHuyprsM7MnK3Ca2IE12Wtud2LgNrUXcbLf5E7EwCncdzjZI9ywHHgrmsGMesptUSZOU3uSL+A/sSkZBgB2IU+LILMN2TtO7Due42+8yuZ2Gs/xzKi42b3Fc3xzqm9+N/Ec76OVOLN/eI7ff4DtmrHLP7f8zH3aW2bLsHeX2CM8x9+4knO7gud4Zig5uw94ju/kRuDYM9z5O8dvTkt4ry/b2/hmX+9o+ghwfDtvP8Qt2Z+T9gE27PZVjz8pTNtPbMn1Pgr34Kb9jG669R4n77JN+05uq+0np6X7aNMqxxtne0dFO2Wzc57k1thgwlO8FzbrMbv5NfA6abdrpg/Kb2/ta8O0/aw5v+MbWM/Op+9YzWgpu0X1LN4pe1JzeZGsrAp3nUZ+1DlndHtO2v22OWzbPub4l9vjf4ls1qkyRp3XuF5dncKFnMDON/0lOIdxm8wyBxmxtN3b9CLL2+OzznfCwXA77ri/pmvsswnDCUyp++EZ7FnP7dSl3Gnwyl+9e3f1/YcPP129e/7mb6+A0/iCrBCI2b8+f3n13dt3Pz7/kDB7vqDE7Ku3L16+u3rz9kNz789vXiZsk6vKHfzw9sXzD2/fXf3j9U+VZrpL3FPi/MWrNx/ePf/h6uXrd69eNLb+Puo6c0eJ4zb2H66+e/3Dq6vvXz1/+Wq8iDN3FBX3/zbhf/f61Q8vuWWdvKHI7ZsX7/7+04dXSS/+9xKjP795//NPP71919zmDbx++ybhAV881d2Ltz/+9O7V+/c8f8HVJQ5fv/nv5z+8fnn1/vXf3jz/8PO7VIMxuG6Kk5+ev3//P2/fpV4QvazExcuff/rhdVNXm5J48/zH1FOQq6Y8Q1POPzb1c+QRuqumOGgr/99zDzG8cLob3tNE105x9t+v3mVkTK6a9DTnFuTD338aLbn46pkOXz7/8JzvsL162vvy7cnV+w/vXr3524fvR9/a4I6pTVG20x9eWOLmfVMjP7TNvu13Ei7ii4qK78Ord7YHb9vHH161MX54+/bq/du0GtN3lBXfy1ffvX7T3P3zG982v2rbz3+kHjJzB3L8z6dPGr/1H0++/Ve/jvXbJ/KZerZurrzd1nc3zYW/+BRNt0e7+dPN/vrR/vGf3WX/bYe67cXu6r8snjz9ZfHUrJ+tK/PPfz79xd9sf7D/4G2c/8XeKJq/CXSjGNwoohtl8zeJbpSDG2V0o2r+ptCNanCjim7Uzd80ulEPbtTRjab5m0E3msGNJrqxav5WoRurwY1VdOOy+dvyqVo8E8v4xuXgxmV046r52+qpWj6Ty1V042pw4yq6sVHQL+unavVsWcnoxvXgxnUsgFYPAmpHDMUjiHqsfLB+gIBiBYlWFwJqSAxFJGIViVYbAupIDIUkYiWJVh+i0ZJ4ptdxcYmhmESsJtFqRJinevVsTV6SGApKxIoSrU5EBW8eikrEqhKtVsQSPvNQWCJWllilwx6KS8TqEut02EOBiVhh0ipsBduKocJkrDBpFbaGNw8VJkkbZRupxVOtnq2W8b2glYoFJlvJSIHuHepLxvqSrWIkbh2H+pKxvqRJBj2Ul4zlJatk0EN1yVhdstWLhDVKDtUlY3XJVi8Sts5yqC4Zq0u2epGwhZZDdclYXWqR1LUaqkvF6lIiqWs1VJeK1aWsumD/oIbyUqQXVKkuQoF+MJaXsvKC7YAaykvF8lJWXrA2qqG+VKwvZfUFa6MaCkzFAlPL9JsaCkzFAlOr9JsaCkzFAlOtZBTs49RQYCoWmF6k3pQe6kvH+tKtYpRAHY0e6kvH+tKtYhRsRfRQXzrWl07qSw/1pclAq1WMaloC/WxlqvhmMNaK9aVN+pGH+tKxvnSrGIUHeUN96VhfOjnq0kN56VheepV+5KG8dCwvvU4/8lBeOpaXaRWj8PB0qC8T68tYfcEmyAz1ZWJ9GauvpsDMM7WOewsz1JeJ9WXsMB42I2YoMBMLzLSSgcNcM9SXIYN5q681elMGjOdjfZkqJREzlJeJ5WWWyaCH8jKxvEwrGN306eKZWZCgh/IysbzMOv2ehvIysbyqVjBaIM/VUF5VLK+qFYyGLVA1lFcVy6uSqbKuhuqqYnVVKlXW1VBcVSyuSifLuhqqq4rVVZlkWVdDdVVkulilyxrMGGN5Va1iNBx+VUN9VbG+qlWyrIfyqmJ5VetkWQ/VVcXqWi6SZb0cqmsZq2spkmW9HKprGatrKZNlvRzKaxnLa9kqRsNuZjnU1zLW11Knyno5lNcyltfSpMp6OVTXMlbXskqX9VBdS5KQWKbLGuQkYnUtV+myHsprGctr2SpGw/5tOdTXMtbXKjn2Wg3ltYrltRKpsl4N1bWK1bWSybJeDdW1itW1UsmyXg3VtYrVtdLJsl4N5bWK5bVqFaPhcGA11Ncq1tcq2TeuhvJaxfJaJfvG1VBdK5LySveNK5D1itW1SveNq6G6VrG61um+cT2U1zqW19r2jXASth7qax3ra53sG9dDea1jea2TfeN6qK51rK51um9cD9W1jtW1TveN66G61rG61um+cT2U1zqW19r2jXCwuR7qax3ra231Bees66G+1iStuk6+KJBYpZnVRepNuZ/iu4N/624XyZflfqP3k/TqIj2+d7/R+0mGdaGSr8z9Ru8nSdZFKx+TyCyDNOuC5FkXJlX27id6O8m0Lqp06YNU64LkWhfLTOmDbOuCpFsXq0zpg4TrgmRcF+tM6YOc64KIz2bqTSI1D9Q3yOy3ajISzbMEzO0T9dl8vYEzaoHS+zS/b1P2RuP7gfpoit9m7Y3B9wP10Sy/TdybCjIClOeniX6buzdLfD/QH8312/S9gW2eQNl+mu63GfxU/EB/NONvk/ip+IH+SNJf2Dy+gc2uAGl/QfL+wqbyIdESIPEvSOZf2Gx+hRsfkPwXJPsvbEa/ElA+AAAIQgCETM4SBEAAgjAAYfP6iacH4iMYQNjUfqLxASRAEBQgbHa/kpD3ABggCA0QNsFfKcAhBMABgvAAYVP8FZyfCUAEBEECQiWnDQIwAUGggFBp6QEqIAgWECrT7wIwIAgZEDbbnyh8AAcEoQPCJvxx4QM8IAgfEDblX8EJmwCEQBBEIFRyHiEAIxAEEgib908UPlAewQRCZbpdAAoEIQXCJv8ThQeUR1iBsPn/Cs7ABMAFgvACYREALjwADAQhBsJCAFx4ABkIwgyETs9cBcAGgnADYVFAQrmAHAiCDoSlAbjwATsQBB4IywMqzMcBPhCEH4g0QBCAIAiCEISlAonCB8ojEEHo9FRWAIwgCEcQFg1UeMAASIIgKEGYtPQASxAEJgiTlh6gCYLgBGEy0gNAQRCiICwlqPBwA0AFQaiCMOnJBsAKgnAFYVlB4umB8ghaECadnhOALgiCF4QlBomKBwCDIIRBmHSrBxCDIIxBWGywxIMtQBkEwQyiSksPcAZBQIOw8ADP9ABqEIQ1CMsP8LsDtEEQ3CAsQVjiiRYADoIQB1GllQeQgyDMQViMsMSvHlAHQbCDsCRhiRdSAfAgCHkQDj3gsRqAD4LQB2GJwhIPNwCAEIRACAsVlrjHBQxCEAghLFdY4nkOwBCCcAhh0cISN7uARAiCIoSlC0vIMwWAEYLQCGEJw2qB7wfyI0RCOCQhnuqq0Q99fqA/QiWEBQ0rie8H+iNgQljWsGqaHvmsEmtyP1rVRvRnccNK4/uB/gieEJY4rAy+H+iPEAphqcOqgvcDSCEIpRAOUyxhngeACkFIhbDwYbWC5Q9YhSCwQlj+sFrjdYFAf4RXCIsg1gt8P9AfQRbCUoi1wPcD/RFqISyJgMvlBOAWgoALYWEEXDEnALoQhF0IiyPWeA0roBeC4AthiUSq9IH6CMEQFkokSh8wDEEghrBcIlH6AGMIwjGEZRNrXHsByhCEZQjLJ9a49wA4QxCeISyiSJQfIBqCIA1hKUWq/ID6CNUQFlSkyg/Ij4ANYVnFGvd+AG0IwjaExRWJ1hvQDUHwhrDIItF6A8IhCOKQDnHA9y8B45CEcUjLLHDrLQHjkIRxSMsscOstAeOQhHFIyyxw6y0B45CEcUjLLHDrLQHjkIRxSAstcOstAeSQBHJISy3WcPQjAeWQhHJISy3WS+wfrPollENaarFeodGHBJRDEsohLbVYw9GPBJRDEsohu90LcPgjAeaQBHNIt4Nh0dSgZuq1EMQAWmFOFOh2MSxgFZIAdEgCOqTbybBQ2ADQICEd0u1mWEBUIgHqkAR1SLejYWHQsnGAOiRBHdJtalhU+AmACgnrkG5jwwLLEMAOSWCHdJsbFrgeAdohCe2QboPDAgsR4A5J9zi4TQ4CCxFtc6D7HNxGBwGJg0RbHQZ7HexEBE4EJdzuQHRoCYYQkPhJtOeBbnqwDEMIiPwk2vdANz5YiiHwvhyJNj/Q3Q8WYwhhsAEgRLoFwnIMISr8CECIdBuEJRlCLGFzgnZC0K0QFmUIgZWMdkMQ9iHdfgixhgYA/ZCEfki3J6IdUSMDQIiEf0jl9nXBQYkEAEQSACIt0BASN6mAgEhCQKRFGkJiJQIGIgkDkZZpCKlxBECJBIJISzVEYk8LwCCSYBBpuQbMyEmAQSTBINJijUS/DjCIJBhEWq6R6NcBB5GEg0jLNRL9OuAgknAQqUWmXwckRBISIrXM9OuAhUjCQqRWmX4dwBBJYIjUOtOvAxoiCQ2R2mT6dcBDJOEhUlfpfh3wEEl4iNTLTL8OiIgkRETqVaZfB0xEEiYi9TrTrwMoIgkUkWaR6dcBFZGEikgjMv064CKScBFpQUeqXwdkRBIyIi3pSPTrgIxIQkak0Zl+HaARSdCINCbTrwM4IgkckabK9OsAj0iCR6RZZvp1wEck4SPSrDL9OgAkkgASadaZfh0gEkkQiawWmX4dMBJJGImsRKZfB5REEkoiK5np1wEnkYSTyEpl+nVASiQhJbLSmX4doBJJUImsTKZfB7BEElgiqyrTrwNaIgktkZZ+CLzpUwJcIgkukRZ/CImbRMBLJOEl0vIPnHGTgJdIwkuk5R/tJw5QAACYSAJMpAUgOOUkATCRBJhIC0BwykkCYCIJMJEWgCRSTgCYSAJMpAMmOOUEgIkkwEQ6YIJTTgCYSAJMpAMmOOUEgIkkwEQ6YIJTTgCYSAJMpAMmifcPBEiAibQABO9PB7xEEl4iLf/AW9QBLpEEl8iVm53gAwEAL5GEl8iVzFRAAEwkASbSApBEBQTARBJgIlc6UwEBMZGEmMhVmthJQEwkISZylSZ2EiATSZCJXKWJnQTMRBJmIldpYicBM5GEmchVmthJwEwkYSZynSZ2EjATSZiJXKeJnQTMRBJmItdpYicBM5GEmUjLQHAFBMhEEmQiLQLBFRAQE0mIibQERODN9BIgE0mQiVwn1wdKQEwkISZyndxqJAEwkQSYSAtAhMLDcUBMJCEm0hIQgbflS4BMJEEmyiIQPBhWAJkogkzUIrmvTQFioggxUYvkOi0FgIkiwEQtkotlFOAlivASZfkHXm2hAC9RhJeohUm/PgWAiSLARC2S6lOAlyjCS5TlH0Lh86sAMFEEmKiF0x8kngoQE0WIibIEJFWC4DALQkyUIyb4wAEFiIkixETliIkCxEQRYqJEOlGtADBRBJgoB0zwbFABYKIIMFEdMEF5EQV4iSK8RIlMnloBYKIIMFEOmODZpALARBFgokR6DKgAL1GElyjHSxTcHaIAL1GElyjHSxSWIeAlivAS5XhJe4AEMAB4iSK8RFn8gUchCuASRXCJkmlyrAAuUQSXKIdL2oMo0AMAFRJcoiz9wMMQBWiJIrREOVqCs3MK0BJFaIlytARn5xSgJYrQEuVoCc7OKUBLFKElytESvcBlCGRIaIlytATnWBWgJYoeHqUyaRmFzo+iB0ipTFpGoTOk6CFSjpZoeHqMQudIDQ6SskJsT+lABtBhUkSIjpa0R08gA0CJ9ESpjpbAzJJCh0rRU6U6WgKnJAodLEVPlnJHS+HUlEKHS9HTpdzxUho36eiAKXrClAUgQuNOCR0yRYiJsgQEz4oUICaKEBPVERNchoCYKEJMlNs7glsDAEwUASbKAROcW1MAmCgCTJQDJhp3SgCYKAJMlAMmeGqvADBRBJgoC0Dw1F4BYKIIMFEOmOCpvQLARBFgoiz/gFM7BXCJIrhEWfoBp3YKwBJFYIlysASfaaAALFEElqgOluBxDYAlisASZdlHYlwDWIkirESZdG5GAVaiCCtRjpXgkwYUYCWKsBLVsZJECaDz9YgELfpIlQCQIEElyqGSxMgOoBJFUIlyqCQxsgOoRBFUohwqSYzsACpRBJWoKr2mUAFSoggpURZ8JEZ2AJQoAkqUAyWJkR0AJYqAElWlFxUqwEkU4STKcZLEyA5wEkU4iXKcJDGyA5xEEU6iHCdJjOwAJ1GEkyjHSRIjO8BJFOEkynGSxMgOcBJFOImqMgtpFAAlioAStcwspFEAlCgCSpQFH6mRHSAlipAStZSZkR1AJYqgErVUmZEdYCWKsBK11JmRHYAlisAStTSZkR2gJYrQErWsMiM7gEsUwSVqucyM7AAvUYSXqOUqM7IDwEQRYKLcDhM8sgPERBFiolaLzMgOMBNFmImyCCQxsgPIRBFkojpkgkd2AJkogkzUSmVGdoCZKMJMlGMm+BAfBZiJIsxErXJDQwBNFIEmapUZGgJoogg0Uavc0BBQE0WoiVq587vxIbYAmyiCTdQqDY4VwCaKYBO1dgctw42OCnATRbiJWid3eSqATRTBJspiEGFw3hBwE0W4ibIgRBiFDQAVEnKiLAoRRmMDQIWEnSjHTgw+AhmwE0XYiVqnV3QpAE8UgSdq7Y5gxscoA3yiCD5RDp+YJTYAVEjwiXL4xKywAXQYMz2N2ckQbvnRgJ9owk/0wp35Dff8aEBQNCEo2iIRUcFNPxowFE0YirZQRODt2hpQFE0oirZURFRQyRpgFE0winYYpYJLCzXAKJpgFJ3GKBpgFE0winYYBTMEDTCKJhhFu9O14LI+DSiKJhRFWyqCj/fRgKJoQlG0oyj4lBQNKIomFEU7ioJPCtGAomhCUbTbd4JPu9AAo2iCUbTDKPjACA0wiiYYRTuMgs9c0ICjaMJRtEge96EBRdGEomhHUfCxAxpQFE0oiu6+pwF7NA0wiiYYRTuMssRHtAOMoglG0Q6j4N33GmAUTTCKdhgFb7/XAKNoglG023aCe1UNOIomHEVLme5VNQApmoAU7UAK7lU1ACmagBTt9p3gXlUDkqIJSdEyvf9JA5CiCUjRDqTgXlUDkKIJSNEOpOBeVQOQoglI0Q6k4F5VA5CiCUjRDqQkelUAUjQBKdqBlESvCkCKJiBFd5/iwL0qACmagBTtQEqiVwUgRROQoh1ISfSqAKRoAlK0AylLeOagBiBFE5CiVfIoEA0wiiYYRTuMkuhVAUbRBKNoh1GWcJm0BhhFE4yiHUZpVycgA0CHBKNoh1GWcOOJBhhF0491aNcg4pEB+mAH/WKH4yj4QA2NPtpBv9rhdp6s8NgCfbiDfrnDgZQVXLCv0dc7Bp/vsDpcJT7ggb7gQXToQMoKDw/RVzzoZzzczpMVrgnoSx70Ux6OpKywEtHnPOj3PNzWkxVWIvqkB/2mh9t6ssJKRJ/1IDRFO5qywkoENEUTmqIdTVljJQKaoglN0W7ryRorEeAUTXCKtnhErLESAU/RhKdox1PWWImAp2jCU7TjKWusRMBTNOEp2u09WWMlAqCiCVDRDqissRIBUNEEqGgHVNZYiQCoaAJUtAMqiSEaACqaABXt9p4khmiAqGhCVLTbe5IYogGkoglS0Q6pJIZoAKloglS023uCh2gAqWiCVLRDKokhGkAqmiAV7ZBKYogGkIomSEU7pJIYogGkoglS0Q6pJIZoAKloglS0QyqJIRpAKpogFe2QSmKIBpCKJkhFO6SSGKIBpKIJUtEOqSSGaACpaIJUtEMqazzpBUhFE6SiM8d1aUBUNCEqOnNclwZARROgojPHdWnAUzThKTpzXJcGOEUTnKIzx3VpQFM0oSk6c1yXBjBFE5iiM8d1aQBTNIEpOnNclwYsRROWojPHdWnAUjRhKTpzXJcGKEUTlKIzx3VpQFI0ISk6c1yXBiBFE5CiM8d1acBRNOEoOn1clwYYRROMotPHdWkAUTSBKNoyEXyovQYMRROGoi0TwYfaa8BQNGEo2iIRfKi9BghFE4SiLRPBh9prwFA0YSjaIhF8KLwGCEUThKItEcGHwmtAUDQhKNoRlDVOGQKCoglB0RaIyAXO+QGCoglB0WunP5zzAwhFE4SiLRGRC5zzAwhFE4Si15kjQjRAKJogFO3O7MJNECAomhAU4wgKXiJkAEExhKAYR1DwEiEDCIohBMU4goKXCBlAUAwhKGaR3gNqAEAxBKAYd2wX7EUM4CeG8BPTbUOBS4QM4CeG8BOzSG8CNQCgGAJQzCJzNIMBAMUQgGIWmaMZDCAohhAUs8gczWAAQjEEoRiHUPASIQMQiiEIxXQbUeASIQMQiiEIxTiEgpcIGYBQDEEoptuJApcIGYBQDEEopvsQOVwiZABCMQShGLcVBS8RMgCiGAJRjIMoeImQARDFEIhiHETBS4QMgCiGQBTjIApeImQARDEEohgHUfASIQMgiiEQxTiIgpcIGQBRDIEoxkEUvETIAIhiCEQxbjMKHBUbwFAMYShGZg6rMYChGMJQjEUieImQAQjFEIRiZObAJAMYiiEMxTiGgpcIGcBQDGEoxjEUvMLHAIZiCEMxFong9TEGIBRDEIpxCAWv8DEAoRiCUIwlInKBqyJAKIYgFKOSC2wMACiGABTjvme+gCzRAIBiCEAxym1Mxt8yBgDFEIBi3IfNF/h7xgCgGAJQjPu4+QJCcQMQiiEIxbgPnC8S3zUGMiQIxajMygYDEIohCMV0CAXmGw1AKIYgFNMhFJhvNAChGIJQTIdQYObbAIRiCEIxDqHgJIkBCMUQhGI6hAKzJAYgFEMQiukQCsx8G4BQDEEopkMocKZoAEIxBKGYDqHAqaIBCMUQhGI6hALnigYgFEMQiukQCpwsGoBQDEEopkMoWIkAoRiCUEyHULASAUIx9NPoHULBSkRfR6efR3cIBTMYg76QTj+R3iEUrET0lXT6mfQOoWAloi+l00+ldwgFKxF9Ln3wvXSHULAS4SfTiRI7hIKViL6bTj+c3iEUrET08XT69fQOoWAlog+o0y+oO4SCGYxBH1EnCMV0CAVmrg1AKIYgFNMhFJi5NgChGIJQTIdQIIMxAKEYglCMQyiYwRjAUAxhKKZKb5s3AKEYglBMh1AggzEAoRiCUEyHUCCDMQChGIJQTIdQIIMxAKEYglCMQyiYwRiAUAxBKKZDKDD/agBCMQShmA6hwASsAQjFEIRiOoSClQwQiiEIxTiEghmMAQjFEIRilm6YiMe5gKEYwlCM25WCp2uAoRjCUMzS5AIAQiQQxbhNKXihjwEUxRCKYtymFLz+1gCMYghGMUu3URQmUg3gKIZwFONO8RIwkWoASDEEpJjuHC+YSDWApBhCUowlI1LARKoBKMUQlGIsGpECLp40gKUYwlKMZSNS4AkPgCmGwBSzckcp4QkPoCmG0BRj6YgUeMIDcIohOMU4nCLwhAcAFUOAiumACp7wAKRiCFIxFpFIgZUImIohTMVYRiIlViKAKoZAFWMhiZRYiYCqGEJVjKUkUmIlAqxiCFYxFpNIiZUIuIohXMW4I70kViIAK4aAFeMO9cLnTRsAVgwBK8aBFXywpQFgxRCwYhxYkViJAKwYAlaMAysSKxGAFUPAirGcROKjAQ0AK4aAFWNBicRHmxlAVgwhK5UFJVJBJVaArFSErFQWlEh8uFgFyIr/t38+fbLd/VYfTvXN691N/ceTb3/55cnV1enLQ/3k6b+eXG3dPzZNnXX05Nt/PRG6+e+/nz5pzxezf2i7yeYPzZ86j+6fvS/7W+t8c3MT2VSB0fa0KqaNj3f7j5Gd5fpsp12V6YLSgmvwZnPaVPrxsI2srhahVeGtSrbV7aG+Pu0PX+JYl4FVteqsqjXX6u32Ln4xKx2GaXyYVYnB45fjqW5/IMGuTGi78raX5bY/b3Y3NPAqNL70xtky+Hw6PVzvd6f2nyO7MrSrvF22RA/15mbzkQarQqPaGzVco6f6jzjK5SrUwdobXHANPm53p9XmcNiQNybCOKU3q3hmHx7qXVRFVWiuqwJeY5qpWWu0tpUsNL0MW5SK99bbmt++nvoQWtLBu6l42mwN/X7YnmJDVSD39uPULEuPt7f1ob6x1uLWLajp7SFmrs00vsoveM3T9ef6+teHzfH4+/4Qt55VqPNFp/N2a4L7w7JvnCc42u/uIl2Fsmq/42hNtJ8Es3+Qy04a7YGxnXde6Vmnx+2n3eb0eIiKL6zF7ZcfO49r71F6j5X3yGvxrj9v75oqvouK0gRNUbtx1VmU3nTl63vFfarHXfNUf8Z6WIYPxLNzt9/FNkyoKV/87Z6eLlDf/FfMwrjbHyMHyyhI4fv5vsPnVfnr/U19fTw1NfU+akyC6mV4DV3z68ftrm7Lst5fR/o3YWX1Q5J22RLT7j3pN5ah4Kru1befOnJ/MF0Fa8+ULPBQ75rC2O4+hZ7WwcCi/ahlJ+2F/4OvQytel9X9+ni6XUVaEUGz2H4wqXsOpoT39w+H+nisbwY6XgQNt/QFL5ldobe73e/u69PnfdykydC06spB+pehfGfenhLhdC6LvQ5lKYKeWHJlubvdfno8bE6NxbhwgldbZisq5MAM20rzZI/teDMS9dlO10Yo31EsfIfh20/fdLj/V10RV10js+xe9Kq7z7e76+463zKLhe8dvOSE8spWvhn3QwnhvbbfhO/+4G+v/L/4Rq09z7lrhvwf1n5I4v9Fe9G0iJpVbo0a2pfYjE6IykNVCN/Rad+N+yZXeXEaZttIh0FtYj9o0v3b8O1Ou6Giey+8B+rnMmCcFNSuJW9E2FsDg6WgzxTMcWtr7qY+Xh+2D0So7UKkczF4kSrfzbeLj8odwIGFCIeL7YGUnSc/URC8rrP15CY10XNELRhvUNv0lU1/SScI63DEtepHXL5S+LqgV8yCqfNt4DpUO9Pi7R2tNGGX7ENe+UrrC5pnHU6eFyIM0w86/TRHib458AMi3+IYttvjr7vH+4/14XjaHOIZmwz7U68byRwS2nHA4CW3q5bOWvTTyvYMo65742mxMX748nCq4850IcPC8uOYvg/1bbDyLXq7sqvAW6ej3afT53jaE0hJSe/NdydmwS0vmouQJix+bsE0Vtqaut89HPafWvnvXeTxWwhDZo66rOlP9am1Hk+dgAMZVq8Vr36FDqDNQDqSOe21Nptx14b2QuvQ2KKgcPMFaxZhwfKaw/pwuPq4ubm63R/uN1FtkeHoqqVKXHPXbaibu6u+Ubna7U+Ng8c42SHDEbNZ8cb5rf2bx4e77XXTGN5c2dtDmzJossya1022NmGdbnlPECGzKrXWmsnT4epu3wS5P1z9uX2odKoMZOiBKdXeQ8JmWAargjL4o3ltt9v67iYfcjiv5FbfxnybQLw6bHaf4je2WIcq44t2u/ttc7e9uQJzy5YQBSrgl6q3eW5zr1Cj27KPwD6zMYjsN3UZR65Dy8weYmB5WC3CqrbmV7Xe7FkatC1rSVJgm9mYYdsUg8iw1TVrfgX0tlEmryWYgYD57Zo3Cse5MhzTmYLG11v9rRkEkemtDDvhFgSybTaTB9v0tKPQu7ptKU/7/dVxT+yH+eZqwW8p2pbt7qrFDVef7bwn1VSEal7x1XxsGvhT2whdUf7SQr+gSPgvrwmtvt3umpJ43J2zLVc03dIivaBI+E3H4+74+PCwb8HeVTD2j4sjbDZW/GYjtH1ummLTYSVc8SthaBoMAcKRlFkzRf1b87ePm6Z0bWIysheOv5mtUG+tkcPd9uNhEw9Uo3EqUw5/tA88wJrrkDmZbnJgmAk8ZxOTzXWIDH3CxRjmS7KGE/hpHQJDn0pqF2XyLbeZhgF+C8en2vhUlWG+f2u3eVuxyRDE9lTGcN/YyUKt0/a+bmaK97FpHQ57pZ8AVz5sZmKw9XHYbe7aFmdzOh22Hx/JdDscVUifM5GeVig/+VUe2BjBLbCmA7w+pchdCMaFzwtq5hqAznbTHCWw4Do03icnmU1133PHmfCwSnqqI72M2o88cYy374GOY9ZR7thnCZk03xtEjGAVFoPPB4iVT7Kufakz+zDvagAJFsG7lKLLBEjm0gmydOBu+2tUOGErU2jPZdaowXDwwTRI+v9F2CsxCe/t3eMxGm2raC2AfxE8W/vDdW2nHIf6/x6bpiOaL4epYOEzNpo5ILw9xk8aDrBVz4J9ZonJZz/Vw24pTPxqwVNKa+fLlryLcPDBTOg0dizA/fiF1sR231OwoMK3tYr3Xro8S5TfDl+Gb8SFz/sJv2RD+OUQwng27Z1rZtK6cz7sp6uwi2Jyx8ZYWxm3dSSHZZiZrXiCOlv6VO/c8D0yGeb/l7wu7WwSZIvCUYlgzjQbg7ePd3cDMZhAW8qjKe3fou6hDTNv1ri5b3p6OhsMQQLXzqG+25y2vw16knZrQLCcw9M56WPvRw/MpTKNq0G2OVzfopmjkMZOYqxXhSuYmH1oYw2O76rw4QWvt/i8OV7vD4fHNkkGJC/CZloteC/aTR7jRjlcEiE8wfTreTRTqG2uCWjehJSH+UZaU7YLQfZWoT3mM3t7Q2JoIpzNfC2tuSF7DF4wc9oWdxft/qWgSvtu1wMG7XGxqXjt5PYezrlWYZOr/ayAudTN2UysJg1ri8fIhrkMxhlOLXgM15NoD9Lb7YR803DNY4ggtfEAx/AE7+ymVimG1d34wYnhjSWc5cF0LlwN5xfrGMPT7HY3ZJlh99YvP3P/Vz06Y1rfRi8sXBjYF2tn2i928Guvll2z76cAfgbgFwmJhfR/8EMUP8ERfimg8MuMhYd/wgtQ+JISzDl6+yzbzd32T6oWFSZGmS+ysXX8vL3fHL/srgepmbBlZJobnS+H+NiXjqw8o/TjNuWXGxrBrPfHds1BM53d7E7721hFYd1ceD7tx+Par64xzDHZ9ugTyA+H/am+psy3Cqusl4b2etWVb3eY47Vf67qpa6Qpb09fCtIbnut7BZsFr+G52xxPm+vr+ngcrr0JKogU3VuRvjVWXuCqX+7I3DvQurzf3wz9hfTTV3bp1yYpabw/n4Njjibu6t/qu7jownxjvzSiT2gxM973mz9omjjUmZC8N9CYaZT0KxnviGhIwjMExsYyXKuhmRTmfv8bMRK2KorXmN8fb/bHNuPdjLNplxaSFumrhfSLE5RfPaZ8Vsswx1DD0Xy4nMmvkdOyX0LvK0vFe+P729tjHa8PCuuIX+8ifUuv+jUxKz8ekLzSs0vhYp4WVnfejHa/I/sIRGhE+qXp0i9+VX1dW/mqwEydn9cfRIUTzt3XfUPvJ+irfg2Mb0n61b1+WaPyHa1hruJqV8MMVgyF78g39dIvXlU+c6D88i4jeWp72BzoGDBcDa36FcR+Cabul99UvNFb28ucPh/2j5+izFe410gs/QP5bk36WiNXvQz7VV9+vuTvMsxGCgHTcDOO8CMk6efM0ie55Kpvwf2Aza+m1Mu+yWUWSDJfHcbCTCc0xlqINFh9H04+hK+40q++l/2T+lWAyveNyg8jlenXBfqmhokku5jaCXCXmowmguGLF37OxVzO8kDyp2G1YLbph83vYHGCCBerSD8VlMxBf2sztfo37ASlV49kTqkawykQEQ40/BJiycRYjVmIIMK1ZQvfxDEX5DY2M+OwcL2V9AM9yRzdd6bheCtabepDZs6FG7uwTQgznL61kX4ILD0Ck75dV36FtfKZA73sR7BMAYFJc9DN9cmD7v/d6/bTDd8b+ch8hfWNll8KLny7Jvwid+Fbc+m3KinmugAf8TA/o6JkPNsYMRLCed8HMcfmzhpIaclwHatmrm1qreHcg45WmHSvoitYv9rc91F+eOK35vhF12LRvxte43qoP22Pzew0tWg8XFnMfUCXRm4GuXHbGgI9zVygdKiHA++QtSmuIAbD4BCiaN+R6X4Pis9ymCWzZa0f7jbX9XADePjQzAX8nS2crQs3g2kmNe8MwlRauNlVMzcZdfaGO4ejPblcuVhbiXRcOIbRzJzHYb+PV+aE28IMcy2NXbgWzZDDTeHCr0yXvr5Jn5mRvkoqP8RVvl3V/Xp25jpmvEskXCkmfQZA+uGVYqI9Ok3X0Uq/rvXpnsDPivwz+nmCH0z7nLfw423BTEPYxWutzkFaPhiKMZel9tbAlqCQPjC7c2vuzy1CBoEUmEudvTEQWji0Zh6O0C1Es0uPreXB2QvhjirVz737uQWzosP0Z7iskLmepHnk+20j5RpkdcKB8hRj7UKn/SOZ3oYpJ6bRP07gRYcrHHkibA2BlxzOUpgJhGacvjvetvt92j1RUZmFyEb42ij9/kbZz3/79A5zy4BzuT/EO7DCdZ6SOWnrLbno6XqZoALxFH/uH8BbCkYEzL0XZ3PgXYULnJgztnCh7HBbcrjIy+8+k32Gpz+0pt855xt17XsOUzHDONw15U0WbOlALMxB6uPx5s+4OQmTOH6BiTpnTHh14/GY3+sXU5CunPzI1s8+ZN/3+m5HeWakmQuFmzgsVv48xMphy9Fv2mMuUW/MPu62bXvpZ8NkM5cIC9FP8vqRJnNxQePl9/ojakijObEfFvjS88OTfgK67lONfu0Jcy10E8Afn+NSC4dG/fZKDxE0cxMFWNUvoh3wfsWJ9LMj1W/d7PERs7nvfN037/9jPOKM9pt6+9LPxFUPWPtDTJjrS9wLS27PjxbM8oTQScDuKCbrS4LXwYwOLH0J10V0r9Tnm0SvK18ewiNK4fP7wutK+BSgMH2awGvPZ0EUM9np4xy22uEiJcEc3oC2P0RM/QoO5lzamsMTmSoakfiiUj309gNoZsLNDvxi2YYJfb+aTHqYo0SPE7x++ywIc81L49LuptjHXVuYH/DZV9lvF/Y1VvU0mcntGm9gF3c4EGGedtYa8nsr68HO3XDxofYLKA3zvJ6BabeaH+02DTOhmrk5aWD+vNQGughX8TCTFo2LYZmEC78UM4/eGGq7vKGxcNyr/fjULHnddGMVLH8Jj+ZjTpcS22HCvdVsQ8PhZ5j1EMyBWm8oOB0FvNXwKDbBf6nOdH5Ja9ggMcc3vWVkL0xyM0eZvb3hSDBMmwkmiYazaxHu25P+XCrF3Ovfm+yOYkQVLzw7SjEXSvZ2LWiDG/9DEsVMWJytZkUldITN2YJ1tsEJHWFCQHISu/98+uShaXrutrvmnl/++e9//z8IrMNbRx4CAA=="; \ No newline at end of file diff --git a/api/assets/style.css b/api/assets/style.css index 178bfb02..7f80f3dc 100644 --- a/api/assets/style.css +++ b/api/assets/style.css @@ -1,115 +1,256 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - - --light-color-icon-background: var(--light-color-background); - --light-color-icon-text: var(--light-color-text); - - --light-color-comment-tag-text: var(--light-color-text); - --light-color-comment-tag: var(--light-color-background); - - --light-color-link: #1f70c2; - --light-color-focus-outline: #3584e4; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: #4d7fff; - --light-color-ts-property: #ff984d; - --light-color-ts-method: #ff4db8; - --light-color-ts-reference: #ff4d82; - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: #ff4d4d; - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - --light-color-document: #000000; - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-icon-text: var(--dark-color-text); - - --dark-color-comment-tag-text: var(--dark-color-text); - --dark-color-comment-tag: var(--dark-color-background); - - --dark-color-link: #00aff4; - --dark-color-focus-outline: #4c97f2; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: #4d7fff; - --dark-color-ts-property: #ff984d; - --dark-color-ts-method: #ff4db8; - --dark-color-ts-reference: #ff4d82; - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: #ff4d4d; - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - --dark-color-document: #ffffff; - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { +@layer typedoc { :root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: #9f5f30; + --light-color-ts-method: #be3989; + --light-color-ts-reference: #ff4d82; + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var( + --light-color-ts-constructor + ); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: #c73c3c; + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: #ff6060; + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; + } + + @media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var( + --light-color-background-secondary + ); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + } + + @media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var( + --dark-color-background-secondary + ); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + } + + html { + color-scheme: var(--color-scheme); + } + + body { + margin: 0; + } + + :root[data-theme="light"] { --color-background: var(--light-color-background); --color-background-secondary: var(--light-color-background-secondary); --color-background-warning: var(--light-color-background-warning); --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); --color-accent: var(--light-color-accent); --color-active-menu-item: var(--light-color-active-menu-item); --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); - - --color-icon-background: var(--light-color-icon-background); --color-icon-text: var(--light-color-icon-text); --color-comment-tag-text: var(--light-color-text); @@ -145,23 +286,26 @@ --color-ts-type-alias: var(--light-color-ts-type-alias); --color-document: var(--light-color-document); + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); + --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); } -} -@media (prefers-color-scheme: dark) { - :root { + :root[data-theme="dark"] { --color-background: var(--dark-color-background); --color-background-secondary: var(--dark-color-background-secondary); --color-background-warning: var(--dark-color-background-warning); --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); --color-accent: var(--dark-color-accent); --color-active-menu-item: var(--dark-color-active-menu-item); --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); - - --color-icon-background: var(--dark-color-icon-background); --color-icon-text: var(--dark-color-icon-text); --color-comment-tag-text: var(--dark-color-text); @@ -197,1297 +341,1270 @@ --color-ts-type-alias: var(--dark-color-ts-type-alias); --color-document: var(--dark-color-document); + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); + --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } -} -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-icon-text: var(--light-color-icon-text); - - --color-comment-tag-text: var(--light-color-text); - --color-comment-tag: var(--light-color-background); - - --color-link: var(--light-color-link); - --color-focus-outline: var(--light-color-focus-outline); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-project: var(--light-color-ts-project); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-reference: var(--light-color-ts-reference); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - --color-document: var(--light-color-document); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} + .always-visible, + .always-visible .tsd-signatures { + display: inherit !important; + } -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-icon-text: var(--dark-color-icon-text); - - --color-comment-tag-text: var(--dark-color-text); - --color-comment-tag: var(--dark-color-background); - - --color-link: var(--dark-color-link); - --color-focus-outline: var(--dark-color-focus-outline); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-project: var(--dark-color-ts-project); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-reference: var(--dark-color-ts-reference); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - --color-document: var(--dark-color-document); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } -*:focus-visible, -.tsd-accordion-summary:focus-visible svg { - outline: 2px solid var(--color-focus-outline); -} + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} + dl, + menu, + ol, + ul { + margin: 1em 0; + } -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} + dd { + margin: 0 0 0 34px; + } -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} + .container { + max-width: 1700px; + padding: 0 2rem; + } -dl, -menu, -ol, -ul { - margin: 1em 0; -} + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; + } + footer > p { + margin: 0 1em; + } -dd { - margin: 0 0 0 40px; -} + .container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); + } -.container { - max-width: 1700px; - padding: 0 2rem; -} + @keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + @keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } + } + @keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } + } + @keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } + } + @keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } + } + @keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } + } + body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); + } -/* Footer */ -footer { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} -footer > p { - margin: 0 1em; -} + a { + color: var(--color-link); + text-decoration: none; + } + a:hover { + text-decoration: underline; + } + a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; + } + a.tsd-anchor-link { + color: var(--color-text); + } -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} + code, + pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } -@keyframes fade-in { - from { + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + pre code { + padding: 0; + font-size: 100%; + } + pre > button { + position: absolute; + top: 10px; + right: 10px; opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; } - to { + pre:hover > button, + pre > button.visible { opacity: 1; } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; } - to { - opacity: 0; + + .tsd-typography { + line-height: 1.333em; } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; } - 33% { - opacity: 0; + .tsd-typography .tsd-index-panel h3, + .tsd-index-panel .tsd-typography h3, + .tsd-typography h4, + .tsd-typography h5, + .tsd-typography h6 { + font-size: 1em; } - 100% { - opacity: 1; + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; } - 66% { - opacity: 0; + .tsd-typography table { + border-collapse: collapse; + border: none; } - 100% { - opacity: 0; + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); } - to { - transform: translate(0, 0); + + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; } - to { - transform: translate(100%, 0); + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; } -} -body { - background: var(--color-background); - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; - font-size: 16px; - color: var(--color-text); -} -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} -a.tsd-anchor-link { - color: var(--color-text); -} + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} + .tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); + } + .tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; + } + .tsd-breadcrumb a:hover { + text-decoration: underline; + } + .tsd-breadcrumb li { + display: inline; + } + .tsd-breadcrumb li:after { + content: " / "; + } -pre { - position: relative; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} + .tsd-comment-tags { + display: flex; + flex-direction: column; + } + dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; + } + dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; + } + dl.tsd-comment-tag-group dd { + margin: 0; + } + code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; + } + h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; + } -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} + dl.tsd-comment-tag-group dd:before, + dl.tsd-comment-tag-group dd:after { + content: " "; + } + dl.tsd-comment-tag-group dd pre, + dl.tsd-comment-tag-group dd:after { + clear: both; + } + dl.tsd-comment-tag-group p { + margin: 0; + } -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} + .tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; + } + .tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; + } -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} + .tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; + } + .tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; + } + .tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + } + .tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; + } + .tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; + } + .tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; + } + .tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .tsd-checkbox-background { + fill: var(--color-accent); + } + input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); + } -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} + .tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; + } -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} + .tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; + } -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: -moz-fit-content; - width: fit-content; - align-items: center; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus-visible + svg { - outline: 2px solid var(--color-focus-outline); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } -.settings-label { - font-weight: bold; - text-transform: uppercase; - display: inline-block; -} + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } -.tsd-filter-visibility .settings-label { - margin: 0.75rem 0 0.5rem 0; -} + .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-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown="false"] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { + display: none; + } -.tsd-theme-toggle .settings-label { - margin: 0.75rem 0.75rem 0 0; -} + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; + } + .tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; + } + @media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } + } + @media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } + } + .tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; + } -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} + .tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; + } -.tsd-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-anchor { + position: relative; + top: -100px; + } -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); + .tsd-member { + position: relative; } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} + .tsd-navigation.settings { + margin: 1rem 0; + } + .tsd-navigation > a, + .tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; + } + .tsd-navigation a, + .tsd-navigation summary > span, + .tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; + } + .tsd-navigation a.current, + .tsd-page-navigation a.current { + background: var(--color-active-menu-item); + } + .tsd-navigation a:hover, + .tsd-page-navigation a:hover { + text-decoration: underline; + } + .tsd-navigation ul, + .tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; + } + .tsd-navigation li, + .tsd-page-navigation li { + padding: 0; + max-width: 100%; + } + .tsd-navigation .tsd-nav-link { + display: none; + } + .tsd-nested-navigation { + margin-left: 3rem; + } + .tsd-nested-navigation > li > details { + margin-left: -1.5rem; + } + .tsd-small-nested-navigation { + margin-left: 1.5rem; + } + .tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; + } -.tsd-anchor { - position: relative; - top: -100px; -} + .tsd-page-navigation-section { + margin-left: 10px; + } + .tsd-page-navigation-section > summary { + padding: 0.25rem; + } + .tsd-page-navigation-section > div { + margin-left: 20px; + } + .tsd-page-navigation ul { + padding-left: 1.75rem; + } -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} + #tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; + } + #tsd-sidebar-links a:last-of-type { + margin-bottom: 0; + } -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-navigation .tsd-nav-link { - display: none; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-page-navigation-section { - margin-left: 10px; -} -.tsd-page-navigation-section > summary { - padding: 0.25rem; -} -.tsd-page-navigation-section > div { - margin-left: 20px; -} -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; - vertical-align: text-top; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-no-select { - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} -.tsd-panel-group > .tsd-accordion-summary { - margin-bottom: 1rem; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-index-signature:not(:last-child) { - margin-bottom: 1em; -} -.tsd-signatures .tsd-index-signature .tsd-signature { - border-width: 1px; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} + a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ + } + .tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ + } + .tsd-accordion-summary, + .tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; + } + .tsd-accordion-summary a { + width: calc(100% - 1.5rem); + } + .tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; + } + .tsd-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; + } + /* + We need to be careful to target the arrow indicating whether the accordion + is open, but not any other SVGs included in the details element. +*/ + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h1 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h2 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h3 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child { + transform: rotate(-90deg); + } + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + } -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} + .tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + .tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } -img { - max-width: 100%; -} + .tsd-panel { + margin-bottom: 2.5rem; + } + .tsd-panel.tsd-member { + margin-bottom: 4rem; + } + .tsd-panel:empty { + display: none; + } + .tsd-panel > h1, + .tsd-panel > h2, + .tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; + } + .tsd-panel > h1.tsd-before-signature, + .tsd-panel > h2.tsd-before-signature, + .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; + } -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; + } + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; + } -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} + #tsd-search { + transition: background-color 0.2s; + } + #tsd-search .title { + position: relative; + z-index: 2; + } + #tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; + } + #tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); + } + #tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; + } + #tsd-search .field input, + #tsd-search .title, + #tsd-toolbar-links a { + transition: opacity 0.2s; + } + #tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + #tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; + } + #tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); + } + #tsd-search .results li.state { + display: none; + } + #tsd-search .results li.current:not(.no-results), + #tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); + } + #tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; + } + #tsd-search .results a:before { + top: 10px; + } + #tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; + } + #tsd-search.has-focus { + background-color: var(--color-accent); + } + #tsd-search.has-focus .field input { + top: 0; + opacity: 1; + } + #tsd-search.has-focus .title, + #tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; + } + #tsd-search.has-focus .results { + visibility: visible; + } + #tsd-search.loading .results li.state.loading { + display: block; + } + #tsd-search.failure .results li.state.failure { + display: block; + } -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} + #tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; + } + #tsd-toolbar-links a { + margin-left: 1.5rem; + } + #tsd-toolbar-links a:hover { + text-decoration: underline; + } -.deprecated { - text-decoration: line-through !important; -} + .tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; + } -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; + } -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-reference { - color: var(--color-ts-reference); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; + } -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} + .tsd-signature-type { + font-style: italic; + font-weight: normal; + } -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} + .tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; + } + .tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; + } + .tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; + } + .tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; + } + .tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; + } -*::-webkit-scrollbar { - width: 0.75rem; -} + ul.tsd-parameter-list, + ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; + } + ul.tsd-parameter-list > li.tsd-parameter-signature, + ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; + } + ul.tsd-parameter-list h5, + ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; + } + .tsd-sources { + margin-top: 1rem; + font-size: 0.875em; + } + .tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; + } + .tsd-sources ul { + list-style: none; + padding: 0; + } -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} + .tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; + } + .tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; + } + .tsd-page-toolbar a.title { + font-weight: bold; + } + .tsd-page-toolbar a.title:hover { + text-decoration: underline; + } + .tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; + } + .tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; + } + .tsd-page-toolbar .table-cell:first-child { + width: 100%; + } + .tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; + } -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} + .tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; + } + .tsd-widget:hover { + opacity: 0.9; + } + .tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); + } + .tsd-widget.no-caption { + width: 40px; + } + .tsd-widget.no-caption:before { + margin: 0; + } -/* mobile */ -@media (max-width: 769px) { .tsd-widget.options, .tsd-widget.menu { - display: inline-block; + display: none; } - - .container-main { - display: flex; + input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; + } + input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; } - html .col-content { - float: none; + + img { max-width: 100%; - width: 100%; } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); + + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; } - html .col-sidebar > *:last-child { - padding-bottom: 20px; + + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); + + .tsd-anchor-icon svg { + width: 1em; + height: 1em; visibility: hidden; } - .to-has-menu .overlay { - animation: fade-in 0.4s; + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; } - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; + .deprecated { + text-decoration: line-through !important; } - .from-has-menu .overlay { - animation: fade-out 0.4s; + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); } - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; + .tsd-kind-project { + color: var(--color-ts-project); } - - .has-menu body { - overflow: hidden; + .tsd-kind-module { + color: var(--color-ts-module); } - .has-menu .overlay { - visibility: visible; + .tsd-kind-namespace { + color: var(--color-ts-namespace); } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; + .tsd-kind-enum { + color: var(--color-ts-enum); } - .has-menu .tsd-navigation { - max-height: 100%; + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); } - #tsd-toolbar-links { - display: none; + .tsd-kind-variable { + color: var(--color-ts-variable); } - .tsd-navigation .tsd-nav-link { - display: flex; + .tsd-kind-function { + color: var(--color-ts-function); } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; + .tsd-kind-class { + color: var(--color-ts-class); } - - .col-sidebar { - grid-area: sidebar; + .tsd-kind-interface { + color: var(--color-ts-interface); } - .col-content { - grid-area: content; - padding: 0 1rem; + .tsd-kind-constructor { + color: var(--color-ts-constructor); } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; + .tsd-kind-property { + color: var(--color-ts-property); } - .site-menu { - margin-top: 1rem; + .tsd-kind-method { + color: var(--color-ts-method); + } + .tsd-kind-reference { + color: var(--color-ts-reference); + } + .tsd-kind-call-signature { + color: var(--color-ts-call-signature); + } + .tsd-kind-index-signature { + color: var(--color-ts-index-signature); + } + .tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); + } + .tsd-kind-parameter { + color: var(--color-ts-parameter); + } + .tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); + } + .tsd-kind-accessor { + color: var(--color-ts-accessor); + } + .tsd-kind-get-signature { + color: var(--color-ts-get-signature); + } + .tsd-kind-set-signature { + color: var(--color-ts-set-signature); + } + .tsd-kind-type-alias { + color: var(--color-ts-type-alias); } -} -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); } - .col-sidebar { - display: contents; + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); } - .page-menu { - grid-area: toc; - padding-left: 1rem; + *::-webkit-scrollbar { + width: 0.75rem; } - .site-menu { - grid-area: sidebar; + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); } - .site-menu { - margin-top: 1rem; + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); } - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; + /* mobile */ + @media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } + } + + /* one sidebar */ + @media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } + } + @media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } + } + + /* two sidebars */ + @media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax( + 0, + 20rem + ); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } } } diff --git a/api/classes/BlobReader.html b/api/classes/BlobReader.html index 32466356..2e485fc3 100644 --- a/api/classes/BlobReader.html +++ b/api/classes/BlobReader.html @@ -1,16 +1,16 @@ -BlobReader | @zip.js/zip.js

Class BlobReader

Represents a Reader instance used to read data provided as a Blob instance.

-

Hierarchy (view full)

Constructors

constructor +BlobReader | @zip.js/zip.js

Class BlobReader

Represents a Reader instance used to read data provided as a Blob instance.

+

Hierarchy (View Summary)

Constructors

constructor

Properties

readable size

Methods

init? -readUint8Array -

Constructors

constructor

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns BlobReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(
        index: number,
        length: number,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

      -

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a chunk of data.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/BlobWriter.html b/api/classes/BlobWriter.html index 46f7f796..8a1812dd 100644 --- a/api/classes/BlobWriter.html +++ b/api/classes/BlobWriter.html @@ -1,12 +1,12 @@ -BlobWriter | @zip.js/zip.js

Class BlobWriter

Represents a WritableWriter instance used to retrieve the written data as a Blob instance.

-

Implements

Constructors

constructor +BlobWriter | @zip.js/zip.js

Class BlobWriter

Represents a WritableWriter instance used to retrieve the written data as a Blob instance.

+

Implements

Constructors

constructor

Properties

writable -

Methods

getData +

Methods

getData init -

Constructors

constructor

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

  • getData(): Promise<Blob>

  • Retrieves all the written data

    +

Returns BlobWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

getData

  • getData(): Promise<Blob>

  • Retrieves all the written data

    Returns Promise<Blob>

    A promise resolving to the written data.

    -

init

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

init

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/CodecStream.html b/api/classes/CodecStream.html index 2cda5b01..46499d4b 100644 --- a/api/classes/CodecStream.html +++ b/api/classes/CodecStream.html @@ -1,7 +1,7 @@ -CodecStream | @zip.js/zip.js

Class CodecStream

Represents a class implementing CompressionStream or DecompressionStream interfaces.

-

Hierarchy

  • TransformStream
    • CodecStream

Constructors

constructor +CodecStream | @zip.js/zip.js

Class CodecStream

Represents a class implementing CompressionStream or DecompressionStream interfaces.

+

Hierarchy

  • TransformStream
    • CodecStream

Constructors

constructor

Properties

readable writable -

Constructors

constructor

  • new CodecStream(transformer?, writableStrategy?, readableStrategy?): CodecStream

  • Parameters

    • Optionaltransformer: Transformer<any, any>
    • OptionalwritableStrategy: QueuingStrategy<any>
    • OptionalreadableStrategy: QueuingStrategy<any>

    Returns CodecStream

Properties

Readonlyreadable

readable: ReadableStream<any>

MDN Reference

-

Readonlywritable

writable: WritableStream<any>

MDN Reference

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

  • new CodecStream(
        transformer?: Transformer<any, any>,
        writableStrategy?: QueuingStrategy<any>,
        readableStrategy?: QueuingStrategy<any>,
    ): CodecStream

  • Parameters

    • Optionaltransformer: Transformer<any, any>
    • OptionalwritableStrategy: QueuingStrategy<any>
    • OptionalreadableStrategy: QueuingStrategy<any>

    Returns CodecStream

Properties

Readonlyreadable

readable: ReadableStream<any>

MDN Reference

+

Readonlywritable

writable: WritableStream<any>

MDN Reference

+

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/Data64URIReader.html b/api/classes/Data64URIReader.html index 342d2a7a..1287bf32 100644 --- a/api/classes/Data64URIReader.html +++ b/api/classes/Data64URIReader.html @@ -1,16 +1,16 @@ -Data64URIReader | @zip.js/zip.js

Class Data64URIReader

Represents a Reader instance used to read data provided as a Data URI string encoded in Base64.

-

Hierarchy (view full)

Constructors

constructor +Data64URIReader | @zip.js/zip.js

Class Data64URIReader

Represents a Reader instance used to read data provided as a Data URI string encoded in Base64.

+

Hierarchy (View Summary)

Constructors

constructor

Properties

readable size

Methods

init? -readUint8Array -

Constructors

constructor

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns Data64URIReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(
        index: number,
        length: number,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

      -

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a chunk of data.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/Data64URIWriter.html b/api/classes/Data64URIWriter.html index 14982f1e..2daca07a 100644 --- a/api/classes/Data64URIWriter.html +++ b/api/classes/Data64URIWriter.html @@ -1,16 +1,16 @@ -Data64URIWriter | @zip.js/zip.js

Class Data64URIWriter

Represents a Writer instance used to retrieve the written data as a Data URI string encoded in Base64.

-

Hierarchy (view full)

Constructors

constructor +Data64URIWriter | @zip.js/zip.js

Class Data64URIWriter

Represents a Writer instance used to retrieve the written data as a Data URI string encoded in Base64.

+

Hierarchy (View Summary)

Constructors

constructor

Properties

writable -

Methods

getData +

Methods

getData init? -writeUint8Array -

Constructors

constructor

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

  • getData(): Promise<string>

  • Retrieves all the written data

    +

Returns Data64URIWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

getData

  • getData(): Promise<string>

  • Retrieves all the written data

    Returns Promise<string>

    A promise resolving to the written data.

    -

Optionalinit

Optionalinit

  • init(size?: number): Promise<void>

  • Initializes the instance asynchronously

    Parameters

    • Optionalsize: number

      the total size of the written data in bytes.

      -

    Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    -

    Parameters

    • array: Uint8Array

      The chunk data to append.

      -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<void>

writeUint8Array

  • writeUint8Array(array: Uint8Array<ArrayBufferLike>): Promise<void>

  • Appends a chunk of data

    +

    Parameters

    • array: Uint8Array<ArrayBufferLike>

      The chunk data to append.

      +

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/EventBasedCodec.html b/api/classes/EventBasedCodec.html index 638d5e09..7db60da0 100644 --- a/api/classes/EventBasedCodec.html +++ b/api/classes/EventBasedCodec.html @@ -1,9 +1,9 @@ -EventBasedCodec | @zip.js/zip.js

Class EventBasedCodec

Represents an event-based implementation of a third-party codec.

-

Constructors

constructor +EventBasedCodec | @zip.js/zip.js

Class EventBasedCodec

Represents an event-based implementation of a third-party codec.

+

Constructors

constructor

Methods

ondata push -

Constructors

constructor

Methods

ondata

  • ondata(data?): void

  • The function called when a chunk of data has been compressed/decompressed.

    -

    Parameters

    • Optionaldata: Uint8Array

      The chunk of compressed/decompressed data.

      -

    Returns void

push

  • push(data): void

  • Appends a chunk of data to compress/decompress

    -

    Parameters

    • data: Uint8Array

      The chunk of data to append.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

ondata

  • ondata(data?: Uint8Array<ArrayBufferLike>): void

  • The function called when a chunk of data has been compressed/decompressed.

    +

    Parameters

    • Optionaldata: Uint8Array<ArrayBufferLike>

      The chunk of compressed/decompressed data.

      +

    Returns void

push

  • push(data: Uint8Array<ArrayBufferLike>): void

  • Appends a chunk of data to compress/decompress

    +

    Parameters

    • data: Uint8Array<ArrayBufferLike>

      The chunk of data to append.

      +

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FS.html b/api/classes/FS.html index 5ef52652..99558890 100644 --- a/api/classes/FS.html +++ b/api/classes/FS.html @@ -1,9 +1,9 @@ -FS | @zip.js/zip.js

Class FS

Represents a Filesystem instance.

-

Example

Here is an example showing how to create and read a zip file containing a compressed text file:

+FS | @zip.js/zip.js

Class FS

Represents a Filesystem instance.

+

Example

Here is an example showing how to create and read a zip file containing a compressed text file:

const TEXT_CONTENT = "Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.";
const FILENAME = "lorem.txt";
const BLOB = new Blob([TEXT_CONTENT], { type: zip.getMimeType(FILENAME) });
let zipFs = new zip.fs.FS();
zipFs.addBlob("lorem.txt", BLOB);
const zippedBlob = await zipFs.exportBlob();
zipFs = new zip.fs.FS();
await zipFs.importBlob(zippedBlob);
const firstEntry = zipFs.children[0];
const unzippedBlob = await firstEntry.getBlob(zip.getMimeType(firstEntry.name));
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

children data? directory @@ -11,151 +11,151 @@ name parent? root -uncompressedSize -

Methods

addBlob -addData64URI -addDirectory -addFile -addFileSystemEntry -addFileSystemHandle -addHttpContent -addReadable -addText -addUint8Array -checkPassword +uncompressedSize +

Methods

addBlob +addData64URI +addDirectory +addFile +addFileSystemEntry +addFileSystemHandle +addHttpContent +addReadable +addText +addUint8Array +checkPassword clone -exportBlob -exportData64URI -exportUint8Array -exportWritable -exportZip +exportBlob +exportData64URI +exportUint8Array +exportWritable +exportZip find -getById -getChildByName -getFullname -getRelativeName -importBlob -importData64URI -importHttpContent -importReadable -importUint8Array -importZip -isDescendantOf -isPasswordProtected +getById +getChildByName +getFullname +getRelativeName +importBlob +importData64URI +importHttpContent +importReadable +importUint8Array +importZip +isDescendantOf +isPasswordProtected move remove rename -

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

-

Optionaldata

data?: EntryMetaData

The underlying EntryMetaData instance.

-

directory

directory

true for ZipDirectoryEntry instances.

-

id

id: number

The ID of the instance.

-

name

name: string

The relative filename of the entry.

-

Optionalparent

parent?: ZipEntry

The parent directory of the entry.

-

root

root: ZipDirectoryEntry

The root directory.

-

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

-

Methods

addBlob

  • addBlob(name, blob, options?): ZipFileEntry<Blob, Blob>

  • Adds a entry entry with content provided as a Blob instance

    +

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

+

Optionaldata

data?: EntryMetaData

The underlying EntryMetaData instance.

+

directory

directory: true

true for ZipDirectoryEntry instances.

+

id

id: number

The ID of the instance.

+

name

name: string

The relative filename of the entry.

+

Optionalparent

parent?: ZipEntry

The parent directory of the entry.

+

root

root: ZipDirectoryEntry

The root directory.

+

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

+

Methods

addBlob

addData64URI

  • addData64URI(name, dataURI, options?): ZipFileEntry<string, string>

  • Adds a entry entry with content provided as a Data URI string encoded in Base64

    +

Returns ZipFileEntry<Blob, Blob>

A ZipFileEntry instance.

+

addData64URI

addDirectory

Returns ZipFileEntry<string, string>

A ZipFileEntry instance.

+

addDirectory

addFile

addFile

addFileSystemEntry

addFileSystemEntry

addFileSystemHandle

addFileSystemHandle

addHttpContent

addHttpContent

addReadable

Returns ZipFileEntry<string, void>

A ZipFileEntry instance.

+

addReadable

addText

  • addText(name, text, options?): ZipFileEntry<string, string>

  • Adds an entry with content provided as text

    +

Returns ZipFileEntry<ReadableStream<any>, void>

A ZipFileEntry instance.

+

addText

addUint8Array

  • addUint8Array(name, array, options?): ZipFileEntry<Uint8Array, Uint8Array>

  • Adds an entry with content provided as a Uint8Array instance

    +

Returns ZipFileEntry<string, string>

A ZipFileEntry instance.

+

addUint8Array

checkPassword

clone

  • clone(deepClone?): ZipEntry

  • Clones the entry

    +

Returns ZipFileEntry<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>

A ZipFileEntry instance.

+

checkPassword

clone

exportBlob

  • exportBlob(options?): Promise<Blob>

  • Returns a Blob instance containing a zip file of the entry and its descendants

    +

Returns ZipEntry

exportBlob

exportData64URI

  • exportData64URI(options?): Promise<string>

  • Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants

    +

exportData64URI

exportUint8Array

exportUint8Array

exportWritable

  • exportWritable(writable?, options?): Promise<WritableStream<any>>

  • Creates a zip file via a WritableStream instance containing the entry and its descendants

    +

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to the Uint8Array instance.

+

exportWritable

exportZip

exportZip

  • exportZip(
        writer:
            | WritableStream<any>
            | WritableWriter
            | Writer<unknown>
            | AsyncGenerator<
                WritableStream<any>
                | WritableWriter
                | Writer<unknown>,
                any,
                any,
            >,
        options?: ZipDirectoryEntryExportOptions,
    ): Promise<unknown>

  • Creates a zip file via a custom Writer instance containing the entry and its descendants

    +

    Parameters

    Returns Promise<unknown>

    A promise resolving to the data.

    -

find

find

getById

getById

getChildByName

getChildByName

getFullname

getRelativeName

importBlob

getFullname

getRelativeName

importBlob

importData64URI

  • importData64URI(dataURI, options?): Promise<[ZipEntry]>

  • Extracts a zip file provided as a Data URI string encoded in Base64 into the entry

    +

Returns Promise<[ZipEntry]>

importData64URI

importHttpContent

  • importHttpContent(url, options?): Promise<[ZipEntry]>

  • Extracts a zip file fetched from a URL into the entry

    +

Returns Promise<[ZipEntry]>

importHttpContent

importReadable

  • importReadable(readable, options?): Promise<[ZipEntry]>

  • Extracts a zip file provided via a ReadableStream instance into the entry

    +

Returns Promise<[ZipEntry]>

importReadable

importUint8Array

importUint8Array

importZip

importZip

isDescendantOf

  • isDescendantOf(ancestor): boolean

  • Tests if a ZipDirectoryEntry instance is an ancestor of the entry

    +

Returns Promise<[ZipEntry]>

isDescendantOf

isPasswordProtected

move

Returns boolean

isPasswordProtected

move

remove

  • remove(entry): void

  • Removes a ZipEntry instance and its children

    +

Returns void

remove

rename

  • rename(name): void

  • Set the name of the entry

    +

Returns void

rename

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/HttpRangeReader.html b/api/classes/HttpRangeReader.html index 4d96e97e..d06c8520 100644 --- a/api/classes/HttpRangeReader.html +++ b/api/classes/HttpRangeReader.html @@ -1,17 +1,17 @@ -HttpRangeReader | @zip.js/zip.js

Class HttpRangeReader

Represents a Reader instance used to fetch data from servers returning Accept-Ranges headers.

-

Hierarchy (view full)

Constructors

constructor +HttpRangeReader | @zip.js/zip.js

Class HttpRangeReader

Represents a Reader instance used to fetch data from servers returning Accept-Ranges headers.

+

Hierarchy (View Summary)

Constructors

constructor

Properties

readable size

Methods

init? -readUint8Array -

Constructors

constructor

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optionalinit

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns HttpRangeReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optionalinit

readUint8Array

  • readUint8Array(
        index: number,
        length: number,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

      -

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a chunk of data.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/HttpReader.html b/api/classes/HttpReader.html index 0bcf8ebf..d1343a00 100644 --- a/api/classes/HttpReader.html +++ b/api/classes/HttpReader.html @@ -1,17 +1,17 @@ -HttpReader | @zip.js/zip.js

Class HttpReader

Represents a Reader instance used to fetch data from a URL.

-

Hierarchy (view full)

Constructors

constructor +HttpReader | @zip.js/zip.js

Class HttpReader

Represents a Reader instance used to fetch data from a URL.

+

Hierarchy (View Summary)

Constructors

constructor

Properties

readable size

Methods

init? -readUint8Array -

Constructors

constructor

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns HttpReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(
        index: number,
        length: number,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

      -

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a chunk of data.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/Reader.html b/api/classes/Reader.html index d101fc8e..bc301f82 100644 --- a/api/classes/Reader.html +++ b/api/classes/Reader.html @@ -1,20 +1,20 @@ -Reader | @zip.js/zip.js

Class Reader<Type>

Represents an instance used to read unknown type of data.

-

Example

Here is an example of custom Reader class used to read binary strings:

+Reader | @zip.js/zip.js

Class Reader<Type>

Represents an instance used to read unknown type of data.

+

Example

Here is an example of custom Reader class used to read binary strings:

class BinaryStringReader extends Reader {

  constructor(binaryString) {
    super();
    this.binaryString = binaryString;
  }

  init() {
    super.init();
    this.size = this.binaryString.length;
  }

  readUint8Array(offset, length) {
    const result = new Uint8Array(length);
    for (let indexCharacter = 0; indexCharacter < length; indexCharacter++) {
      result[indexCharacter] = this.binaryString.charCodeAt(indexCharacter + offset) & 0xFF;
    }
    return result;
  }
}
-

Type Parameters

  • Type

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

  • Type

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

readable size

Methods

init? -readUint8Array -

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optionalinit

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +readUint8Array +

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optionalinit

readUint8Array

  • readUint8Array(
        index: number,
        length: number,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

      -

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a chunk of data.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/SplitDataReader.html b/api/classes/SplitDataReader.html index 2f20a0c0..7b31e044 100644 --- a/api/classes/SplitDataReader.html +++ b/api/classes/SplitDataReader.html @@ -1,16 +1,16 @@ -SplitDataReader | @zip.js/zip.js

Class SplitDataReader

Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).

-

Hierarchy (view full)

Constructors

constructor +SplitDataReader | @zip.js/zip.js

Class SplitDataReader

Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).

+

Hierarchy (View Summary)

Constructors

constructor

Properties

readable size

Methods

init? -readUint8Array -

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +readUint8Array +

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(
        index: number,
        length: number,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

      -

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a chunk of data.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/SplitDataWriter.html b/api/classes/SplitDataWriter.html index 3419d5f2..17eeb91b 100644 --- a/api/classes/SplitDataWriter.html +++ b/api/classes/SplitDataWriter.html @@ -1,10 +1,10 @@ -SplitDataWriter | @zip.js/zip.js

Class SplitDataWriter

Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).

-

Hierarchy (view full)

Implements

Constructors

constructor +SplitDataWriter | @zip.js/zip.js

Class SplitDataWriter

Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).

+

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

writable

Methods

init -

Constructors

constructor

Constructors

constructor

  • new SplitDataWriter(
        writerGenerator: AsyncGenerator<
            WritableStream<any>
            | WritableWriter
            | Writer<unknown>,
            boolean,
            any,
        >,
        maxSize?: number,
    ): SplitDataWriter

  • Creates the SplitDataWriter instance

    +

    Parameters

    • writerGenerator: AsyncGenerator<
          WritableStream<any>
          | WritableWriter
          | Writer<unknown>,
          boolean,
          any,
      >

      A generator of Writer instances.

    • OptionalmaxSize: number

      The maximum size of the data written into Writer instances (default: 4GB).

      -

    Returns SplitDataWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

init

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns SplitDataWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

init

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/SplitZipReader.html b/api/classes/SplitZipReader.html index 9b76eb34..bc64dcff 100644 --- a/api/classes/SplitZipReader.html +++ b/api/classes/SplitZipReader.html @@ -1,17 +1,17 @@ -SplitZipReader | @zip.js/zip.js

Class SplitZipReader

Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).

-

Deprecated

Use SplitDataReader instead.

-

Hierarchy (view full)

Constructors

constructor +SplitZipReader | @zip.js/zip.js

Class SplitZipReader

Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).

+

Deprecated

Use SplitDataReader instead.

+

Hierarchy (View Summary)

Constructors

constructor

Properties

readable size

Methods

init? -readUint8Array -

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optionalinit

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +readUint8Array +

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optionalinit

readUint8Array

  • readUint8Array(
        index: number,
        length: number,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

      -

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a chunk of data.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/SplitZipWriter.html b/api/classes/SplitZipWriter.html index c505bd6c..e12deeb5 100644 --- a/api/classes/SplitZipWriter.html +++ b/api/classes/SplitZipWriter.html @@ -1,11 +1,11 @@ -SplitZipWriter | @zip.js/zip.js

Class SplitZipWriter

Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).

-

Deprecated

Use SplitDataWriter instead.

-

Hierarchy (view full)

Constructors

constructor +SplitZipWriter | @zip.js/zip.js

Class SplitZipWriter

Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).

+

Deprecated

Use SplitDataWriter instead.

+

Hierarchy (View Summary)

Constructors

constructor

Properties

writable

Methods

init -

Constructors

constructor

Constructors

constructor

  • new SplitZipWriter(
        writerGenerator: AsyncGenerator<
            WritableStream<any>
            | WritableWriter
            | Writer<unknown>,
            boolean,
            any,
        >,
        maxSize?: number,
    ): SplitZipWriter

  • Creates the SplitDataWriter instance

    +

    Parameters

    • writerGenerator: AsyncGenerator<
          WritableStream<any>
          | WritableWriter
          | Writer<unknown>,
          boolean,
          any,
      >

      A generator of Writer instances.

    • OptionalmaxSize: number

      The maximum size of the data written into Writer instances (default: 4GB).

      -

    Returns SplitZipWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

init

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns SplitZipWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

init

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/SyncCodec.html b/api/classes/SyncCodec.html index 37406da3..1adff420 100644 --- a/api/classes/SyncCodec.html +++ b/api/classes/SyncCodec.html @@ -1,6 +1,6 @@ -SyncCodec | @zip.js/zip.js

Class SyncCodec

Hierarchy (view full)

Constructors

constructor +SyncCodec | @zip.js/zip.js

Class SyncCodec

Hierarchy (View Summary)

Constructors

constructor

Methods

append -

Constructors

constructor

Methods

append

  • append(data): Uint8Array

  • Appends a chunk of decompressed data to compress

    -

    Parameters

    • data: Uint8Array

      The chunk of decompressed data to append.

      -

    Returns Uint8Array

    A chunk of compressed data.

    -

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

append

  • append(data: Uint8Array<ArrayBufferLike>): Uint8Array<ArrayBufferLike>

  • Appends a chunk of decompressed data to compress

    +

    Parameters

    • data: Uint8Array<ArrayBufferLike>

      The chunk of decompressed data to append.

      +

    Returns Uint8Array<ArrayBufferLike>

    A chunk of compressed data.

    +

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TextReader.html b/api/classes/TextReader.html index 0637dc8b..57333266 100644 --- a/api/classes/TextReader.html +++ b/api/classes/TextReader.html @@ -1,16 +1,16 @@ -TextReader | @zip.js/zip.js

Class TextReader

Represents a Reader instance used to read data provided as a string.

-

Hierarchy (view full)

Constructors

constructor +TextReader | @zip.js/zip.js

Class TextReader

Represents a Reader instance used to read data provided as a string.

+

Hierarchy (View Summary)

Constructors

constructor

Properties

readable size

Methods

init? -readUint8Array -

Constructors

constructor

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns TextReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(
        index: number,
        length: number,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

      -

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a chunk of data.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TextWriter.html b/api/classes/TextWriter.html index 48df78cd..1a38fe07 100644 --- a/api/classes/TextWriter.html +++ b/api/classes/TextWriter.html @@ -1,16 +1,16 @@ -TextWriter | @zip.js/zip.js

Class TextWriter

Represents a Writer instance used to retrieve the written data as a string.

-

Hierarchy (view full)

Constructors

constructor +TextWriter | @zip.js/zip.js

Class TextWriter

Represents a Writer instance used to retrieve the written data as a string.

+

Hierarchy (View Summary)

Constructors

constructor

Properties

writable -

Methods

getData +

Methods

getData init? -writeUint8Array -

Constructors

constructor

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

  • getData(): Promise<string>

  • Retrieves all the written data

    +

Returns TextWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

getData

  • getData(): Promise<string>

  • Retrieves all the written data

    Returns Promise<string>

    A promise resolving to the written data.

    -

Optionalinit

Optionalinit

  • init(size?: number): Promise<void>

  • Initializes the instance asynchronously

    Parameters

    • Optionalsize: number

      the total size of the written data in bytes.

      -

    Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    -

    Parameters

    • array: Uint8Array

      The chunk data to append.

      -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<void>

writeUint8Array

  • writeUint8Array(array: Uint8Array<ArrayBufferLike>): Promise<void>

  • Appends a chunk of data

    +

    Parameters

    • array: Uint8Array<ArrayBufferLike>

      The chunk data to append.

      +

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TransformStreamLike.html b/api/classes/TransformStreamLike.html index 651a91c2..c4793b28 100644 --- a/api/classes/TransformStreamLike.html +++ b/api/classes/TransformStreamLike.html @@ -1,8 +1,8 @@ -TransformStreamLike | @zip.js/zip.js

Class TransformStreamLike

Represents a generic TransformStream class.

-

See

https://streams.spec.whatwg.org/#generictransformstream|specification

-

Constructors

constructor +TransformStreamLike | @zip.js/zip.js

Class TransformStreamLike

Represents a generic TransformStream class.

+

See

https://streams.spec.whatwg.org/#generictransformstream|specification

+

Constructors

constructor

Properties

readable writable -

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The readable stream.

-

writable

writable: WritableStream<any>

The writable stream.

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The readable stream.

+

writable

writable: WritableStream<any>

The writable stream.

+

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/Uint8ArrayReader.html b/api/classes/Uint8ArrayReader.html index b07e0073..ddb2be96 100644 --- a/api/classes/Uint8ArrayReader.html +++ b/api/classes/Uint8ArrayReader.html @@ -1,16 +1,16 @@ -Uint8ArrayReader | @zip.js/zip.js

Class Uint8ArrayReader

Represents a Reader instance used to read data provided as a Uint8Array instance.

-

Hierarchy (view full)

  • Reader<Uint8Array>
    • Uint8ArrayReader

Constructors

constructor +Uint8ArrayReader | @zip.js/zip.js

Class Uint8ArrayReader

Represents a Reader instance used to read data provided as a Uint8Array instance.

+

Hierarchy (View Summary)

  • Reader<Uint8Array>
    • Uint8ArrayReader

Constructors

constructor

Properties

readable size

Methods

init? -readUint8Array -

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +readUint8Array +

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(
        index: number,
        length: number,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

      -

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a chunk of data.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/Uint8ArrayWriter.html b/api/classes/Uint8ArrayWriter.html index 61357ff7..7c656a3d 100644 --- a/api/classes/Uint8ArrayWriter.html +++ b/api/classes/Uint8ArrayWriter.html @@ -1,14 +1,14 @@ -Uint8ArrayWriter | @zip.js/zip.js

Class Uint8ArrayWriter

Represents a Writer instance used to retrieve the written data as a Uint8Array instance.

-

Hierarchy (view full)

  • Writer<Uint8Array>
    • Uint8ArrayWriter

Constructors

constructor +Uint8ArrayWriter | @zip.js/zip.js

Class Uint8ArrayWriter

Represents a Writer instance used to retrieve the written data as a Uint8Array instance.

+

Hierarchy (View Summary)

  • Writer<Uint8Array>
    • Uint8ArrayWriter

Constructors

constructor

Properties

writable -

Methods

getData +

Methods

getData init? -writeUint8Array -

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

  • getData(): Promise<Uint8Array>

  • Retrieves all the written data

    -

    Returns Promise<Uint8Array>

    A promise resolving to the written data.

    -

Optionalinit

  • init(size?): Promise<void>

  • Initializes the instance asynchronously

    +writeUint8Array +

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

getData

  • getData(): Promise<Uint8Array<ArrayBufferLike>>

  • Retrieves all the written data

    +

    Returns Promise<Uint8Array<ArrayBufferLike>>

    A promise resolving to the written data.

    +

Optionalinit

  • init(size?: number): Promise<void>

  • Initializes the instance asynchronously

    Parameters

    • Optionalsize: number

      the total size of the written data in bytes.

      -

    Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    -

    Parameters

    • array: Uint8Array

      The chunk data to append.

      -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<void>

writeUint8Array

  • writeUint8Array(array: Uint8Array<ArrayBufferLike>): Promise<void>

  • Appends a chunk of data

    +

    Parameters

    • array: Uint8Array<ArrayBufferLike>

      The chunk data to append.

      +

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/Writer.html b/api/classes/Writer.html index 6b7706ab..88db1969 100644 --- a/api/classes/Writer.html +++ b/api/classes/Writer.html @@ -1,18 +1,18 @@ -Writer | @zip.js/zip.js

Class Writer<Type>

Represents an instance used to write unknown type of data.

-

Example

Here is an example of custom Writer class used to write binary strings:

+Writer | @zip.js/zip.js

Class Writer<Type>

Represents an instance used to write unknown type of data.

+

Example

Here is an example of custom Writer class used to write binary strings:

class BinaryStringWriter extends Writer {

  constructor() {
    super();
    this.binaryString = "";
  }

  writeUint8Array(array) {
    for (let indexCharacter = 0; indexCharacter < array.length; indexCharacter++) {
      this.binaryString += String.fromCharCode(array[indexCharacter]);
    }
  }

  getData() {
    return this.binaryString;
  }
}
-

Type Parameters

  • Type

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

  • Type

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

writable -

Methods

getData +

Methods

getData init? -writeUint8Array -

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

  • getData(): Promise<Type>

  • Retrieves all the written data

    -

    Returns Promise<Type>

    A promise resolving to the written data.

    -

Optionalinit

  • init(size?): Promise<void>

  • Initializes the instance asynchronously

    +writeUint8Array +

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

getData

  • getData(): Promise<Type>

  • Retrieves all the written data

    +

    Returns Promise<Type>

    A promise resolving to the written data.

    +

Optionalinit

  • init(size?: number): Promise<void>

  • Initializes the instance asynchronously

    Parameters

    • Optionalsize: number

      the total size of the written data in bytes.

      -

    Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    -

    Parameters

    • array: Uint8Array

      The chunk data to append.

      -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<void>

writeUint8Array

  • writeUint8Array(array: Uint8Array<ArrayBufferLike>): Promise<void>

  • Appends a chunk of data

    +

    Parameters

    • array: Uint8Array<ArrayBufferLike>

      The chunk data to append.

      +

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ZipDeflate.html b/api/classes/ZipDeflate.html index fa14e055..1eb7d867 100644 --- a/api/classes/ZipDeflate.html +++ b/api/classes/ZipDeflate.html @@ -1,10 +1,10 @@ -ZipDeflate | @zip.js/zip.js

Class ZipDeflate

Represents an instance used to compress data.

-

Hierarchy (view full)

Constructors

constructor +ZipDeflate | @zip.js/zip.js

Class ZipDeflate

Represents an instance used to compress data.

+

Hierarchy (View Summary)

Constructors

constructor

Methods

append flush -

Constructors

constructor

Methods

append

  • append(data): Uint8Array

  • Appends a chunk of decompressed data to compress

    -

    Parameters

    • data: Uint8Array

      The chunk of decompressed data to append.

      -

    Returns Uint8Array

    A chunk of compressed data.

    -

flush

  • flush(): Uint8Array

  • Flushes the data

    -

    Returns Uint8Array

    A chunk of compressed data.

    -

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

append

  • append(data: Uint8Array<ArrayBufferLike>): Uint8Array<ArrayBufferLike>

  • Appends a chunk of decompressed data to compress

    +

    Parameters

    • data: Uint8Array<ArrayBufferLike>

      The chunk of decompressed data to append.

      +

    Returns Uint8Array<ArrayBufferLike>

    A chunk of compressed data.

    +

flush

  • flush(): Uint8Array<ArrayBufferLike>

  • Flushes the data

    +

    Returns Uint8Array<ArrayBufferLike>

    A chunk of compressed data.

    +

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ZipDirectoryEntry.html b/api/classes/ZipDirectoryEntry.html index 64aaa6ff..ada31cd6 100644 --- a/api/classes/ZipDirectoryEntry.html +++ b/api/classes/ZipDirectoryEntry.html @@ -1,140 +1,140 @@ -ZipDirectoryEntry | @zip.js/zip.js

Class ZipDirectoryEntry

Represents a directory entry in the zip (Filesystem API).

-

Hierarchy (view full)

Constructors

constructor +ZipDirectoryEntry | @zip.js/zip.js

Class ZipDirectoryEntry

Represents a directory entry in the zip (Filesystem API).

+

Hierarchy (View Summary)

Constructors

constructor

Properties

children data? directory id name parent? -uncompressedSize -

Methods

addBlob -addData64URI -addDirectory -addFile -addFileSystemEntry -addFileSystemHandle -addHttpContent -addReadable -addText -addUint8Array -checkPassword +uncompressedSize +

Methods

addBlob +addData64URI +addDirectory +addFile +addFileSystemEntry +addFileSystemHandle +addHttpContent +addReadable +addText +addUint8Array +checkPassword clone -exportBlob -exportData64URI -exportUint8Array -exportWritable -exportZip -getChildByName -getFullname -getRelativeName -importBlob -importData64URI -importHttpContent -importReadable -importUint8Array -importZip -isDescendantOf -isPasswordProtected +exportBlob +exportData64URI +exportUint8Array +exportWritable +exportZip +getChildByName +getFullname +getRelativeName +importBlob +importData64URI +importHttpContent +importReadable +importUint8Array +importZip +isDescendantOf +isPasswordProtected rename -

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

-

Optionaldata

data?: EntryMetaData

The underlying EntryMetaData instance.

-

directory

directory

true for ZipDirectoryEntry instances.

-

id

id: number

The ID of the instance.

-

name

name: string

The relative filename of the entry.

-

Optionalparent

parent?: ZipEntry

The parent directory of the entry.

-

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

-

Methods

addBlob

  • addBlob(name, blob, options?): ZipFileEntry<Blob, Blob>

  • Adds a entry entry with content provided as a Blob instance

    +

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

+

Optionaldata

data?: EntryMetaData

The underlying EntryMetaData instance.

+

directory

directory: true

true for ZipDirectoryEntry instances.

+

id

id: number

The ID of the instance.

+

name

name: string

The relative filename of the entry.

+

Optionalparent

parent?: ZipEntry

The parent directory of the entry.

+

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

+

Methods

addBlob

addData64URI

  • addData64URI(name, dataURI, options?): ZipFileEntry<string, string>

  • Adds a entry entry with content provided as a Data URI string encoded in Base64

    +

Returns ZipFileEntry<Blob, Blob>

A ZipFileEntry instance.

+

addData64URI

addDirectory

Returns ZipFileEntry<string, string>

A ZipFileEntry instance.

+

addDirectory

addFile

  • addFile(file, options?): Promise<ZipEntry>

  • Adds an entry with content provided via a File instance

    +

addFile

addFileSystemEntry

  • addFileSystemEntry(fileSystemEntry, options?): Promise<ZipEntry[]>

  • Adds an entry with content provided via a FileSystemEntry instance

    +

addFileSystemEntry

addFileSystemHandle

  • addFileSystemHandle(fileSystemHandle, options?): Promise<ZipEntry[]>

  • Adds an entry with content provided via a FileSystemHandle instance

    +

addFileSystemHandle

addHttpContent

  • addHttpContent(name, url, options?): ZipFileEntry<string, void>

  • Adds an entry with content fetched from a URL

    +

addHttpContent

addReadable

Returns ZipFileEntry<string, void>

A ZipFileEntry instance.

+

addReadable

  • addReadable(
        name: string,
        readable: ReadableStream<any>,
        options?: ZipWriterAddDataOptions,
    ): ZipFileEntry<ReadableStream<any>, void>

  • Adds a entry entry with content provided via a ReadableStream instance

    Parameters

    • name: string

      The relative filename of the entry.

    • readable: ReadableStream<any>

      The ReadableStream instance.

    • Optionaloptions: ZipWriterAddDataOptions

      The options.

      -

    Returns ZipFileEntry<ReadableStream<any>, void>

    A ZipFileEntry instance.

    -

addText

  • addText(name, text, options?): ZipFileEntry<string, string>

  • Adds an entry with content provided as text

    +

Returns ZipFileEntry<ReadableStream<any>, void>

A ZipFileEntry instance.

+

addText

addUint8Array

  • addUint8Array(name, array, options?): ZipFileEntry<Uint8Array, Uint8Array>

  • Adds an entry with content provided as a Uint8Array instance

    +

Returns ZipFileEntry<string, string>

A ZipFileEntry instance.

+

addUint8Array

  • addUint8Array(
        name: string,
        array: Uint8Array<ArrayBufferLike>,
        options?: ZipWriterAddDataOptions,
    ): ZipFileEntry<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>

  • Adds an entry with content provided as a Uint8Array instance

    Parameters

    • name: string

      The relative filename of the entry.

      -
    • array: Uint8Array

      The Uint8Array instance.

      +
    • array: Uint8Array<ArrayBufferLike>

      The Uint8Array instance.

    • Optionaloptions: ZipWriterAddDataOptions

      The options.

      -

    Returns ZipFileEntry<Uint8Array, Uint8Array>

    A ZipFileEntry instance.

    -

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    -

    Parameters

    Returns Promise<boolean>

clone

  • clone(deepClone?): ZipEntry

  • Clones the entry

    +

Returns ZipFileEntry<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>

A ZipFileEntry instance.

+

checkPassword

clone

exportBlob

  • exportBlob(options?): Promise<Blob>

  • Returns a Blob instance containing a zip file of the entry and its descendants

    +

Returns ZipEntry

exportBlob

exportData64URI

  • exportData64URI(options?): Promise<string>

  • Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants

    +

exportData64URI

exportUint8Array

  • exportUint8Array(options?): Promise<Uint8Array>

  • Returns a Uint8Array instance containing a zip file of the entry and its descendants

    +

exportUint8Array

exportWritable

  • exportWritable(writable?, options?): Promise<WritableStream<any>>

  • Creates a zip file via a WritableStream instance containing the entry and its descendants

    +

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to the Uint8Array instance.

+

exportWritable

  • exportWritable(
        writable?: WritableStream<any>,
        options?: ZipDirectoryEntryExportOptions,
    ): Promise<WritableStream<any>>

  • Creates a zip file via a WritableStream instance containing the entry and its descendants

    Parameters

    Returns Promise<WritableStream<any>>

    A promise resolving to the Uint8Array instance.

    -

exportZip

  • exportZip(writer, options?): Promise<unknown>

  • Creates a zip file via a custom Writer instance containing the entry and its descendants

    -

    Parameters

exportZip

  • exportZip(
        writer:
            | WritableStream<any>
            | WritableWriter
            | Writer<unknown>
            | AsyncGenerator<
                WritableStream<any>
                | WritableWriter
                | Writer<unknown>,
                any,
                any,
            >,
        options?: ZipDirectoryEntryExportOptions,
    ): Promise<unknown>

  • Creates a zip file via a custom Writer instance containing the entry and its descendants

    +

    Parameters

    Returns Promise<unknown>

    A promise resolving to the data.

    -

getChildByName

getChildByName

getFullname

getRelativeName

importBlob

  • importBlob(blob, options?): Promise<[ZipEntry]>

  • Extracts a zip file provided as a Blob instance into the entry

    +

getFullname

getRelativeName

importBlob

importData64URI

  • importData64URI(dataURI, options?): Promise<[ZipEntry]>

  • Extracts a zip file provided as a Data URI string encoded in Base64 into the entry

    +

Returns Promise<[ZipEntry]>

importData64URI

importHttpContent

  • importHttpContent(url, options?): Promise<[ZipEntry]>

  • Extracts a zip file fetched from a URL into the entry

    +

Returns Promise<[ZipEntry]>

importHttpContent

importReadable

  • importReadable(readable, options?): Promise<[ZipEntry]>

  • Extracts a zip file provided via a ReadableStream instance into the entry

    +

Returns Promise<[ZipEntry]>

importReadable

importUint8Array

  • importUint8Array(array, options?): Promise<[ZipEntry]>

  • Extracts a zip file provided as a Uint8Array instance into the entry

    -

    Parameters

    • array: Uint8Array

      The Uint8Array instance.

      +

    Returns Promise<[ZipEntry]>

importUint8Array

importZip

importZip

isDescendantOf

  • isDescendantOf(ancestor): boolean

  • Tests if a ZipDirectoryEntry instance is an ancestor of the entry

    +

Returns Promise<[ZipEntry]>

isDescendantOf

isPasswordProtected

rename

  • rename(name): void

  • Set the name of the entry

    +

Returns boolean

isPasswordProtected

rename

  • rename(name: string): void

  • Set the name of the entry

    Parameters

    • name: string

      The new name of the entry.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ZipEntry.html b/api/classes/ZipEntry.html index dbe6e40d..78c12045 100644 --- a/api/classes/ZipEntry.html +++ b/api/classes/ZipEntry.html @@ -1,32 +1,32 @@ -ZipEntry | @zip.js/zip.js

Class ZipEntry

Represents an entry in a zip file (Filesystem API).

-

Hierarchy (view full)

Constructors

constructor +ZipEntry | @zip.js/zip.js

Class ZipEntry

Represents an entry in a zip file (Filesystem API).

+

Hierarchy (View Summary)

Constructors

constructor

Properties

children data? id name parent? -uncompressedSize -

Methods

checkPassword +uncompressedSize +

Methods

checkPassword clone -getFullname -getRelativeName -isDescendantOf -isPasswordProtected +getFullname +getRelativeName +isDescendantOf +isPasswordProtected rename -

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

-

Optionaldata

data?: EntryMetaData

The underlying EntryMetaData instance.

-

id

id: number

The ID of the instance.

-

name

name: string

The relative filename of the entry.

-

Optionalparent

parent?: ZipEntry

The parent directory of the entry.

-

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

-

Methods

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    -

    Parameters

    Returns Promise<boolean>

clone

  • clone(deepClone?): ZipEntry

  • Clones the entry

    +

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

+

Optionaldata

data?: EntryMetaData

The underlying EntryMetaData instance.

+

id

id: number

The ID of the instance.

+

name

name: string

The relative filename of the entry.

+

Optionalparent

parent?: ZipEntry

The parent directory of the entry.

+

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

+

Methods

checkPassword

  • checkPassword(password: string, options?: EntryGetDataOptions): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    +

    Parameters

    Returns Promise<boolean>

clone

  • clone(deepClone?: boolean): ZipEntry

  • Clones the entry

    Parameters

    • OptionaldeepClone: boolean

      true to clone all the descendants.

      -

    Returns ZipEntry

getFullname

  • getFullname(): string

  • Returns the full filename of the entry

    -

    Returns string

getRelativeName

  • getRelativeName(ancestor): string

  • Returns the filename of the entry relative to a parent directory

    -

    Parameters

    Returns string

isDescendantOf

  • isDescendantOf(ancestor): boolean

  • Tests if a ZipDirectoryEntry instance is an ancestor of the entry

    +

Returns ZipEntry

getFullname

  • getFullname(): string

  • Returns the full filename of the entry

    +

    Returns string

getRelativeName

isDescendantOf

isPasswordProtected

  • isPasswordProtected(): boolean

  • Tests if the entry or any of its children is password protected

    -

    Returns boolean

rename

  • rename(name): void

  • Set the name of the entry

    +

Returns boolean

isPasswordProtected

  • isPasswordProtected(): boolean

  • Tests if the entry or any of its children is password protected

    +

    Returns boolean

rename

  • rename(name: string): void

  • Set the name of the entry

    Parameters

    • name: string

      The new name of the entry.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ZipFileEntry.html b/api/classes/ZipFileEntry.html index 5df7ec48..bf251e1d 100644 --- a/api/classes/ZipFileEntry.html +++ b/api/classes/ZipFileEntry.html @@ -1,5 +1,5 @@ -ZipFileEntry | @zip.js/zip.js

Class ZipFileEntry<ReaderType, WriterType>

Represents a file entry in the zip (Filesystem API).

-

Type Parameters

  • ReaderType
  • WriterType

Hierarchy (view full)

Constructors

constructor +ZipFileEntry | @zip.js/zip.js

Class ZipFileEntry<ReaderType, WriterType>

Represents a file entry in the zip (Filesystem API).

+

Type Parameters

  • ReaderType
  • WriterType

Hierarchy (View Summary)

Constructors

constructor

Properties

children data? directory @@ -7,76 +7,76 @@ name parent? reader -uncompressedSize +uncompressedSize writer -

Methods

checkPassword +

Methods

checkPassword clone -getBlob -getData -getData64URI -getFullname -getRelativeName -getText -getUint8Array -getWritable -isDescendantOf -isPasswordProtected +getBlob +getData +getData64URI +getFullname +getRelativeName +getText +getUint8Array +getWritable +isDescendantOf +isPasswordProtected rename -replaceBlob -replaceData64URI -replaceReadable -replaceText -replaceUint8Array -

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

-

Optionaldata

data?: EntryMetaData

The underlying EntryMetaData instance.

-

directory

directory: void

void for ZipFileEntry instances.

-

id

id: number

The ID of the instance.

-

name

name: string

The relative filename of the entry.

-

Optionalparent

parent?: ZipEntry

The parent directory of the entry.

-

reader

reader:
    | ReadableStream<any>
    | ReadableReader
    | Reader<unknown>[]
    | ReadableReader[]
    | ReadableStream<any>[]
    | Reader<ReaderType>

The Reader instance used to read the content of the entry.

-

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

-

writer

writer:
    | WritableStream<any>
    | WritableWriter
    | Writer<WriterType>
    | AsyncGenerator<WritableStream<any> | WritableWriter | Writer<unknown>, any, any>

The Writer instance used to write the content of the entry.

-

Methods

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    -

    Parameters

    Returns Promise<boolean>

clone

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

+

Optionaldata

data?: EntryMetaData

The underlying EntryMetaData instance.

+

directory

directory: void

void for ZipFileEntry instances.

+

id

id: number

The ID of the instance.

+

name

name: string

The relative filename of the entry.

+

Optionalparent

parent?: ZipEntry

The parent directory of the entry.

+

reader

reader:
    | ReadableStream<any>
    | ReadableReader
    | Reader<unknown>[]
    | ReadableReader[]
    | ReadableStream<any>[]
    | Reader<ReaderType>

The Reader instance used to read the content of the entry.

+

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

+

writer

writer:
    | WritableStream<any>
    | WritableWriter
    | Writer<WriterType>
    | AsyncGenerator<
        WritableStream<any>
        | WritableWriter
        | Writer<unknown>,
        any,
        any,
    >

The Writer instance used to write the content of the entry.

+

Methods

checkPassword

clone

getBlob

  • getBlob(mimeType?, options?): Promise<Blob>

  • Retrieves the content of the entry as a Blob instance

    +

Returns ZipEntry

getBlob

  • getBlob(mimeType?: string, options?: EntryGetDataOptions): Promise<Blob>

  • Retrieves the content of the entry as a Blob instance

    Parameters

    • OptionalmimeType: string

      The MIME type of the content.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<Blob>

    A promise resolving to a Blob instance.

    -

getData

  • getData(writer, options?): Promise<unknown>

  • Retrieves the content of the entry via a Writer instance

    -

    Parameters

getData

  • getData(
        writer:
            | WritableStream<any>
            | WritableWriter
            | Writer<unknown>
            | AsyncGenerator<
                WritableStream<any>
                | WritableWriter
                | Writer<unknown>,
                any,
                any,
            >,
        options?: EntryGetDataOptions,
    ): Promise<unknown>

  • Retrieves the content of the entry via a Writer instance

    +

    Parameters

    • writer:
          | WritableStream<any>
          | WritableWriter
          | Writer<unknown>
          | AsyncGenerator<
              WritableStream<any>
              | WritableWriter
              | Writer<unknown>,
              any,
              any,
          >

      The Writer instance.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<unknown>

    A promise resolving to data associated to the Writer instance.

    -

getData64URI

  • getData64URI(mimeType?, options?): Promise<string>

  • Retrieves the content of the entry as as a Data URI string encoded in Base64

    +

getData64URI

  • getData64URI(mimeType?: string, options?: EntryGetDataOptions): Promise<string>

  • Retrieves the content of the entry as as a Data URI string encoded in Base64

    Parameters

    • OptionalmimeType: string

      The MIME type of the content.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<string>

    A promise resolving to a Data URI string encoded in Base64.

    -

getFullname

getRelativeName

getText

  • getText(encoding?, options?): Promise<string>

  • Retrieves the text content of the entry as a string

    +

getFullname

getRelativeName

getText

  • getText(encoding?: string, options?: EntryGetDataOptions): Promise<string>

  • Retrieves the text content of the entry as a string

    Parameters

    • Optionalencoding: string

      The encoding of the text.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<string>

    A promise resolving to a string.

    -

getUint8Array

  • getUint8Array(options?): Promise<Uint8Array>

  • Retrieves the content of the entry as a Uint8Array instance

    +

getUint8Array

  • getUint8Array(
        options?: EntryGetDataOptions,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Retrieves the content of the entry as a Uint8Array instance

    Parameters

    Returns Promise<Uint8Array>

    A promise resolving to a Uint8Array instance.

    -

getWritable

  • getWritable(writable?, options?): Promise<WritableStream<any>>

  • Retrieves the content of the entry via a WritableStream instance

    +

Returns Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to a Uint8Array instance.

+

getWritable

  • getWritable(
        writable?: WritableStream<any>,
        options?: EntryGetDataOptions,
    ): Promise<WritableStream<any>>

  • Retrieves the content of the entry via a WritableStream instance

    Parameters

    • Optionalwritable: WritableStream<any>

      The WritableStream instance.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<WritableStream<any>>

    A promise resolving to the WritableStream instance.

    -

isDescendantOf

isDescendantOf

isPasswordProtected

rename

  • rename(name): void

  • Set the name of the entry

    +

Returns boolean

isPasswordProtected

rename

  • rename(name: string): void

  • Set the name of the entry

    Parameters

    • name: string

      The new name of the entry.

      -

    Returns void

replaceBlob

  • replaceBlob(blob): void

  • Replaces the content of the entry with a Blob instance

    +

Returns void

replaceBlob

  • replaceBlob(blob: Blob): void

  • Replaces the content of the entry with a Blob instance

    Parameters

    • blob: Blob

      The Blob instance.

      -

    Returns void

replaceData64URI

  • replaceData64URI(dataURI): void

  • Replaces the content of the entry with a Data URI string encoded in Base64

    +

Returns void

replaceData64URI

  • replaceData64URI(dataURI: string): void

  • Replaces the content of the entry with a Data URI string encoded in Base64

    Parameters

    • dataURI: string

      The Data URI string encoded in Base64.

      -

    Returns void

replaceReadable

  • replaceReadable(readable): void

  • Replaces the content of the entry with a ReadableStream instance

    +

Returns void

replaceReadable

  • replaceReadable(readable: ReadableStream<any>): void

  • Replaces the content of the entry with a ReadableStream instance

    Parameters

    • readable: ReadableStream<any>

      The ReadableStream instance.

      -

    Returns void

replaceText

  • replaceText(text): void

  • Replaces the content of the entry with a string

    +

Returns void

replaceText

  • replaceText(text: string): void

  • Replaces the content of the entry with a string

    Parameters

    • text: string

      The string.

      -

    Returns void

replaceUint8Array

  • replaceUint8Array(array): void

  • Replaces the content of the entry with a Uint8Array instance

    -

    Parameters

    • array: Uint8Array

      The Uint8Array instance.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns void

replaceUint8Array

  • replaceUint8Array(array: Uint8Array<ArrayBufferLike>): void

  • Replaces the content of the entry with a Uint8Array instance

    +

    Parameters

    • array: Uint8Array<ArrayBufferLike>

      The Uint8Array instance.

      +

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ZipInflate.html b/api/classes/ZipInflate.html index d359ea60..aa17a552 100644 --- a/api/classes/ZipInflate.html +++ b/api/classes/ZipInflate.html @@ -1,9 +1,9 @@ -ZipInflate | @zip.js/zip.js

Class ZipInflate

Represents a codec used to decompress data.

-

Hierarchy (view full)

Constructors

constructor +ZipInflate | @zip.js/zip.js

Class ZipInflate

Represents a codec used to decompress data.

+

Hierarchy (View Summary)

Constructors

constructor

Methods

append flush -

Constructors

constructor

Methods

append

  • append(data): Uint8Array

  • Appends a chunk of decompressed data to compress

    -

    Parameters

    • data: Uint8Array

      The chunk of decompressed data to append.

      -

    Returns Uint8Array

    A chunk of compressed data.

    -

flush

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

append

  • append(data: Uint8Array<ArrayBufferLike>): Uint8Array<ArrayBufferLike>

  • Appends a chunk of decompressed data to compress

    +

    Parameters

    • data: Uint8Array<ArrayBufferLike>

      The chunk of decompressed data to append.

      +

    Returns Uint8Array<ArrayBufferLike>

    A chunk of compressed data.

    +

flush

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ZipReader.html b/api/classes/ZipReader.html index a744062a..7658fafc 100644 --- a/api/classes/ZipReader.html +++ b/api/classes/ZipReader.html @@ -1,26 +1,26 @@ -ZipReader | @zip.js/zip.js

Class ZipReader<Type>

Represents an instance used to read a zip file.

-

Example

Here is an example showing how to read the text data of the first entry from a zip file:

+ZipReader | @zip.js/zip.js

Class ZipReader<Type>

Represents an instance used to read a zip file.

+

Example

Here is an example showing how to read the text data of the first entry from a zip file:

// create a BlobReader to read with a ZipReader the zip from a Blob object
const reader = new zip.ZipReader(new zip.BlobReader(blob));

// get all entries from the zip
const entries = await reader.getEntries();
if (entries.length) {

  // get first entry content as text by using a TextWriter
  const text = await entries[0].getData(
    // writer
    new zip.TextWriter(),
    // options
    {
      onprogress: (index, max) => {
        // onprogress callback
      }
    }
  );
  // text contains the entry data as a String
  console.log(text);
}

// close the ZipReader
await reader.close();
-

Type Parameters

  • Type

Constructors

constructor -

Properties

appendedData? +

Type Parameters

  • Type

Constructors

constructor +

Properties

appendedData? comment -prependedData? +prependedData?

Methods

close -getEntries -getEntriesGenerator -

Constructors

constructor

Constructors

constructor

Properties

OptionalappendedData

appendedData?: Uint8Array

The data appended after the zip file.

-

comment

comment: Uint8Array

The global comment of the zip file.

-

OptionalprependedData

prependedData?: Uint8Array

The data prepended before the zip file.

-

Methods

close

  • close(): Promise<void>

  • Closes the zip file

    -

    Returns Promise<void>

getEntries

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

  • Returns all the entries in the zip file

    +

Returns ZipReader<Type>

Properties

OptionalappendedData

appendedData?: Uint8Array<ArrayBufferLike>

The data appended after the zip file.

+

comment

comment: Uint8Array<ArrayBufferLike>

The global comment of the zip file.

+

OptionalprependedData

prependedData?: Uint8Array<ArrayBufferLike>

The data prepended before the zip file.

+

Methods

close

  • close(): Promise<void>

  • Closes the zip file

    +

    Returns Promise<void>

getEntries

getEntriesGenerator

  • getEntriesGenerator(options?): AsyncGenerator<Entry, boolean, any>

  • Returns a generator used to iterate on all the entries in the zip file

    +

getEntriesGenerator

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns AsyncGenerator<Entry, boolean, any>

An asynchronous generator of Entry instances.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ZipReaderStream.html b/api/classes/ZipReaderStream.html index 20729c2f..9e1dff88 100644 --- a/api/classes/ZipReaderStream.html +++ b/api/classes/ZipReaderStream.html @@ -1,13 +1,13 @@ -ZipReaderStream | @zip.js/zip.js

Class ZipReaderStream<T>

Represents an instance used to create an unzipped stream.

-

Example

This example will take a zip file, decompress it and then save its files and directories to disk.

+ZipReaderStream | @zip.js/zip.js

Class ZipReaderStream<T>

Represents an instance used to create an unzipped stream.

+

Example

This example will take a zip file, decompress it and then save its files and directories to disk.

import {resolve} from "https://deno.land/std/path/mod.ts";
import {ensureDir, ensureFile} from "https://deno.land/std/fs/mod.ts";

for await (const entry of (await fetch(urlToZippedFile)).body.pipeThrough(new ZipReaderStream())) {
  const fullPath = resolve(destination, entry.filename);
  if (entry.directory) {
    await ensureDir(fullPath);
    continue;
  }

  await ensureFile(fullPath);
  await entry.readable?.pipeTo((await Deno.create(fullPath)).writable);
}
-

Type Parameters

  • T

Constructors

constructor +

Type Parameters

  • T

Constructors

constructor

Properties

readable writable -

Constructors

constructor

Properties

readable

readable: ReadableStream<Omit<Entry, "getData"> & {
    readable?: ReadableStream<Uint8Array>;
}>

The readable stream.

-

writable

writable: WritableStream<T>

The writable stream.

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

readable

readable: ReadableStream<
    Omit<Entry, "getData"> & {
        readable?: ReadableStream<Uint8Array<ArrayBufferLike>>;
    },
>

The readable stream.

+

writable

writable: WritableStream<T>

The writable stream.

+

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/ZipWriter.html b/api/classes/ZipWriter.html index 7d3582c6..301a822c 100644 --- a/api/classes/ZipWriter.html +++ b/api/classes/ZipWriter.html @@ -1,23 +1,23 @@ -ZipWriter | @zip.js/zip.js

Class ZipWriter<Type>

Represents an instance used to create a zip file.

-

Example

Here is an example showing how to create a zip file containing a compressed text file:

+ZipWriter | @zip.js/zip.js

Class ZipWriter<Type>

Represents an instance used to create a zip file.

+

Example

Here is an example showing how to create a zip file containing a compressed text file:

// use a BlobWriter to store with a ZipWriter the zip into a Blob object
const blobWriter = new zip.BlobWriter("application/zip");
const writer = new zip.ZipWriter(blobWriter);

// use a TextReader to read the String to add
await writer.add("filename.txt", new zip.TextReader("test!"));

// close the ZipReader
await writer.close();

// get the zip file as a Blob
const blob = await blobWriter.getData();
-

Type Parameters

  • Type

Constructors

constructor -

Properties

hasCorruptedEntries? +

Type Parameters

  • Type

Constructors

constructor +

Properties

hasCorruptedEntries?

Methods

add close -

Constructors

constructor

Constructors

constructor

Properties

Optional ReadonlyhasCorruptedEntries

hasCorruptedEntries?: boolean

true if the zip contains at least one entry that has been partially written.

-

Methods

add

Properties

Optional ReadonlyhasCorruptedEntries

hasCorruptedEntries?: boolean

true if the zip contains at least one entry that has been partially written.

+

Methods

add

close

  • close(comment?, options?): Promise<Type>

  • Writes the entries directory, writes the global comment, and returns the content of the zip file

    -

    Parameters

    • Optionalcomment: Uint8Array

      The global comment of the zip file.

      +

close

  • close(
        comment?: Uint8Array<ArrayBufferLike>,
        options?: ZipWriterCloseOptions,
    ): Promise<Type>

  • Writes the entries directory, writes the global comment, and returns the content of the zip file

    +

    Parameters

    • Optionalcomment: Uint8Array<ArrayBufferLike>

      The global comment of the zip file.

    • Optionaloptions: ZipWriterCloseOptions

      The options.

      -

    Returns Promise<Type>

    The content of the zip file.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<Type>

The content of the zip file.

+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ZipWriterStream.html b/api/classes/ZipWriterStream.html index 9c0bf67c..f2ffc0ff 100644 --- a/api/classes/ZipWriterStream.html +++ b/api/classes/ZipWriterStream.html @@ -1,30 +1,30 @@ -ZipWriterStream | @zip.js/zip.js

Class ZipWriterStream

Represents an instance used to create a zipped stream.

-

Example

This example creates a zipped file called numbers.txt.zip containing the numbers 0 - 1000 each on their own line.

+ZipWriterStream | @zip.js/zip.js

Class ZipWriterStream

Represents an instance used to create a zipped stream.

+

Example

This example creates a zipped file called numbers.txt.zip containing the numbers 0 - 1000 each on their own line.

const readable = ReadableStream.from((function* () {
  for (let i = 0; i < 1000; ++i)
    yield i + '\n'
})())

readable
  .pipeThrough(new ZipWriterStream().transform('numbers.txt'))
  .pipeTo((await Deno.create('numbers.txt.zip')).writable)
-

Example

This example creates a zipped file called Archive.zip containing two files called numbers.txt and letters.txt

+

Example

This example creates a zipped file called Archive.zip containing two files called numbers.txt and letters.txt

const readable1 = ReadableStream.from((function* () {
  for (let i = 0; i < 1000; ++i)
    yield i + '\n'
})())
const readable2 = ReadableStream.from((function* () {
  const letters = 'abcdefghijklmnopqrstuvwxyz'.split('')
  while (letters.length)
    yield letters.shift() + '\n'
})())

const zipper = new ZipWriterStream()
zipper.readable.pipeTo((await Deno.create('Archive.zip')).writable)
readable1.pipeTo(zipper.writable('numbers.txt'))
readable2.pipeTo(zipper.writable('letters.txt'))
zipper.close()
-

Constructors

constructor +

Constructors

constructor

Properties

readable -zipWriter +zipWriter

Methods

close transform -writable -

Constructors

constructor

Constructors

constructor

Properties

readable

readable: ReadableStream<Uint8Array>

The readable stream.

-

zipWriter

zipWriter: ZipWriter<unknown>

The ZipWriter property.

-

Methods

close

  • close(comment?, options?): Promise<unknown>

  • Writes the entries directory, writes the global comment, and returns the content of the zipped file.

    -

    Parameters

    • Optionalcomment: Uint8Array

      The global comment of the zip file.

      +

    Returns ZipWriterStream

Properties

readable

readable: ReadableStream<Uint8Array<ArrayBufferLike>>

The readable stream.

+

zipWriter

zipWriter: ZipWriter<unknown>

The ZipWriter property.

+

Methods

close

  • close(
        comment?: Uint8Array<ArrayBufferLike>,
        options?: ZipWriterCloseOptions,
    ): Promise<unknown>

  • Writes the entries directory, writes the global comment, and returns the content of the zipped file.

    +

    Parameters

    • Optionalcomment: Uint8Array<ArrayBufferLike>

      The global comment of the zip file.

    • Optionaloptions: ZipWriterCloseOptions

      The options.

    Returns Promise<unknown>

    The content of the zip file.

    -

transform

  • transform<T>(path): {
        readable: ReadableStream<T>;
        writable: WritableStream<T>;
    }

  • Returns an object containing a readable and writable property for the .pipeThrough method

    -

    Type Parameters

    • T

    Parameters

    • path: string

      The name of the stream when unzipped.

      -

    Returns {
        readable: ReadableStream<T>;
        writable: WritableStream<T>;
    }

    An object containing readable and writable properties

    -
    • readable: ReadableStream<T>
    • writable: WritableStream<T>

writable

  • writable<T>(path): WritableStream<T>

  • Returns a WritableStream for the .pipeTo method

    -

    Type Parameters

    • T

    Parameters

    • path: string

      The directory path of where the stream should exist in the zipped stream.

      -

    Returns WritableStream<T>

    A WritableStream.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

transform

  • transform<T>(
        path: string,
    ): { readable: ReadableStream<T>; writable: WritableStream<T> }

  • Returns an object containing a readable and writable property for the .pipeThrough method

    +

    Type Parameters

    • T

    Parameters

    • path: string

      The name of the stream when unzipped.

      +

    Returns { readable: ReadableStream<T>; writable: WritableStream<T> }

    An object containing readable and writable properties

    +

writable

  • writable<T>(path: string): WritableStream<T>

  • Returns a WritableStream for the .pipeTo method

    +

    Type Parameters

    • T

    Parameters

    • path: string

      The directory path of where the stream should exist in the zipped stream.

      +

    Returns WritableStream<T>

    A WritableStream.

    +

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/functions/configure.html b/api/functions/configure.html index 49d946e8..246da962 100644 --- a/api/functions/configure.html +++ b/api/functions/configure.html @@ -1,3 +1,3 @@ -configure | @zip.js/zip.js

Function configure

  • configure(configuration): void

  • Configures zip.js

    +configure | @zip.js/zip.js

    Function configure

    Settings

    Member Visibility
    +

Returns void

Settings

Member Visibility
diff --git a/api/functions/getMimeType.html b/api/functions/getMimeType.html index 79475377..e796bdd2 100644 --- a/api/functions/getMimeType.html +++ b/api/functions/getMimeType.html @@ -1,4 +1,4 @@ -getMimeType | @zip.js/zip.js

Function getMimeType

  • getMimeType(fileExtension): string

  • Returns the MIME type corresponding to a filename extension.

    +getMimeType | @zip.js/zip.js

    Function getMimeType

    • getMimeType(fileExtension: string): string

    • Returns the MIME type corresponding to a filename extension.

      Parameters

      • fileExtension: string

        the extension of the filename.

      Returns string

      The corresponding MIME type.

      -

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/api/functions/initShimAsyncCodec.html b/api/functions/initShimAsyncCodec.html index 616cdd0b..fd2b7fc2 100644 --- a/api/functions/initShimAsyncCodec.html +++ b/api/functions/initShimAsyncCodec.html @@ -1,6 +1,6 @@ -initShimAsyncCodec | @zip.js/zip.js

Function initShimAsyncCodec

  • initShimAsyncCodec(library, constructorOptions, registerDataHandler): ZipLibrary

  • Transforms event-based third-party codec implementations into implementations compatible with zip.js

    +initShimAsyncCodec | @zip.js/zip.js

    Function initShimAsyncCodec

    • initShimAsyncCodec(
          library: EventBasedZipLibrary,
          constructorOptions: unknown,
          registerDataHandler: registerDataHandler,
      ): ZipLibrary

    • Transforms event-based third-party codec implementations into implementations compatible with zip.js

      Parameters

      • library: EventBasedZipLibrary

        The third-party codec implementations.

      • constructorOptions: unknown

        The options passed to the third-party implementations when building instances.

      • registerDataHandler: registerDataHandler

        The function called to handle the data events triggered by a third-party codec implementation.

      Returns ZipLibrary

      An instance containing classes compatible with ZipDeflate and ZipInflate.

      -

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/api/functions/terminateWorkers.html b/api/functions/terminateWorkers.html index 29841a6a..33e83ad5 100644 --- a/api/functions/terminateWorkers.html +++ b/api/functions/terminateWorkers.html @@ -1,2 +1,2 @@ -terminateWorkers | @zip.js/zip.js

Function terminateWorkers

  • terminateWorkers(): Promise<void>

  • Terminates all the web workers

    -

    Returns Promise<void>

Settings

Member Visibility
+terminateWorkers | @zip.js/zip.js

Function terminateWorkers

  • terminateWorkers(): Promise<void>

  • Terminates all the web workers

    +

    Returns Promise<void>

Settings

Member Visibility
diff --git a/api/hierarchy.html b/api/hierarchy.html index 5a5c0b4b..dd6b8daa 100644 --- a/api/hierarchy.html +++ b/api/hierarchy.html @@ -1 +1 @@ -@zip.js/zip.js

@zip.js/zip.js

Class Hierarchy

Settings

Member Visibility
+@zip.js/zip.js

@zip.js/zip.js

Hierarchy Summary

Settings

Member Visibility
diff --git a/api/index.html b/api/index.html index 9580ca46..f85b94bb 100644 --- a/api/index.html +++ b/api/index.html @@ -1,21 +1,21 @@ -@zip.js/zip.js

@zip.js/zip.js

Introduction

zip.js is a JavaScript open-source library (BSD-3-Clause license) for +@zip.js/zip.js

@zip.js/zip.js

Introduction

zip.js is a JavaScript open-source library (BSD-3-Clause license) for compressing and decompressing zip files. It has been designed to handle large amounts of data. It supports notably multi-core compression, native compression with compression streams, archives larger than 4GB with Zip64, split zip files and data encryption.

-

Demo

See https://gildas-lormeau.github.io/zip-manager

-

Documentation

See here for more info: https://gildas-lormeau.github.io/zip.js/

-

Examples

Hello world

import {
  BlobReader,
  BlobWriter,
  TextReader,
  TextWriter,
  ZipReader,
  ZipWriter,
} from "https://deno.land/x/zipjs/index.js";

// ----
// Write the zip file
// ----

// Creates a BlobWriter object where the zip content will be written.
const zipFileWriter = new BlobWriter();
// Creates a TextReader object storing the text of the entry to add in the zip
// (i.e. "Hello world!").
const helloWorldReader = new TextReader("Hello world!");

// Creates a ZipWriter object writing data via `zipFileWriter`, adds the entry
// "hello.txt" containing the text "Hello world!" via `helloWorldReader`, and
// closes the writer.
const zipWriter = new ZipWriter(zipFileWriter);
await zipWriter.add("hello.txt", helloWorldReader);
await zipWriter.close();

// Retrieves the Blob object containing the zip content into `zipFileBlob`. It
// is also returned by zipWriter.close() for more convenience.
const zipFileBlob = await zipFileWriter.getData();

// ----
// Read the zip file
// ----

// Creates a BlobReader object used to read `zipFileBlob`.
const zipFileReader = new BlobReader(zipFileBlob);
// Creates a TextWriter object where the content of the first entry in the zip
// will be written.
const helloWorldWriter = new TextWriter();

// Creates a ZipReader object reading the zip content via `zipFileReader`,
// retrieves metadata (name, dates, etc.) of the first entry, retrieves its
// content via `helloWorldWriter`, and closes the reader.
const zipReader = new ZipReader(zipFileReader);
const firstEntry = (await zipReader.getEntries()).shift();
const helloWorldText = await firstEntry.getData(helloWorldWriter);
await zipReader.close();

// Displays "Hello world!".
console.log(helloWorldText);
+
Demo
See https://gildas-lormeau.github.io/zip-manager

+
Documentation
See here for more info: https://gildas-lormeau.github.io/zip.js/

+
Examples
Hello world
import {
  BlobReader,
  BlobWriter,
  TextReader,
  TextWriter,
  ZipReader,
  ZipWriter,
} from "https://deno.land/x/zipjs/index.js";

// ----
// Write the zip file
// ----

// Creates a BlobWriter object where the zip content will be written.
const zipFileWriter = new BlobWriter();
// Creates a TextReader object storing the text of the entry to add in the zip
// (i.e. "Hello world!").
const helloWorldReader = new TextReader("Hello world!");

// Creates a ZipWriter object writing data via `zipFileWriter`, adds the entry
// "hello.txt" containing the text "Hello world!" via `helloWorldReader`, and
// closes the writer.
const zipWriter = new ZipWriter(zipFileWriter);
await zipWriter.add("hello.txt", helloWorldReader);
await zipWriter.close();

// Retrieves the Blob object containing the zip content into `zipFileBlob`. It
// is also returned by zipWriter.close() for more convenience.
const zipFileBlob = await zipFileWriter.getData();

// ----
// Read the zip file
// ----

// Creates a BlobReader object used to read `zipFileBlob`.
const zipFileReader = new BlobReader(zipFileBlob);
// Creates a TextWriter object where the content of the first entry in the zip
// will be written.
const helloWorldWriter = new TextWriter();

// Creates a ZipReader object reading the zip content via `zipFileReader`,
// retrieves metadata (name, dates, etc.) of the first entry, retrieves its
// content via `helloWorldWriter`, and closes the reader.
const zipReader = new ZipReader(zipFileReader);
const firstEntry = (await zipReader.getEntries()).shift();
const helloWorldText = await firstEntry.getData(helloWorldWriter);
await zipReader.close();

// Displays "Hello world!".
console.log(helloWorldText);
 

 
 
Run the code on JSFiddle: https://jsfiddle.net/dns7pkxt/

-
Hello world with Streams
import {
  BlobReader,
  ZipReader,
  ZipWriter,
} from "https://deno.land/x/zipjs/index.js";

// ----
// Write the zip file
// ----

// Creates a TransformStream object, the zip content will be written in the
// `writable` property.
const zipFileStream = new TransformStream();
// Creates a Promise object resolved to the zip content returned as a Blob
// object retrieved from `zipFileStream.readable`.
const zipFileBlobPromise = new Response(zipFileStream.readable).blob();
// Creates a ReadableStream object storing the text of the entry to add in the
// zip (i.e. "Hello world!").
const helloWorldReadable = new Blob(["Hello world!"]).stream();

// Creates a ZipWriter object writing data into `zipFileStream.writable`, adds
// the entry "hello.txt" containing the text "Hello world!" retrieved from
// `helloWorldReadable`, and closes the writer.
const zipWriter = new ZipWriter(zipFileStream.writable);
await zipWriter.add("hello.txt", helloWorldReadable);
await zipWriter.close();

// Retrieves the Blob object containing the zip content into `zipFileBlob`.
const zipFileBlob = await zipFileBlobPromise;

// ----
// Read the zip file
// ----

// Creates a BlobReader object used to read `zipFileBlob`.
const zipFileReader = new BlobReader(zipFileBlob);
// Creates a TransformStream object, the content of the first entry in the zip
// will be written in the `writable` property.
const helloWorldStream = new TransformStream();
// Creates a Promise object resolved to the content of the first entry returned
// as text from `helloWorldStream.readable`.
const helloWorldTextPromise = new Response(helloWorldStream.readable).text();

// Creates a ZipReader object reading the zip content via `zipFileReader`,
// retrieves metadata (name, dates, etc.) of the first entry, retrieves its
// content into `helloWorldStream.writable`, and closes the reader.
const zipReader = new ZipReader(zipFileReader);
const firstEntry = (await zipReader.getEntries()).shift();
await firstEntry.getData(helloWorldStream.writable);
await zipReader.close();

// Displays "Hello world!".
const helloWorldText = await helloWorldTextPromise;
console.log(helloWorldText);
+
Hello world with Streams
import {
  BlobReader,
  ZipReader,
  ZipWriter,
} from "https://deno.land/x/zipjs/index.js";

// ----
// Write the zip file
// ----

// Creates a TransformStream object, the zip content will be written in the
// `writable` property.
const zipFileStream = new TransformStream();
// Creates a Promise object resolved to the zip content returned as a Blob
// object retrieved from `zipFileStream.readable`.
const zipFileBlobPromise = new Response(zipFileStream.readable).blob();
// Creates a ReadableStream object storing the text of the entry to add in the
// zip (i.e. "Hello world!").
const helloWorldReadable = new Blob(["Hello world!"]).stream();

// Creates a ZipWriter object writing data into `zipFileStream.writable`, adds
// the entry "hello.txt" containing the text "Hello world!" retrieved from
// `helloWorldReadable`, and closes the writer.
const zipWriter = new ZipWriter(zipFileStream.writable);
await zipWriter.add("hello.txt", helloWorldReadable);
await zipWriter.close();

// Retrieves the Blob object containing the zip content into `zipFileBlob`.
const zipFileBlob = await zipFileBlobPromise;

// ----
// Read the zip file
// ----

// Creates a BlobReader object used to read `zipFileBlob`.
const zipFileReader = new BlobReader(zipFileBlob);
// Creates a TransformStream object, the content of the first entry in the zip
// will be written in the `writable` property.
const helloWorldStream = new TransformStream();
// Creates a Promise object resolved to the content of the first entry returned
// as text from `helloWorldStream.readable`.
const helloWorldTextPromise = new Response(helloWorldStream.readable).text();

// Creates a ZipReader object reading the zip content via `zipFileReader`,
// retrieves metadata (name, dates, etc.) of the first entry, retrieves its
// content into `helloWorldStream.writable`, and closes the reader.
const zipReader = new ZipReader(zipFileReader);
const firstEntry = (await zipReader.getEntries()).shift();
await firstEntry.getData(helloWorldStream.writable);
await zipReader.close();

// Displays "Hello world!".
const helloWorldText = await helloWorldTextPromise;
console.log(helloWorldText);
 

 
 
Run the code on JSFiddle: https://jsfiddle.net/exnyq1ft/

-
Adding concurrently multiple entries in a zip file
import {
  BlobWriter,
  HttpReader,
  TextReader,
  ZipWriter,
} from "https://unpkg.com/@zip.js/zip.js/index.js";

const README_URL = "https://unpkg.com/@zip.js/zip.js/README.md";
getZipFileBlob()
  .then(downloadFile);

async function getZipFileBlob() {
  const zipWriter = new ZipWriter(new BlobWriter("application/zip"));
  await Promise.all([
    zipWriter.add("hello.txt", new TextReader("Hello world!")),
    zipWriter.add("README.md", new HttpReader(README_URL)),
  ]);
  return zipWriter.close();
}

function downloadFile(blob) {
  document.body.appendChild(Object.assign(document.createElement("a"), {
    download: "hello.zip",
    href: URL.createObjectURL(blob),
    textContent: "Download zip file",
  }));
}
+
Adding concurrently multiple entries in a zip file
import {
  BlobWriter,
  HttpReader,
  TextReader,
  ZipWriter,
} from "https://unpkg.com/@zip.js/zip.js/index.js";

const README_URL = "https://unpkg.com/@zip.js/zip.js/README.md";
getZipFileBlob()
  .then(downloadFile);

async function getZipFileBlob() {
  const zipWriter = new ZipWriter(new BlobWriter("application/zip"));
  await Promise.all([
    zipWriter.add("hello.txt", new TextReader("Hello world!")),
    zipWriter.add("README.md", new HttpReader(README_URL)),
  ]);
  return zipWriter.close();
}

function downloadFile(blob) {
  document.body.appendChild(Object.assign(document.createElement("a"), {
    download: "hello.zip",
    href: URL.createObjectURL(blob),
    textContent: "Download zip file",
  }));
}
 

 
 
Run the code on Plunker: https://plnkr.co/edit/4sVljNIpqSUE9HCA?preview

-
Tests
See https://github.com/gildas-lormeau/zip.js/tree/master/tests/all

-

Settings

Member Visibility

On This Page

IntroductionDemoDocumentationExamples
+

Tests

See https://github.com/gildas-lormeau/zip.js/tree/master/tests/all

+

Settings

Member Visibility

On This Page

IntroductionDemoDocumentationExamples
diff --git a/api/interfaces/Configuration.html b/api/interfaces/Configuration.html index e92b0930..c5c3d742 100644 --- a/api/interfaces/Configuration.html +++ b/api/interfaces/Configuration.html @@ -1,41 +1,41 @@ -Configuration | @zip.js/zip.js

Interface Configuration

Represents the configuration passed to configure.

-
interface Configuration {
    chunkSize?: number;
    CompressionStream?: typeof TransformStreamLike;
    DecompressionStream?: typeof TransformStreamLike;
    Deflate?: typeof ZipDeflate;
    Inflate?: typeof ZipInflate;
    maxWorkers?: number;
    terminateWorkerTimeout?: number;
    useCompressionStream?: boolean;
    useWebWorkers?: boolean;
    workerScripts?: {
        deflate?: string[];
        inflate?: string[];
    };
}

Hierarchy (view full)

Properties

chunkSize? -CompressionStream? -DecompressionStream? -Deflate? -Inflate? -maxWorkers? -terminateWorkerTimeout? -useCompressionStream? -useWebWorkers? -workerScripts? -

Properties

OptionalchunkSize

chunkSize?: number

The size of the chunks in bytes during data compression/decompression.

-

Default Value

524288
+Configuration | @zip.js/zip.js
Interface Configuration
Represents the configuration passed to configure.

+
interface Configuration {
    chunkSize?: number;
    CompressionStream?: typeof TransformStreamLike;
    DecompressionStream?: typeof TransformStreamLike;
    Deflate?: typeof ZipDeflate;
    Inflate?: typeof ZipInflate;
    maxWorkers?: number;
    terminateWorkerTimeout?: number;
    useCompressionStream?: boolean;
    useWebWorkers?: boolean;
    workerScripts?: { deflate?: string[]; inflate?: string[] };
}
Hierarchy (View Summary)
Properties
chunkSize?
+CompressionStream?
+DecompressionStream?
+Deflate?
+Inflate?
+maxWorkers?
+terminateWorkerTimeout?
+useCompressionStream?
+useWebWorkers?
+workerScripts?
+
 Properties
OptionalchunkSize
chunkSize?: number
The size of the chunks in bytes during data compression/decompression.

+
Default Value
524288
 

 
-
OptionalCompressionStream
CompressionStream?: typeof TransformStreamLike
The stream implementation used to compress data when useCompressionStream is set to false.

-
Default Value
CodecStream

-
OptionalDecompressionStream
DecompressionStream?: typeof TransformStreamLike
The stream implementation used to decompress data when useCompressionStream is set to false.

-
Default Value
CodecStream

-
OptionalDeflate
Deflate?: typeof ZipDeflate
The codec implementation used to compress data.

-
Default Value
ZipDeflate

-
OptionalInflate
Inflate?: typeof ZipInflate
The codec implementation used to decompress data.

-
Default Value
ZipInflate

-
OptionalmaxWorkers
maxWorkers?: number
The maximum number of web workers used to compress/decompress data simultaneously.

-
Default Value
navigator.hardwareConcurrency

-
OptionalterminateWorkerTimeout
terminateWorkerTimeout?: number
The delay in milliseconds before idle web workers are automatically terminated. You can call terminateWorkers() to terminate idle workers.

-
Default Value
5000
+
OptionalCompressionStream
CompressionStream?: typeof TransformStreamLike
The stream implementation used to compress data when useCompressionStream is set to false.

+
Default Value
CodecStream

+
OptionalDecompressionStream
DecompressionStream?: typeof TransformStreamLike
The stream implementation used to decompress data when useCompressionStream is set to false.

+
Default Value
CodecStream

+
OptionalDeflate
Deflate?: typeof ZipDeflate
The codec implementation used to compress data.

+
Default Value
ZipDeflate

+
OptionalInflate
Inflate?: typeof ZipInflate
The codec implementation used to decompress data.

+
Default Value
ZipInflate

+
OptionalmaxWorkers
maxWorkers?: number
The maximum number of web workers used to compress/decompress data simultaneously.

+
Default Value
navigator.hardwareConcurrency

+
OptionalterminateWorkerTimeout
terminateWorkerTimeout?: number
The delay in milliseconds before idle web workers are automatically terminated. You can call terminateWorkers() to terminate idle workers.

+
Default Value
5000
 

 
-
OptionaluseCompressionStream
useCompressionStream?: boolean
true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

-
Default Value
true
+
OptionaluseCompressionStream
useCompressionStream?: boolean
true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

+
Default Value
true
 

 
-
OptionaluseWebWorkers
useWebWorkers?: boolean
true to use web workers to compress/decompress data in non-blocking background processes.

-
Default Value
true
+
OptionaluseWebWorkers
useWebWorkers?: boolean
true to use web workers to compress/decompress data in non-blocking background processes.

+
Default Value
true
 

 
-
OptionalworkerScripts
workerScripts?: { 
    deflate?: string[]; 
    inflate?: string[]; 
}
The URIs of the compression/decompression scripts run in web workers.

+

OptionalworkerScripts

workerScripts?: { deflate?: string[]; inflate?: string[] }

The URIs of the compression/decompression scripts run in web workers.

It allows using alternative deflate implementations or specifying a URL to the worker script if the CSP of the page blocks scripts imported from a Blob URI. The properties deflate and inflate must specify arrays of URLs to import the deflate/inflate web workers, respectively. The first URL is relative to the base URI of the document. The other URLs are relative to the URL of the first script. Scripts in the array are executed in order. @@ -49,6 +49,6 @@ 

configure({
  workerScripts: {
    deflate: ["library_path/z-worker.js"],
    inflate: ["library_path/z-worker.js"]
  }
});
-

Type declaration

  • Optionaldeflate?: string[]

    The URIs of the scripts implementing used for compression.

    -
  • Optionalinflate?: string[]

    The URIs of the scripts implementing used for decompression.

    -

Settings

Member Visibility

On This Page

Properties
+

Type declaration

  • Optionaldeflate?: string[]

    The URIs of the scripts implementing used for compression.

    +
  • Optionalinflate?: string[]

    The URIs of the scripts implementing used for decompression.

    +

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/Entry.html b/api/interfaces/Entry.html index 6f9256b2..80f411cd 100644 --- a/api/interfaces/Entry.html +++ b/api/interfaces/Entry.html @@ -1,65 +1,65 @@ -Entry | @zip.js/zip.js

Interface Entry

Represents an entry with its data and metadata in a zip file (Core API).

-
interface Entry {
    comment: string;
    commentUTF8: boolean;
    compressedSize: number;
    compressionMethod: number;
    creationDate?: Date;
    directory: boolean;
    diskNumberStart: number;
    encrypted: boolean;
    externalFileAttribute: number;
    extraField?: Map<number, {
        data: Uint8Array;
        type: number;
    }>;
    filename: string;
    filenameUTF8: boolean;
    internalFileAttribute: number;
    lastAccessDate?: Date;
    lastModDate: Date;
    msDosCompatible: boolean;
    offset: number;
    rawComment: Uint8Array;
    rawCreationDate?: number | bigint;
    rawExtraField: Uint8Array;
    rawFilename: Uint8Array;
    rawLastAccessDate?: number | bigint;
    rawLastModDate: number | bigint;
    signature: number;
    uncompressedSize: number;
    version: number;
    versionMadeBy: number;
    zip64: boolean;
    zipCrypto: boolean;
    getData?<Type>(writer:
        | WritableStream<any>
        | WritableWriter
        | AsyncGenerator<WritableStream<any> | WritableWriter | Writer<unknown>, boolean, any>
        | Writer<Type>, options?: EntryGetDataCheckPasswordOptions): Promise<Type>;
}

Hierarchy (view full)

Properties

comment -commentUTF8 -compressedSize -compressionMethod -creationDate? +Entry | @zip.js/zip.js

Interface Entry

Represents an entry with its data and metadata in a zip file (Core API).

+
interface Entry {
    comment: string;
    commentUTF8: boolean;
    compressedSize: number;
    compressionMethod: number;
    creationDate?: Date;
    directory: boolean;
    diskNumberStart: number;
    encrypted: boolean;
    externalFileAttribute: number;
    extraField?: Map<
        number,
        { data: Uint8Array<ArrayBufferLike>; type: number },
    >;
    filename: string;
    filenameUTF8: boolean;
    internalFileAttribute: number;
    lastAccessDate?: Date;
    lastModDate: Date;
    msDosCompatible: boolean;
    offset: number;
    rawComment: Uint8Array<ArrayBufferLike>;
    rawCreationDate?: number | bigint;
    rawExtraField: Uint8Array<ArrayBufferLike>;
    rawFilename: Uint8Array<ArrayBufferLike>;
    rawLastAccessDate?: number | bigint;
    rawLastModDate: number | bigint;
    signature: number;
    uncompressedSize: number;
    version: number;
    versionMadeBy: number;
    zip64: boolean;
    zipCrypto: boolean;
    getData<Type>(
        writer:
            | WritableStream<any>
            | WritableWriter
            | AsyncGenerator<
                WritableStream<any>
                | WritableWriter
                | Writer<unknown>,
                boolean,
                any,
            >
            | Writer<Type>,
        options?: EntryGetDataCheckPasswordOptions,
    ): Promise<Type>;
}

Hierarchy (View Summary)

Properties

comment +commentUTF8 +compressedSize +compressionMethod +creationDate? directory -diskNumberStart +diskNumberStart encrypted -externalFileAttribute -extraField? +externalFileAttribute +extraField? filename -filenameUTF8 -internalFileAttribute -lastAccessDate? -lastModDate -msDosCompatible +filenameUTF8 +internalFileAttribute +lastAccessDate? +lastModDate +msDosCompatible offset -rawComment -rawCreationDate? -rawExtraField -rawFilename -rawLastAccessDate? -rawLastModDate +rawComment +rawCreationDate? +rawExtraField +rawFilename +rawLastAccessDate? +rawLastModDate signature -uncompressedSize +uncompressedSize version -versionMadeBy +versionMadeBy zip64 -zipCrypto -

Methods

getData? +zipCrypto +

Methods

getData?

Properties

comment

comment: string

The comment of the entry.

-

commentUTF8

commentUTF8: boolean

true if the comment is encoded in UTF-8.

-

compressedSize

compressedSize: number

The size of the compressed data in bytes.

-

compressionMethod

compressionMethod: number

The compression method.

-

OptionalcreationDate

creationDate?: Date

The creation date.

-

directory

directory: boolean

true if the entry is a directory.

-

diskNumberStart

diskNumberStart: number

The number of the disk where the entry data starts.

-

encrypted

encrypted: boolean

true if the content of the entry is encrypted.

-

externalFileAttribute

externalFileAttribute: number

The external file attribute (raw).

-

OptionalextraField

extraField?: Map<number, {
    data: Uint8Array;
    type: number;
}>

The extra field.

-

filename

filename: string

The filename of the entry.

-

filenameUTF8

filenameUTF8: boolean

true if the filename is encoded in UTF-8.

-

internalFileAttribute

internalFileAttribute: number

The internal file attribute (raw).

-

OptionallastAccessDate

lastAccessDate?: Date

The last access date.

-

lastModDate

lastModDate: Date

The last modification date.

-

msDosCompatible

msDosCompatible: boolean

true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.

-

offset

offset: number

The byte offset of the entry.

-

rawComment

rawComment: Uint8Array

The comment of the entry (raw).

-

OptionalrawCreationDate

rawCreationDate?: number | bigint

The creation date (raw).

-

rawExtraField

rawExtraField: Uint8Array

The extra field (raw).

-

rawFilename

rawFilename: Uint8Array

The filename of the entry (raw).

-

OptionalrawLastAccessDate

rawLastAccessDate?: number | bigint

The last access date (raw).

-

rawLastModDate

rawLastModDate: number | bigint

The last modification date (raw).

-

signature

signature: number

The signature (CRC32 checksum) of the content.

-

uncompressedSize

uncompressedSize: number

The size of the decompressed data in bytes.

-

version

version: number

The "Version" field.

-

versionMadeBy

versionMadeBy: number

The "Version made by" field.

-

zip64

zip64: boolean

true if the entry is using Zip64.

-

zipCrypto

zipCrypto: boolean

true if the content of the entry is encrypted with the ZipCrypto algorithm.

-

Methods

OptionalgetData

commentUTF8

commentUTF8: boolean

true if the comment is encoded in UTF-8.

+

compressedSize

compressedSize: number

The size of the compressed data in bytes.

+

compressionMethod

compressionMethod: number

The compression method.

+

OptionalcreationDate

creationDate?: Date

The creation date.

+

directory

directory: boolean

true if the entry is a directory.

+

diskNumberStart

diskNumberStart: number

The number of the disk where the entry data starts.

+

encrypted

encrypted: boolean

true if the content of the entry is encrypted.

+

externalFileAttribute

externalFileAttribute: number

The external file attribute (raw).

+

OptionalextraField

extraField?: Map<number, { data: Uint8Array<ArrayBufferLike>; type: number }>

The extra field.

+

filename

filename: string

The filename of the entry.

+

filenameUTF8

filenameUTF8: boolean

true if the filename is encoded in UTF-8.

+

internalFileAttribute

internalFileAttribute: number

The internal file attribute (raw).

+

OptionallastAccessDate

lastAccessDate?: Date

The last access date.

+

lastModDate

lastModDate: Date

The last modification date.

+

msDosCompatible

msDosCompatible: boolean

true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.

+

offset

offset: number

The byte offset of the entry.

+

rawComment

rawComment: Uint8Array<ArrayBufferLike>

The comment of the entry (raw).

+

OptionalrawCreationDate

rawCreationDate?: number | bigint

The creation date (raw).

+

rawExtraField

rawExtraField: Uint8Array<ArrayBufferLike>

The extra field (raw).

+

rawFilename

rawFilename: Uint8Array<ArrayBufferLike>

The filename of the entry (raw).

+

OptionalrawLastAccessDate

rawLastAccessDate?: number | bigint

The last access date (raw).

+

rawLastModDate

rawLastModDate: number | bigint

The last modification date (raw).

+

signature

signature: number

The signature (CRC32 checksum) of the content.

+

uncompressedSize

uncompressedSize: number

The size of the decompressed data in bytes.

+

version

version: number

The "Version" field.

+

versionMadeBy

versionMadeBy: number

The "Version made by" field.

+

zip64

zip64: boolean

true if the entry is using Zip64.

+

zipCrypto

zipCrypto: boolean

true if the content of the entry is encrypted with the ZipCrypto algorithm.

+

Methods

OptionalgetData

  • getData<Type>(
        writer:
            | WritableStream<any>
            | WritableWriter
            | AsyncGenerator<
                WritableStream<any>
                | WritableWriter
                | Writer<unknown>,
                boolean,
                any,
            >
            | Writer<Type>,
        options?: EntryGetDataCheckPasswordOptions,
    ): Promise<Type>

  • Returns the content of the entry

    +

    Type Parameters

    • Type

    Parameters

    Returns Promise<Type>

    A promise resolving to the type to data associated to writer.

    -

Settings

Member Visibility

On This Page

Properties
Methods
+

Returns Promise<Type>

A promise resolving to the type to data associated to writer.

+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/api/interfaces/EntryDataOnprogressOptions.html b/api/interfaces/EntryDataOnprogressOptions.html index f4cff215..d0e46f9f 100644 --- a/api/interfaces/EntryDataOnprogressOptions.html +++ b/api/interfaces/EntryDataOnprogressOptions.html @@ -1,15 +1,15 @@ -EntryDataOnprogressOptions | @zip.js/zip.js

Interface EntryDataOnprogressOptions

Represents options passed to Entry#getData, ZipWriter.add and {@link ZipDirectory}.export*.

-
interface EntryDataOnprogressOptions {
    onend?(computedSize: number): Promise<void>;
    onprogress?(progress: number, total: number): Promise<void>;
    onstart?(total: number): Promise<void>;
}

Hierarchy (view full)

Methods

onend? +EntryDataOnprogressOptions | @zip.js/zip.js

Interface EntryDataOnprogressOptions

Represents options passed to Entry#getData, ZipWriter.add and {@link ZipDirectory}.export*.

+
interface EntryDataOnprogressOptions {
    onend(computedSize: number): Promise<void>;
    onprogress(progress: number, total: number): Promise<void>;
    onstart(total: number): Promise<void>;
}

Hierarchy (View Summary)

Methods

onend? onprogress? onstart? -

Methods

Optionalonend

  • onend(computedSize): Promise<void>

  • The function called when ending compression/decompression.

    +

Methods

Optionalonend

  • onend(computedSize: number): Promise<void>

  • The function called when ending compression/decompression.

    Parameters

    • computedSize: number

      The total number of bytes (computed).

    Returns Promise<void>

    An empty promise or undefined.

    -

Optionalonprogress

  • onprogress(progress, total): Promise<void>

  • The function called during compression/decompression.

    +

Optionalonprogress

  • onprogress(progress: number, total: number): Promise<void>

  • The function called during compression/decompression.

    Parameters

    • progress: number

      The current progress in bytes.

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

    -

Optionalonstart

  • onstart(total): Promise<void>

  • The function called when starting compression/decompression.

    +

Optionalonstart

  • onstart(total: number): Promise<void>

  • The function called when starting compression/decompression.

    Parameters

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/api/interfaces/EntryGetDataCheckPasswordOptions.html b/api/interfaces/EntryGetDataCheckPasswordOptions.html index 21f165ea..f99cbcc4 100644 --- a/api/interfaces/EntryGetDataCheckPasswordOptions.html +++ b/api/interfaces/EntryGetDataCheckPasswordOptions.html @@ -1,53 +1,53 @@ -EntryGetDataCheckPasswordOptions | @zip.js/zip.js

Interface EntryGetDataCheckPasswordOptions

Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.

-
interface EntryGetDataCheckPasswordOptions {
    checkPasswordOnly?: boolean;
    checkSignature?: boolean;
    passThrough?: boolean;
    password?: string;
    preventClose?: boolean;
    rawPassword?: Uint8Array;
    signal?: AbortSignal;
    transferStreams?: boolean;
    useCompressionStream?: boolean;
    useWebWorkers?: boolean;
    onend?(computedSize: number): Promise<void>;
    onprogress?(progress: number, total: number): Promise<void>;
    onstart?(total: number): Promise<void>;
}

Hierarchy (view full)

Properties

checkPasswordOnly? -checkSignature? -passThrough? +EntryGetDataCheckPasswordOptions | @zip.js/zip.js

Interface EntryGetDataCheckPasswordOptions

Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.

+
interface EntryGetDataCheckPasswordOptions {
    checkPasswordOnly?: boolean;
    checkSignature?: boolean;
    passThrough?: boolean;
    password?: string;
    preventClose?: boolean;
    rawPassword?: Uint8Array<ArrayBufferLike>;
    signal?: AbortSignal;
    transferStreams?: boolean;
    useCompressionStream?: boolean;
    useWebWorkers?: boolean;
    onend(computedSize: number): Promise<void>;
    onprogress(progress: number, total: number): Promise<void>;
    onstart(total: number): Promise<void>;
}

Hierarchy (View Summary)

Properties

checkPasswordOnly? +checkSignature? +passThrough? password? -preventClose? -rawPassword? +preventClose? +rawPassword? signal? -transferStreams? -useCompressionStream? -useWebWorkers? +transferStreams? +useCompressionStream? +useWebWorkers?

Methods

onend? onprogress? onstart? -

Properties

OptionalcheckPasswordOnly

checkPasswordOnly?: boolean

true to check only if the password is valid.

-

Default Value

false
+

Properties

OptionalcheckPasswordOnly

checkPasswordOnly?: boolean

true to check only if the password is valid.

+

Default Value

false
-

OptionalcheckSignature

checkSignature?: boolean

true to check the signature of the entry.

-

Default Value

false
+

OptionalcheckSignature

checkSignature?: boolean

true to check the signature of the entry.

+

Default Value

false
-

OptionalpassThrough

passThrough?: boolean

true to read the data as-is without decompressing it and without decrypting it.

-

Optionalpassword

password?: string

The password used to decrypt the content of the entry.

-

OptionalpreventClose

preventClose?: boolean

true to prevent closing of Writer#writable when calling Entry#getData.

-

Default Value

false
+

OptionalpassThrough

passThrough?: boolean

true to read the data as-is without decompressing it and without decrypting it.

+

Optionalpassword

password?: string

The password used to decrypt the content of the entry.

+

OptionalpreventClose

preventClose?: boolean

true to prevent closing of Writer#writable when calling Entry#getData.

+

Default Value

false
-

OptionalrawPassword

rawPassword?: Uint8Array

The password used to encrypt the content of the entry (raw).

-

Optionalsignal

signal?: AbortSignal

The AbortSignal instance used to cancel the decompression.

-

OptionaltransferStreams

transferStreams?: boolean

true to transfer streams to web workers when decompressing data.

-

Default Value

true
+

OptionalrawPassword

rawPassword?: Uint8Array<ArrayBufferLike>

The password used to encrypt the content of the entry (raw).

+

Optionalsignal

signal?: AbortSignal

The AbortSignal instance used to cancel the decompression.

+

OptionaltransferStreams

transferStreams?: boolean

true to transfer streams to web workers when decompressing data.

+

Default Value

true
-

OptionaluseCompressionStream

useCompressionStream?: boolean

true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

-

Default Value

true
+

OptionaluseCompressionStream

useCompressionStream?: boolean

true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

+

Default Value

true
-

OptionaluseWebWorkers

useWebWorkers?: boolean

true to use web workers to compress/decompress data in non-blocking background processes.

-

Default Value

true
+

OptionaluseWebWorkers

useWebWorkers?: boolean

true to use web workers to compress/decompress data in non-blocking background processes.

+

Default Value

true
-

Methods

Optionalonend

  • onend(computedSize): Promise<void>

  • The function called when ending compression/decompression.

    +

Methods

Optionalonend

  • onend(computedSize: number): Promise<void>

  • The function called when ending compression/decompression.

    Parameters

    • computedSize: number

      The total number of bytes (computed).

    Returns Promise<void>

    An empty promise or undefined.

    -

Optionalonprogress

Optionalonprogress

  • onprogress(progress: number, total: number): Promise<void>

  • The function called during compression/decompression.

    Parameters

    • progress: number

      The current progress in bytes.

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

    -

Optionalonstart

Optionalonstart

  • onstart(total: number): Promise<void>

  • The function called when starting compression/decompression.

    Parameters

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

    -

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/api/interfaces/EntryGetDataOptions.html b/api/interfaces/EntryGetDataOptions.html index 8476bf8d..61429b8d 100644 --- a/api/interfaces/EntryGetDataOptions.html +++ b/api/interfaces/EntryGetDataOptions.html @@ -1,53 +1,53 @@ -EntryGetDataOptions | @zip.js/zip.js

Interface EntryGetDataOptions

Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.

-
interface EntryGetDataOptions {
    checkPasswordOnly?: boolean;
    checkSignature?: boolean;
    passThrough?: boolean;
    password?: string;
    preventClose?: boolean;
    rawPassword?: Uint8Array;
    signal?: AbortSignal;
    transferStreams?: boolean;
    useCompressionStream?: boolean;
    useWebWorkers?: boolean;
    onend?(computedSize: number): Promise<void>;
    onprogress?(progress: number, total: number): Promise<void>;
    onstart?(total: number): Promise<void>;
}

Hierarchy (view full)

Properties

checkPasswordOnly? -checkSignature? -passThrough? +EntryGetDataOptions | @zip.js/zip.js

Interface EntryGetDataOptions

Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.

+
interface EntryGetDataOptions {
    checkPasswordOnly?: boolean;
    checkSignature?: boolean;
    passThrough?: boolean;
    password?: string;
    preventClose?: boolean;
    rawPassword?: Uint8Array<ArrayBufferLike>;
    signal?: AbortSignal;
    transferStreams?: boolean;
    useCompressionStream?: boolean;
    useWebWorkers?: boolean;
    onend(computedSize: number): Promise<void>;
    onprogress(progress: number, total: number): Promise<void>;
    onstart(total: number): Promise<void>;
}

Hierarchy (View Summary)

Properties

checkPasswordOnly? +checkSignature? +passThrough? password? -preventClose? -rawPassword? +preventClose? +rawPassword? signal? -transferStreams? -useCompressionStream? -useWebWorkers? +transferStreams? +useCompressionStream? +useWebWorkers?

Methods

onend? onprogress? onstart? -

Properties

OptionalcheckPasswordOnly

checkPasswordOnly?: boolean

true to check only if the password is valid.

-

Default Value

false
+

Properties

OptionalcheckPasswordOnly

checkPasswordOnly?: boolean

true to check only if the password is valid.

+

Default Value

false
-

OptionalcheckSignature

checkSignature?: boolean

true to check the signature of the entry.

-

Default Value

false
+

OptionalcheckSignature

checkSignature?: boolean

true to check the signature of the entry.

+

Default Value

false
-

OptionalpassThrough

passThrough?: boolean

true to read the data as-is without decompressing it and without decrypting it.

-

Optionalpassword

password?: string

The password used to decrypt the content of the entry.

-

OptionalpreventClose

preventClose?: boolean

true to prevent closing of Writer#writable when calling Entry#getData.

-

Default Value

false
+

OptionalpassThrough

passThrough?: boolean

true to read the data as-is without decompressing it and without decrypting it.

+

Optionalpassword

password?: string

The password used to decrypt the content of the entry.

+

OptionalpreventClose

preventClose?: boolean

true to prevent closing of Writer#writable when calling Entry#getData.

+

Default Value

false
-

OptionalrawPassword

rawPassword?: Uint8Array

The password used to encrypt the content of the entry (raw).

-

Optionalsignal

signal?: AbortSignal

The AbortSignal instance used to cancel the decompression.

-

OptionaltransferStreams

transferStreams?: boolean

true to transfer streams to web workers when decompressing data.

-

Default Value

true
+

OptionalrawPassword

rawPassword?: Uint8Array<ArrayBufferLike>

The password used to encrypt the content of the entry (raw).

+

Optionalsignal

signal?: AbortSignal

The AbortSignal instance used to cancel the decompression.

+

OptionaltransferStreams

transferStreams?: boolean

true to transfer streams to web workers when decompressing data.

+

Default Value

true
-

OptionaluseCompressionStream

useCompressionStream?: boolean

true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

-

Default Value

true
+

OptionaluseCompressionStream

useCompressionStream?: boolean

true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

+

Default Value

true
-

OptionaluseWebWorkers

useWebWorkers?: boolean

true to use web workers to compress/decompress data in non-blocking background processes.

-

Default Value

true
+

OptionaluseWebWorkers

useWebWorkers?: boolean

true to use web workers to compress/decompress data in non-blocking background processes.

+

Default Value

true
-

Methods

Optionalonend

  • onend(computedSize): Promise<void>

  • The function called when ending compression/decompression.

    +

Methods

Optionalonend

  • onend(computedSize: number): Promise<void>

  • The function called when ending compression/decompression.

    Parameters

    • computedSize: number

      The total number of bytes (computed).

    Returns Promise<void>

    An empty promise or undefined.

    -

Optionalonprogress

Optionalonprogress

  • onprogress(progress: number, total: number): Promise<void>

  • The function called during compression/decompression.

    Parameters

    • progress: number

      The current progress in bytes.

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

    -

Optionalonstart

Optionalonstart

  • onstart(total: number): Promise<void>

  • The function called when starting compression/decompression.

    Parameters

    • total: number

      The total number of bytes.

    Returns Promise<void>

    An empty promise or undefined.

    -

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/api/interfaces/EntryMetaData.html b/api/interfaces/EntryMetaData.html index 02739e61..e2100791 100644 --- a/api/interfaces/EntryMetaData.html +++ b/api/interfaces/EntryMetaData.html @@ -1,60 +1,60 @@ -EntryMetaData | @zip.js/zip.js

Interface EntryMetaData

Represents the metadata of an entry in a zip file (Core API).

-
interface EntryMetaData {
    comment: string;
    commentUTF8: boolean;
    compressedSize: number;
    compressionMethod: number;
    creationDate?: Date;
    directory: boolean;
    diskNumberStart: number;
    encrypted: boolean;
    externalFileAttribute: number;
    extraField?: Map<number, {
        data: Uint8Array;
        type: number;
    }>;
    filename: string;
    filenameUTF8: boolean;
    internalFileAttribute: number;
    lastAccessDate?: Date;
    lastModDate: Date;
    msDosCompatible: boolean;
    offset: number;
    rawComment: Uint8Array;
    rawCreationDate?: number | bigint;
    rawExtraField: Uint8Array;
    rawFilename: Uint8Array;
    rawLastAccessDate?: number | bigint;
    rawLastModDate: number | bigint;
    signature: number;
    uncompressedSize: number;
    version: number;
    versionMadeBy: number;
    zip64: boolean;
    zipCrypto: boolean;
}

Hierarchy (view full)

Properties

comment -commentUTF8 -compressedSize -compressionMethod -creationDate? +EntryMetaData | @zip.js/zip.js

Interface EntryMetaData

Represents the metadata of an entry in a zip file (Core API).

+
interface EntryMetaData {
    comment: string;
    commentUTF8: boolean;
    compressedSize: number;
    compressionMethod: number;
    creationDate?: Date;
    directory: boolean;
    diskNumberStart: number;
    encrypted: boolean;
    externalFileAttribute: number;
    extraField?: Map<
        number,
        { data: Uint8Array<ArrayBufferLike>; type: number },
    >;
    filename: string;
    filenameUTF8: boolean;
    internalFileAttribute: number;
    lastAccessDate?: Date;
    lastModDate: Date;
    msDosCompatible: boolean;
    offset: number;
    rawComment: Uint8Array<ArrayBufferLike>;
    rawCreationDate?: number | bigint;
    rawExtraField: Uint8Array<ArrayBufferLike>;
    rawFilename: Uint8Array<ArrayBufferLike>;
    rawLastAccessDate?: number | bigint;
    rawLastModDate: number | bigint;
    signature: number;
    uncompressedSize: number;
    version: number;
    versionMadeBy: number;
    zip64: boolean;
    zipCrypto: boolean;
}

Hierarchy (View Summary)

Properties

comment +commentUTF8 +compressedSize +compressionMethod +creationDate? directory -diskNumberStart +diskNumberStart encrypted -externalFileAttribute -extraField? +externalFileAttribute +extraField? filename -filenameUTF8 -internalFileAttribute -lastAccessDate? -lastModDate -msDosCompatible +filenameUTF8 +internalFileAttribute +lastAccessDate? +lastModDate +msDosCompatible offset -rawComment -rawCreationDate? -rawExtraField -rawFilename -rawLastAccessDate? -rawLastModDate +rawComment +rawCreationDate? +rawExtraField +rawFilename +rawLastAccessDate? +rawLastModDate signature -uncompressedSize +uncompressedSize version -versionMadeBy +versionMadeBy zip64 -zipCrypto +zipCrypto

Properties

comment

comment: string

The comment of the entry.

-

commentUTF8

commentUTF8: boolean

true if the comment is encoded in UTF-8.

-

compressedSize

compressedSize: number

The size of the compressed data in bytes.

-

compressionMethod

compressionMethod: number

The compression method.

-

OptionalcreationDate

creationDate?: Date

The creation date.

-

directory

directory: boolean

true if the entry is a directory.

-

diskNumberStart

diskNumberStart: number

The number of the disk where the entry data starts.

-

encrypted

encrypted: boolean

true if the content of the entry is encrypted.

-

externalFileAttribute

externalFileAttribute: number

The external file attribute (raw).

-

OptionalextraField

extraField?: Map<number, {
    data: Uint8Array;
    type: number;
}>

The extra field.

-

filename

filename: string

The filename of the entry.

-

filenameUTF8

filenameUTF8: boolean

true if the filename is encoded in UTF-8.

-

internalFileAttribute

internalFileAttribute: number

The internal file attribute (raw).

-

OptionallastAccessDate

lastAccessDate?: Date

The last access date.

-

lastModDate

lastModDate: Date

The last modification date.

-

msDosCompatible

msDosCompatible: boolean

true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.

-

offset

offset: number

The byte offset of the entry.

-

rawComment

rawComment: Uint8Array

The comment of the entry (raw).

-

OptionalrawCreationDate

rawCreationDate?: number | bigint

The creation date (raw).

-

rawExtraField

rawExtraField: Uint8Array

The extra field (raw).

-

rawFilename

rawFilename: Uint8Array

The filename of the entry (raw).

-

OptionalrawLastAccessDate

rawLastAccessDate?: number | bigint

The last access date (raw).

-

rawLastModDate

rawLastModDate: number | bigint

The last modification date (raw).

-

signature

signature: number

The signature (CRC32 checksum) of the content.

-

uncompressedSize

uncompressedSize: number

The size of the decompressed data in bytes.

-

version

version: number

The "Version" field.

-

versionMadeBy

versionMadeBy: number

The "Version made by" field.

-

zip64

zip64: boolean

true if the entry is using Zip64.

-

zipCrypto

zipCrypto: boolean

true if the content of the entry is encrypted with the ZipCrypto algorithm.

-

Settings

Member Visibility

On This Page

Properties
+

commentUTF8

commentUTF8: boolean

true if the comment is encoded in UTF-8.

+

compressedSize

compressedSize: number

The size of the compressed data in bytes.

+

compressionMethod

compressionMethod: number

The compression method.

+

OptionalcreationDate

creationDate?: Date

The creation date.

+

directory

directory: boolean

true if the entry is a directory.

+

diskNumberStart

diskNumberStart: number

The number of the disk where the entry data starts.

+

encrypted

encrypted: boolean

true if the content of the entry is encrypted.

+

externalFileAttribute

externalFileAttribute: number

The external file attribute (raw).

+

OptionalextraField

extraField?: Map<number, { data: Uint8Array<ArrayBufferLike>; type: number }>

The extra field.

+

filename

filename: string

The filename of the entry.

+

filenameUTF8

filenameUTF8: boolean

true if the filename is encoded in UTF-8.

+

internalFileAttribute

internalFileAttribute: number

The internal file attribute (raw).

+

OptionallastAccessDate

lastAccessDate?: Date

The last access date.

+

lastModDate

lastModDate: Date

The last modification date.

+

msDosCompatible

msDosCompatible: boolean

true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.

+

offset

offset: number

The byte offset of the entry.

+

rawComment

rawComment: Uint8Array<ArrayBufferLike>

The comment of the entry (raw).

+

OptionalrawCreationDate

rawCreationDate?: number | bigint

The creation date (raw).

+

rawExtraField

rawExtraField: Uint8Array<ArrayBufferLike>

The extra field (raw).

+

rawFilename

rawFilename: Uint8Array<ArrayBufferLike>

The filename of the entry (raw).

+

OptionalrawLastAccessDate

rawLastAccessDate?: number | bigint

The last access date (raw).

+

rawLastModDate

rawLastModDate: number | bigint

The last modification date (raw).

+

signature

signature: number

The signature (CRC32 checksum) of the content.

+

uncompressedSize

uncompressedSize: number

The size of the decompressed data in bytes.

+

version

version: number

The "Version" field.

+

versionMadeBy

versionMadeBy: number

The "Version made by" field.

+

zip64

zip64: boolean

true if the entry is using Zip64.

+

zipCrypto

zipCrypto: boolean

true if the content of the entry is encrypted with the ZipCrypto algorithm.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/EntryOnprogressOptions.html b/api/interfaces/EntryOnprogressOptions.html index 85c79498..377b535c 100644 --- a/api/interfaces/EntryOnprogressOptions.html +++ b/api/interfaces/EntryOnprogressOptions.html @@ -1,8 +1,8 @@ -EntryOnprogressOptions | @zip.js/zip.js

Interface EntryOnprogressOptions

Represents options passed to ZipReader#getEntries, ZipReader#getEntriesGenerator, and ZipWriter#close.

-
interface EntryOnprogressOptions {
    onprogress?(progress: number, total: number, entry: EntryMetaData): Promise<void>;
}

Hierarchy (view full)

Methods

onprogress? -

Methods

Optionalonprogress

Settings

Member Visibility

On This Page

Methods
diff --git a/api/interfaces/EventBasedZipLibrary.html b/api/interfaces/EventBasedZipLibrary.html index ea4327c5..40148181 100644 --- a/api/interfaces/EventBasedZipLibrary.html +++ b/api/interfaces/EventBasedZipLibrary.html @@ -1,6 +1,6 @@ -EventBasedZipLibrary | @zip.js/zip.js

Interface EventBasedZipLibrary

Represents event-based implementations used to compress/decompress data.

-
interface EventBasedZipLibrary {
    Deflate: typeof EventBasedCodec;
    Inflate: typeof EventBasedCodec;
}

Properties

Deflate -Inflate -

Properties

Deflate

Deflate: typeof EventBasedCodec

The class used to compress data.

-

Inflate

Inflate: typeof EventBasedCodec

The class used to decompress data.

-

Settings

Member Visibility

On This Page

Properties
+EventBasedZipLibrary | @zip.js/zip.js

Interface EventBasedZipLibrary

Represents event-based implementations used to compress/decompress data.

+
interface EventBasedZipLibrary {
    Deflate: typeof EventBasedCodec;
    Inflate: typeof EventBasedCodec;
}

Properties

Deflate +Inflate +

Properties

Deflate

Deflate: typeof EventBasedCodec

The class used to compress data.

+

Inflate

Inflate: typeof EventBasedCodec

The class used to decompress data.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/FileSystemEntryLike.html b/api/interfaces/FileSystemEntryLike.html index 8782bd00..99c8703a 100644 --- a/api/interfaces/FileSystemEntryLike.html +++ b/api/interfaces/FileSystemEntryLike.html @@ -1,3 +1,3 @@ -FileSystemEntryLike | @zip.js/zip.js

Interface FileSystemEntryLike

Represents the FileSystemEntry class.

-

See

https://wicg.github.io/entries-api/#api-entry|specification

-

Settings

Member Visibility
+FileSystemEntryLike | @zip.js/zip.js

Interface FileSystemEntryLike

Represents the FileSystemEntry class.

+

See

https://wicg.github.io/entries-api/#api-entry|specification

+

Settings

Member Visibility
diff --git a/api/interfaces/FileSystemHandleLike.html b/api/interfaces/FileSystemHandleLike.html index b0fc9522..643cbda7 100644 --- a/api/interfaces/FileSystemHandleLike.html +++ b/api/interfaces/FileSystemHandleLike.html @@ -1,3 +1,3 @@ -FileSystemHandleLike | @zip.js/zip.js

Interface FileSystemHandleLike

Represents the FileSystemHandle class.

-

See

https://fs.spec.whatwg.org/#api-filesystemhandle

-

Settings

Member Visibility
+FileSystemHandleLike | @zip.js/zip.js

Interface FileSystemHandleLike

Represents the FileSystemHandle class.

+

See

https://fs.spec.whatwg.org/#api-filesystemhandle

+

Settings

Member Visibility
diff --git a/api/interfaces/GetEntriesOptions.html b/api/interfaces/GetEntriesOptions.html index 374a37d1..625997d2 100644 --- a/api/interfaces/GetEntriesOptions.html +++ b/api/interfaces/GetEntriesOptions.html @@ -1,11 +1,11 @@ -GetEntriesOptions | @zip.js/zip.js

Interface GetEntriesOptions

Represents options passed to the constructor of ZipReader, ZipReader#getEntries and ZipReader#getEntriesGenerator.

-
interface GetEntriesOptions {
    commentEncoding?: string;
    filenameEncoding?: string;
    decodeText?(value: Uint8Array, encoding: string): string;
}

Hierarchy (view full)

Properties

commentEncoding? -filenameEncoding? -

Methods

decodeText? -

Properties

OptionalcommentEncoding

commentEncoding?: string

The encoding of the comment of the entry.

-

OptionalfilenameEncoding

filenameEncoding?: string

The encoding of the filename of the entry.

-

Methods

OptionaldecodeText

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/api/interfaces/HttpOptions.html b/api/interfaces/HttpOptions.html index 2e01b63a..3540a441 100644 --- a/api/interfaces/HttpOptions.html +++ b/api/interfaces/HttpOptions.html @@ -1,30 +1,30 @@ -HttpOptions | @zip.js/zip.js

Interface HttpOptions

Represents the options passed to the constructor of HttpReader.

-
interface HttpOptions {
    combineSizeEocd?: boolean;
    forceRangeRequests?: boolean;
    headers?: Iterable<[string, string], any, any> | Map<string, string>;
    preventHeadRequest?: boolean;
    useRangeHeader?: boolean;
    useXHR?: boolean;
}

Hierarchy (view full)

Properties

combineSizeEocd? -forceRangeRequests? +HttpOptions | @zip.js/zip.js

Interface HttpOptions

Represents the options passed to the constructor of HttpReader.

+
interface HttpOptions {
    combineSizeEocd?: boolean;
    forceRangeRequests?: boolean;
    headers?: Iterable<[string, string], any, any> | Map<string, string>;
    preventHeadRequest?: boolean;
    useRangeHeader?: boolean;
    useXHR?: boolean;
}

Hierarchy (View Summary)

Properties

combineSizeEocd? +forceRangeRequests? headers? -preventHeadRequest? -useRangeHeader? -useXHR? -

Properties

OptionalcombineSizeEocd

combineSizeEocd?: boolean

true to use Range: bytes=-22 on the first request and cache the EOCD, make sure beforehand that the server supports a suffix range request.

-

Default Value

false
+preventHeadRequest?
+useRangeHeader?
+useXHR?
+

Properties

OptionalcombineSizeEocd

combineSizeEocd?: boolean

true to use Range: bytes=-22 on the first request and cache the EOCD, make sure beforehand that the server supports a suffix range request.

+

Default Value

false
-

OptionalforceRangeRequests

forceRangeRequests?: boolean

true to always use Range headers when fetching data.

-

Default Value

false
+

OptionalforceRangeRequests

forceRangeRequests?: boolean

true to always use Range headers when fetching data.

+

Default Value

false
-

Optionalheaders

headers?: Iterable<[string, string], any, any> | Map<string, string>

The HTTP headers.

-

OptionalpreventHeadRequest

preventHeadRequest?: boolean

true to prevent using HEAD HTTP request in order the get the size of the content. +

Optionalheaders

headers?: Iterable<[string, string], any, any> | Map<string, string>

The HTTP headers.

+

OptionalpreventHeadRequest

preventHeadRequest?: boolean

true to prevent using HEAD HTTP request in order the get the size of the content. false to explicitly use HEAD, this is useful in case of CORS where Access-Control-Expose-Headers: Content-Range is not returned by the server.

-

Default Value

false
+

Default Value

false
-

OptionaluseRangeHeader

useRangeHeader?: boolean

true to use Range headers when fetching data from servers returning Accept-Ranges headers.

-

Default Value

false
+

OptionaluseRangeHeader

useRangeHeader?: boolean

true to use Range headers when fetching data from servers returning Accept-Ranges headers.

+

Default Value

false
-

OptionaluseXHR

useXHR?: boolean

true to rely XMLHttpRequest instead of fetch to fetch data.

-

Default Value

false
+

OptionaluseXHR

useXHR?: boolean

true to rely XMLHttpRequest instead of fetch to fetch data.

+

Default Value

false
-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/HttpRangeOptions.html b/api/interfaces/HttpRangeOptions.html index 7277aa28..6d83029d 100644 --- a/api/interfaces/HttpRangeOptions.html +++ b/api/interfaces/HttpRangeOptions.html @@ -1,9 +1,9 @@ -HttpRangeOptions | @zip.js/zip.js

Interface HttpRangeOptions

Represents options passed to the constructor of HttpRangeReader and HttpReader.

-
interface HttpRangeOptions {
    headers?: Iterable<[string, string], any, any> | Map<string, string>;
    useXHR?: boolean;
}

Hierarchy (view full)

Properties

headers? -useXHR? -

Properties

Optionalheaders

headers?: Iterable<[string, string], any, any> | Map<string, string>

The HTTP headers.

-

OptionaluseXHR

useXHR?: boolean

true to rely XMLHttpRequest instead of fetch to fetch data.

-

Default Value

false
+HttpRangeOptions | @zip.js/zip.js
Interface HttpRangeOptions
Represents options passed to the constructor of HttpRangeReader and HttpReader.

+
interface HttpRangeOptions {
    headers?: Iterable<[string, string], any, any> | Map<string, string>;
    useXHR?: boolean;
}
Hierarchy (View Summary)
Properties
headers?
+useXHR?
+
 Properties
Optionalheaders
headers?: Iterable<[string, string], any, any> | Map<string, string>
The HTTP headers.

+
OptionaluseXHR
useXHR?: boolean
true to rely XMLHttpRequest instead of fetch to fetch data.

+
Default Value
false
 

 
-
Settings
Member Visibility
On This Page
Properties

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/Initializable.html b/api/interfaces/Initializable.html index b85a4b62..a1218ac1 100644 --- a/api/interfaces/Initializable.html +++ b/api/interfaces/Initializable.html @@ -1,6 +1,6 @@ -Initializable | @zip.js/zip.js

Interface Initializable

Represents an instance used to read or write unknown type of data.

+Initializable | @zip.js/zip.js

Interface Initializable

Represents an instance used to read or write unknown type of data.

zip.js can handle multiple types of data thanks to a generic API. This feature is based on 2 abstract constructors: Reader and Writer. The classes inheriting from Reader help to read data from a source of data. The classes inheriting from Writer help to write data into a destination.

-
interface Initializable {
    init?(): Promise<void>;
}

Implemented by

Methods

init? -

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods
+
interface Initializable {
    init(): Promise<void>;
}

Implemented by

Methods

init? +

Methods

Optionalinit

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods
diff --git a/api/interfaces/ReadableReader.html b/api/interfaces/ReadableReader.html index a86834a0..5bf021c6 100644 --- a/api/interfaces/ReadableReader.html +++ b/api/interfaces/ReadableReader.html @@ -1,4 +1,4 @@ -ReadableReader | @zip.js/zip.js

Interface ReadableReader

Represents an instance used to read data from a ReadableStream instance.

-
interface ReadableReader {
    readable: ReadableStream<any>;
}

Implemented by

Properties

readable +ReadableReader | @zip.js/zip.js

Interface ReadableReader

Represents an instance used to read data from a ReadableStream instance.

+
interface ReadableReader {
    readable: ReadableStream<any>;
}

Implemented by

Properties

readable

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/URLString.html b/api/interfaces/URLString.html index 2a91c39f..3340cdb8 100644 --- a/api/interfaces/URLString.html +++ b/api/interfaces/URLString.html @@ -1,180 +1,180 @@ -URLString | @zip.js/zip.js

Interface URLString

Represents a URL stored into a string.

-
interface URLString {
    length: number;
    [iterator](): StringIterator<string>;
    anchor(name: string): string;
    big(): string;
    blink(): string;
    bold(): string;
    charAt(pos: number): string;
    charCodeAt(index: number): number;
    codePointAt(pos: number): number;
    concat(...strings: string[]): string;
    endsWith(searchString: string, endPosition?: number): boolean;
    fixed(): string;
    fontcolor(color: string): string;
    fontsize(size: number): string;
    fontsize(size: string): string;
    includes(searchString: string, position?: number): boolean;
    indexOf(searchString: string, position?: number): number;
    italics(): string;
    lastIndexOf(searchString: string, position?: number): number;
    link(url: string): string;
    localeCompare(that: string): number;
    localeCompare(that: string, locales?: string | string[], options?: CollatorOptions): number;
    match(regexp: string | RegExp): RegExpMatchArray;
    match(matcher: {
        [match](string: string): RegExpMatchArray;
    }): RegExpMatchArray;
    normalize(form:
        | "NFC"
        | "NFD"
        | "NFKC"
        | "NFKD"): string;
    normalize(form?: string): string;
    padEnd(maxLength: number, fillString?: string): string;
    padStart(maxLength: number, fillString?: string): string;
    repeat(count: number): string;
    replace(searchValue: string | RegExp, replaceValue: string): string;
    replace(searchValue: string | RegExp, replacer: ((substring: string, ...args: any[]) => string)): string;
    replace(searchValue: {
        [replace](string: string, replaceValue: string): string;
    }, replaceValue: string): string;
    replace(searchValue: {
        [replace](string: string, replacer: ((substring: string, ...args: any[]) => string)): string;
    }, replacer: ((substring: string, ...args: any[]) => string)): string;
    search(regexp: string | RegExp): number;
    search(searcher: {
        [search](string: string): number;
    }): number;
    slice(start?: number, end?: number): string;
    small(): string;
    split(separator: string | RegExp, limit?: number): string[];
    split(splitter: {
        [split](string: string, limit?: number): string[];
    }, limit?: number): string[];
    startsWith(searchString: string, position?: number): boolean;
    strike(): string;
    sub(): string;
    substr(from: number, length?: number): string;
    substring(start: number, end?: number): string;
    sup(): string;
    toLocaleLowerCase(locales?: string | string[]): string;
    toLocaleUpperCase(locales?: string | string[]): string;
    toLowerCase(): string;
    toString(): string;
    toUpperCase(): string;
    trim(): string;
    valueOf(): string;
}

Hierarchy

  • String
    • URLString

Properties

length -

Methods

[iterator] +URLString | @zip.js/zip.js

Interface URLString

Represents a URL stored into a string.

+
interface URLString {
    length: number;
    "[iterator]"(): StringIterator<string>;
    anchor(name: string): string;
    big(): string;
    blink(): string;
    bold(): string;
    charAt(pos: number): string;
    charCodeAt(index: number): number;
    codePointAt(pos: number): number;
    concat(...strings: string[]): string;
    endsWith(searchString: string, endPosition?: number): boolean;
    fixed(): string;
    fontcolor(color: string): string;
    fontsize(size: number): string;
    fontsize(size: string): string;
    includes(searchString: string, position?: number): boolean;
    indexOf(searchString: string, position?: number): number;
    italics(): string;
    lastIndexOf(searchString: string, position?: number): number;
    link(url: string): string;
    localeCompare(that: string): number;
    localeCompare(
        that: string,
        locales?: string | string[],
        options?: CollatorOptions,
    ): number;
    match(regexp: string | RegExp): RegExpMatchArray;
    match(
        matcher: { "[match]"(string: string): RegExpMatchArray },
    ): RegExpMatchArray;
    normalize(form: "NFC" | "NFD" | "NFKC" | "NFKD"): string;
    normalize(form?: string): string;
    padEnd(maxLength: number, fillString?: string): string;
    padStart(maxLength: number, fillString?: string): string;
    repeat(count: number): string;
    replace(searchValue: string | RegExp, replaceValue: string): string;
    replace(
        searchValue: string | RegExp,
        replacer: (substring: string, ...args: any[]) => string,
    ): string;
    replace(
        searchValue: {
            "[replace]"(string: string, replaceValue: string): string;
        },
        replaceValue: string,
    ): string;
    replace(
        searchValue: {
            "[replace]"(
                string: string,
                replacer: (substring: string, ...args: any[]) => string,
            ): string;
        },
        replacer: (substring: string, ...args: any[]) => string,
    ): string;
    search(regexp: string | RegExp): number;
    search(searcher: { "[search]"(string: string): number }): number;
    slice(start?: number, end?: number): string;
    small(): string;
    split(separator: string | RegExp, limit?: number): string[];
    split(
        splitter: { "[split]"(string: string, limit?: number): string[] },
        limit?: number,
    ): string[];
    startsWith(searchString: string, position?: number): boolean;
    strike(): string;
    sub(): string;
    substr(from: number, length?: number): string;
    substring(start: number, end?: number): string;
    sup(): string;
    toLocaleLowerCase(locales?: string | string[]): string;
    toLocaleUpperCase(locales?: string | string[]): string;
    toLowerCase(): string;
    toString(): string;
    toUpperCase(): string;
    trim(): string;
    valueOf(): string;
    readonly [index: number]: string;
}

Hierarchy

  • String
    • URLString

Indexable

  • readonly [index: number]: string

Properties

length +

Methods

[iterator] anchor big blink bold -charAt -charCodeAt -codePointAt +charAt +charCodeAt +codePointAt concat -endsWith +endsWith fixed fontcolor fontsize includes -indexOf +indexOf italics -lastIndexOf +lastIndexOf link -localeCompare +localeCompare match normalize -padEnd -padStart +padEnd +padStart repeat replace search slice small split -startsWith +startsWith strike sub substr substring sup -toLocaleLowerCase -toLocaleUpperCase -toLowerCase -toString -toUpperCase +toLocaleLowerCase +toLocaleUpperCase +toLowerCase +toString +toUpperCase trim -valueOf +valueOf

Properties

Readonlylength

length: number

Returns the length of a String object.

-

Methods

[iterator]

  • [iterator](): StringIterator<string>

  • Iterator

    -

    Returns StringIterator<string>

anchor

  • anchor(name): string

  • Returns an <a> HTML anchor element and sets the name attribute to the text value

    -

    Parameters

    • name: string

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -

big

  • big(): string

  • Returns a <big> HTML element

    -

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -

blink

  • blink(): string

  • Returns a <blink> HTML element

    -

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -

bold

  • bold(): string

  • Returns a <b> HTML element

    -

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -

charAt

  • charAt(pos): string

  • Returns the character at the specified index.

    +

Methods

[iterator]

  • "[iterator]"(): StringIterator<string>

  • Iterator

    +

    Returns StringIterator<string>

anchor

  • anchor(name: string): string

  • Returns an <a> HTML anchor element and sets the name attribute to the text value

    +

    Parameters

    • name: string

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

big

  • big(): string

  • Returns a <big> HTML element

    +

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

blink

  • blink(): string

  • Returns a <blink> HTML element

    +

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

bold

  • bold(): string

  • Returns a <b> HTML element

    +

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

charAt

  • charAt(pos: number): string

  • Returns the character at the specified index.

    Parameters

    • pos: number

      The zero-based index of the desired character.

      -

    Returns string

charCodeAt

  • charCodeAt(index): number

  • Returns the Unicode value of the character at the specified location.

    +

Returns string

charCodeAt

  • charCodeAt(index: number): number

  • Returns the Unicode value of the character at the specified location.

    Parameters

    • index: number

      The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

      -

    Returns number

codePointAt

  • codePointAt(pos): number

  • Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point +

Returns number

codePointAt

  • codePointAt(pos: number): number

  • Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

    -

    Parameters

    • pos: number

    Returns number

concat

  • concat(...strings): string

  • Returns a string that contains the concatenation of two or more strings.

    -

    Parameters

    • Rest...strings: string[]

      The strings to append to the end of the string.

      -

    Returns string

endsWith

  • endsWith(searchString, endPosition?): boolean

  • Returns true if the sequence of elements of searchString converted to a String is the +

    Parameters

    • pos: number

    Returns number

concat

  • concat(...strings: string[]): string

  • Returns a string that contains the concatenation of two or more strings.

    +

    Parameters

    • ...strings: string[]

      The strings to append to the end of the string.

      +

    Returns string

endsWith

  • endsWith(searchString: string, endPosition?: number): boolean

  • Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.

    -

    Parameters

    • searchString: string
    • OptionalendPosition: number

    Returns boolean

fixed

  • fixed(): string

  • Returns a <tt> HTML element

    -

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -

fontcolor

  • fontcolor(color): string

  • Returns a <font> HTML element and sets the color attribute value

    -

    Parameters

    • color: string

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -

fontsize

  • fontsize(size): string

  • Returns a <font> HTML element and sets the size attribute value

    -

    Parameters

    • size: number

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -
  • fontsize(size): string

  • Returns a <font> HTML element and sets the size attribute value

    -

    Parameters

    • size: string

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -

includes

  • includes(searchString, position?): boolean

  • Returns true if searchString appears as a substring of the result of converting this +

    Parameters

    • searchString: string
    • OptionalendPosition: number

    Returns boolean

fixed

  • fixed(): string

  • Returns a <tt> HTML element

    +

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

fontcolor

  • fontcolor(color: string): string

  • Returns a <font> HTML element and sets the color attribute value

    +

    Parameters

    • color: string

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

fontsize

  • fontsize(size: number): string

  • Returns a <font> HTML element and sets the size attribute value

    +

    Parameters

    • size: number

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +
  • fontsize(size: string): string

  • Returns a <font> HTML element and sets the size attribute value

    +

    Parameters

    • size: string

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

includes

  • includes(searchString: string, position?: number): boolean

  • Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.

    Parameters

    • searchString: string

      search string

    • Optionalposition: number

      If position is undefined, 0 is assumed, so as to search all of the String.

      -

    Returns boolean

indexOf

  • indexOf(searchString, position?): number

  • Returns the position of the first occurrence of a substring.

    +

Returns boolean

indexOf

  • indexOf(searchString: string, position?: number): number

  • Returns the position of the first occurrence of a substring.

    Parameters

    • searchString: string

      The substring to search for in the string

    • Optionalposition: number

      The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.

      -

    Returns number

italics

  • italics(): string

  • Returns an <i> HTML element

    -

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -

lastIndexOf

  • lastIndexOf(searchString, position?): number

  • Returns the last occurrence of a substring in the string.

    +

Returns number

italics

  • italics(): string

  • Returns an <i> HTML element

    +

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

lastIndexOf

  • lastIndexOf(searchString: string, position?: number): number

  • Returns the last occurrence of a substring in the string.

    Parameters

    • searchString: string

      The substring to search for.

    • Optionalposition: number

      The index at which to begin searching. If omitted, the search begins at the end of the string.

      -

    Returns number

link

  • link(url): string

  • Returns an <a> HTML element and sets the href attribute value

    -

    Parameters

    • url: string

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    -

localeCompare

  • localeCompare(that): number

  • Determines whether two strings are equivalent in the current locale.

    +

Returns number

link

  • link(url: string): string

  • Returns an <a> HTML element and sets the href attribute value

    +

    Parameters

    • url: string

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

localeCompare

  • localeCompare(that: string): number

  • Determines whether two strings are equivalent in the current locale.

    Parameters

    • that: string

      String to compare to target string

      -

    Returns number

  • localeCompare(that, locales?, options?): number

  • Determines whether two strings are equivalent in the current or specified locale.

    +

Returns number

  • localeCompare(
        that: string,
        locales?: string | string[],
        options?: CollatorOptions,
    ): number

  • Determines whether two strings are equivalent in the current or specified locale.

    Parameters

    • that: string

      String to compare to target string

      -
    • Optionallocales: string | string[]

      A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.

      +
    • Optionallocales: string | string[]

      A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.

    • Optionaloptions: CollatorOptions

      An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

      -

    Returns number

    • match

    • match(regexp): RegExpMatchArray

    • Matches a string with a regular expression, and returns an array containing the results of that search.

      -

      Parameters

      • regexp: string | RegExp

        A variable name or string literal containing the regular expression pattern and flags.

        -

      Returns RegExpMatchArray

    • match(matcher): RegExpMatchArray

    • Matches a string or an object that supports being matched against, and returns an array +

    Returns number

    match

    • match(regexp: string | RegExp): RegExpMatchArray

    • Matches a string with a regular expression, and returns an array containing the results of that search.

      +

      Parameters

      • regexp: string | RegExp

        A variable name or string literal containing the regular expression pattern and flags.

        +

      Returns RegExpMatchArray

    • match(
          matcher: { "[match]"(string: string): RegExpMatchArray },
      ): RegExpMatchArray

    • Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found.

      -

      Parameters

      • matcher: {
            [match](string: string): RegExpMatchArray;
        }

        An object that supports being matched against.

        -
        • [match]:function
          • [match](string): RegExpMatchArray

          • Parameters

            • string: string

            Returns RegExpMatchArray

      Returns RegExpMatchArray

    normalize

    • normalize(form): string

    • Returns the String value result of normalizing the string into the normalization form +

      Parameters

      • matcher: { "[match]"(string: string): RegExpMatchArray }

        An object that supports being matched against.

        +

      Returns RegExpMatchArray

    normalize

    • normalize(form: "NFC" | "NFD" | "NFKC" | "NFKD"): string

    • Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

      -

      Parameters

      • form:
            | "NFC"
            | "NFD"
            | "NFKC"
            | "NFKD"

        Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default +

        Parameters

        • form: "NFC" | "NFD" | "NFKC" | "NFKD"

          Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

          -

        Returns string

      • normalize(form?): string

      • Returns the String value result of normalizing the string into the normalization form +

      Returns string

    • normalize(form?: string): string

    • Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

      Parameters

      • Optionalform: string

        Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

        -

      Returns string

    padEnd

    • padEnd(maxLength, fillString?): string

    • Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. +

    Returns string

    padEnd

    • padEnd(maxLength: number, fillString?: string): string

    • Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.

      Parameters

      • maxLength: number

        The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.

      • OptionalfillString: string

        The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

        -

      Returns string

    padStart

    • padStart(maxLength, fillString?): string

    • Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. +

    Returns string

    padStart

    • padStart(maxLength: number, fillString?: string): string

    • Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.

      Parameters

      • maxLength: number

        The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.

      • OptionalfillString: string

        The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

        -

      Returns string

    repeat

    • repeat(count): string

    • Returns a String value that is made from count copies appended together. If count is 0, +

    Returns string

    repeat

    • repeat(count: number): string

    • Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.

      Parameters

      • count: number

        number of copies to append

        -

      Returns string

    replace

    • replace(searchValue, replaceValue): string

    • Replaces text in a string, using a regular expression or search string.

      -

      Parameters

      • searchValue: string | RegExp

        A string or regular expression to search for.

        +

      Returns string

    replace

    • replace(searchValue: string | RegExp, replaceValue: string): string

    • Replaces text in a string, using a regular expression or search string.

      +

      Parameters

      • searchValue: string | RegExp

        A string or regular expression to search for.

      • replaceValue: string

        A string containing the text to replace. When the searchValue is a RegExp, all matches are replaced if the g flag is set (or only those matches at the beginning, if the y flag is also present). Otherwise, only the first match of searchValue is replaced.

        -

      Returns string

    • replace(searchValue, replacer): string

    • Replaces text in a string, using a regular expression or search string.

      -

      Parameters

      • searchValue: string | RegExp

        A string to search for.

        -
      • replacer: ((substring: string, ...args: any[]) => string)

        A function that returns the replacement text.

        -
          • (substring, ...args): string

          • Parameters

            • substring: string
            • Rest...args: any[]

            Returns string

      Returns string

    • replace(searchValue, replaceValue): string

    • Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.

      -

      Parameters

      • searchValue: {
            [replace](string: string, replaceValue: string): string;
        }

        An object that supports searching for and replacing matches within a string.

        -
        • [replace]:function
          • [replace](string, replaceValue): string

          • Parameters

            • string: string
            • replaceValue: string

            Returns string

      • replaceValue: string

        The replacement text.

        -

      Returns string

    • replace(searchValue, replacer): string

    • Replaces text in a string, using an object that supports replacement within a string.

      -

      Parameters

      • searchValue: {
            [replace](string: string, replacer: ((substring: string, ...args: any[]) => string)): string;
        }

        A object can search for and replace matches within a string.

        -
        • [replace]:function
          • [replace](string, replacer): string

          • Parameters

            • string: string
            • replacer: ((substring: string, ...args: any[]) => string)
                • (substring, ...args): string

                • Parameters

                  • substring: string
                  • Rest...args: any[]

                  Returns string

            Returns string

      • replacer: ((substring: string, ...args: any[]) => string)

        A function that returns the replacement text.

        -
          • (substring, ...args): string

          • Parameters

            • substring: string
            • Rest...args: any[]

            Returns string

      Returns string

    search

    • search(regexp): number

    • Finds the first substring match in a regular expression search.

      -

      Parameters

      • regexp: string | RegExp

        The regular expression pattern and applicable flags.

        -

      Returns number

    • search(searcher): number

    • Finds the first substring match in a regular expression search.

      -

      Parameters

      • searcher: {
            [search](string: string): number;
        }

        An object which supports searching within a string.

        -
        • [search]:function
          • [search](string): number

          • Parameters

            • string: string

            Returns number

      Returns number

    slice

    • slice(start?, end?): string

    • Returns a section of a string.

      +

    Returns string

  • replace(
        searchValue: string | RegExp,
        replacer: (substring: string, ...args: any[]) => string,
    ): string

  • Replaces text in a string, using a regular expression or search string.

    +

    Parameters

    • searchValue: string | RegExp

      A string to search for.

      +
    • replacer: (substring: string, ...args: any[]) => string

      A function that returns the replacement text.

      +

    Returns string

  • replace(
        searchValue: {
            "[replace]"(string: string, replaceValue: string): string;
        },
        replaceValue: string,
    ): string

  • Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.

    +

    Parameters

    • searchValue: { "[replace]"(string: string, replaceValue: string): string }

      An object that supports searching for and replacing matches within a string.

      +
    • replaceValue: string

      The replacement text.

      +

    Returns string

  • replace(
        searchValue: {
            "[replace]"(
                string: string,
                replacer: (substring: string, ...args: any[]) => string,
            ): string;
        },
        replacer: (substring: string, ...args: any[]) => string,
    ): string

  • Replaces text in a string, using an object that supports replacement within a string.

    +

    Parameters

    • searchValue: {
          "[replace]"(
              string: string,
              replacer: (substring: string, ...args: any[]) => string,
          ): string;
      }

      A object can search for and replace matches within a string.

      +
    • replacer: (substring: string, ...args: any[]) => string

      A function that returns the replacement text.

      +

    Returns string

    • search

    • search(regexp: string | RegExp): number

    • Finds the first substring match in a regular expression search.

      +

      Parameters

      • regexp: string | RegExp

        The regular expression pattern and applicable flags.

        +

      Returns number

    • search(searcher: { "[search]"(string: string): number }): number

    • Finds the first substring match in a regular expression search.

      +

      Parameters

      • searcher: { "[search]"(string: string): number }

        An object which supports searching within a string.

        +

      Returns number

    slice

    • slice(start?: number, end?: number): string

    • Returns a section of a string.

      Parameters

      • Optionalstart: number

        The index to the beginning of the specified portion of stringObj.

      • Optionalend: number

        The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

        -

      Returns string

    small

    • small(): string

    • Returns a <small> HTML element

      -

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      -

    split

    • split(separator, limit?): string[]

    • Split a string into substrings using the specified separator and return them as an array.

      -

      Parameters

      • separator: string | RegExp

        A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.

        +

      Returns string

    small

    • small(): string

    • Returns a <small> HTML element

      +

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      +

    split

    • split(separator: string | RegExp, limit?: number): string[]

    • Split a string into substrings using the specified separator and return them as an array.

      +

      Parameters

      • separator: string | RegExp

        A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.

      • Optionallimit: number

        A value used to limit the number of elements returned in the array.

        -

      Returns string[]

    • split(splitter, limit?): string[]

    • Split a string into substrings using the specified separator and return them as an array.

      -

      Parameters

      • splitter: {
            [split](string: string, limit?: number): string[];
        }

        An object that can split a string.

        -
        • [split]:function
          • [split](string, limit?): string[]

          • Parameters

            • string: string
            • Optionallimit: number

            Returns string[]

      • Optionallimit: number

        A value used to limit the number of elements returned in the array.

        -

      Returns string[]

    startsWith

    • startsWith(searchString, position?): boolean

    • Returns true if the sequence of elements of searchString converted to a String is the +

    Returns string[]

  • split(
        splitter: { "[split]"(string: string, limit?: number): string[] },
        limit?: number,
    ): string[]

  • Split a string into substrings using the specified separator and return them as an array.

    +

    Parameters

    • splitter: { "[split]"(string: string, limit?: number): string[] }

      An object that can split a string.

      +
    • Optionallimit: number

      A value used to limit the number of elements returned in the array.

      +

    Returns string[]

    • startsWith

    • startsWith(searchString: string, position?: number): boolean

    • Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.

      -

      Parameters

      • searchString: string
      • Optionalposition: number

      Returns boolean

    strike

    • strike(): string

    • Returns a <strike> HTML element

      -

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      -

    sub

    • sub(): string

    • Returns a <sub> HTML element

      -

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      -

    substr

    • substr(from, length?): string

    • Gets a substring beginning at the specified location and having the specified length.

      +

      Parameters

      • searchString: string
      • Optionalposition: number

      Returns boolean

    strike

    • strike(): string

    • Returns a <strike> HTML element

      +

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      +

    sub

    • sub(): string

    • Returns a <sub> HTML element

      +

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      +

    substr

    • substr(from: number, length?: number): string

    • Gets a substring beginning at the specified location and having the specified length.

      Parameters

      • from: number

        The starting position of the desired substring. The index of the first character in the string is zero.

      • Optionallength: number

        The number of characters to include in the returned substring.

        -

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      -

    substring

    • substring(start, end?): string

    • Returns the substring at the specified location within a String object.

      +

    Returns string

    Deprecated

    A legacy feature for browser compatibility

    +

    substring

    • substring(start: number, end?: number): string

    • Returns the substring at the specified location within a String object.

      Parameters

      • start: number

        The zero-based index number indicating the beginning of the substring.

      • Optionalend: number

        Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

        -

      Returns string

    sup

    • sup(): string

    • Returns a <sup> HTML element

      -

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      -

    toLocaleLowerCase

    • toLocaleLowerCase(locales?): string

    • Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

      -

      Parameters

      • Optionallocales: string | string[]

      Returns string

    toLocaleUpperCase

    • toLocaleUpperCase(locales?): string

    • Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

      -

      Parameters

      • Optionallocales: string | string[]

      Returns string

    toLowerCase

    • toLowerCase(): string

    • Converts all the alphabetic characters in a string to lowercase.

      -

      Returns string

    toString

    • toString(): string

    • Returns a string representation of a string.

      -

      Returns string

    toUpperCase

    • toUpperCase(): string

    • Converts all the alphabetic characters in a string to uppercase.

      -

      Returns string

    trim

    • trim(): string

    • Removes the leading and trailing white space and line terminator characters from a string.

      -

      Returns string

    valueOf

    • valueOf(): string

    • Returns the primitive value of the specified object.

      -

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Returns string

    sup

    • sup(): string

    • Returns a <sup> HTML element

      +

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      +

    toLocaleLowerCase

    • toLocaleLowerCase(locales?: string | string[]): string

    • Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

      +

      Parameters

      • Optionallocales: string | string[]

      Returns string

    toLocaleUpperCase

    • toLocaleUpperCase(locales?: string | string[]): string

    • Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

      +

      Parameters

      • Optionallocales: string | string[]

      Returns string

    toLowerCase

    • toLowerCase(): string

    • Converts all the alphabetic characters in a string to lowercase.

      +

      Returns string

    toString

    • toString(): string

    • Returns a string representation of a string.

      +

      Returns string

    toUpperCase

    • toUpperCase(): string

    • Converts all the alphabetic characters in a string to uppercase.

      +

      Returns string

    trim

    • trim(): string

    • Removes the leading and trailing white space and line terminator characters from a string.

      +

      Returns string

    valueOf

    • valueOf(): string

    • Returns the primitive value of the specified object.

      +

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/api/interfaces/WorkerConfiguration.html b/api/interfaces/WorkerConfiguration.html index d289137a..5155ab3d 100644 --- a/api/interfaces/WorkerConfiguration.html +++ b/api/interfaces/WorkerConfiguration.html @@ -1,12 +1,12 @@ -WorkerConfiguration | @zip.js/zip.js

    Interface WorkerConfiguration

    Represents configuration passed to configure, the constructor of ZipReader, Entry#getData, the constructor of ZipWriter, and ZipWriter#add.

    -
    interface WorkerConfiguration {
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
    }

    Hierarchy (view full)

    Properties

    useCompressionStream? -useWebWorkers? -

    Properties

    OptionaluseCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    -

    Default Value

    true
+WorkerConfiguration | @zip.js/zip.js
    Interface WorkerConfiguration
    Represents configuration passed to configure, the constructor of ZipReader, Entry#getData, the constructor of ZipWriter, and ZipWriter#add.
    
+
    interface WorkerConfiguration {
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
    }
    Hierarchy (View Summary)
    Properties
    useCompressionStream?
+useWebWorkers?
+
     Properties
    OptionaluseCompressionStream
    useCompressionStream?: boolean
    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.
    
+
    Default Value
    true
 
    
 
-
    OptionaluseWebWorkers
    useWebWorkers?: boolean
    true to use web workers to compress/decompress data in non-blocking background processes.
    
-
    Default Value
    true
+
    OptionaluseWebWorkers
    useWebWorkers?: boolean
    true to use web workers to compress/decompress data in non-blocking background processes.
    
+
    Default Value
    true
 
    
 
-
    Settings
    Member Visibility
    On This Page
    Properties
    
+

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/WritableWriter.html b/api/interfaces/WritableWriter.html index d94c1ceb..1b3980b7 100644 --- a/api/interfaces/WritableWriter.html +++ b/api/interfaces/WritableWriter.html @@ -1,6 +1,6 @@ -WritableWriter | @zip.js/zip.js

    Interface WritableWriter

    Represents an instance used to write data into a WritableStream instance.

    -
    interface WritableWriter {
        maxSize?: number;
        writable: WritableStream<any>;
    }

    Implemented by

    Properties

    maxSize? +WritableWriter | @zip.js/zip.js

    Interface WritableWriter

    Represents an instance used to write data into a WritableStream instance.

    +
    interface WritableWriter {
        maxSize?: number;
        writable: WritableStream<any>;
    }

    Implemented by

    Properties

    maxSize? writable -

    Properties

    OptionalmaxSize

    maxSize?: number

    The maximum size of split data when creating a ZipWriter instance or when calling Entry#getData with a generator of WritableWriter instances.

    -

    writable

    writable: WritableStream<any>

    The WritableStream instance.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalmaxSize

    maxSize?: number

    The maximum size of split data when creating a ZipWriter instance or when calling Entry#getData with a generator of WritableWriter instances.

    +

    writable

    writable: WritableStream<any>

    The WritableStream instance.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/ZipDirectoryEntryExportOptions.html b/api/interfaces/ZipDirectoryEntryExportOptions.html index b706472d..091a61b7 100644 --- a/api/interfaces/ZipDirectoryEntryExportOptions.html +++ b/api/interfaces/ZipDirectoryEntryExportOptions.html @@ -1,152 +1,152 @@ -ZipDirectoryEntryExportOptions | @zip.js/zip.js

    Interface ZipDirectoryEntryExportOptions

    Represents the options passed to {@link ZipDirectoryEntry}#export*().

    -
    interface ZipDirectoryEntryExportOptions {
        bufferedWrite?: boolean;
        compressionMethod?: number;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        encrypted?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        mimeType?: string;
        msDosCompatible?: boolean;
        offset?: number;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        readerOptions?: ZipReaderConstructorOptions;
        relativePath?: boolean;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        useUnicodeFileNames?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText?(text: string): Uint8Array;
        onend?(computedSize: number): Promise<void>;
        onprogress?(progress: number, total: number): Promise<void>;
        onstart?(total: number): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    bufferedWrite? -compressionMethod? -creationDate? -dataDescriptor? -dataDescriptorSignature? +ZipDirectoryEntryExportOptions | @zip.js/zip.js

    Interface ZipDirectoryEntryExportOptions

    Represents the options passed to {@link ZipDirectoryEntry}#export*().

    +
    interface ZipDirectoryEntryExportOptions {
        bufferedWrite?: boolean;
        compressionMethod?: number;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        encrypted?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        mimeType?: string;
        msDosCompatible?: boolean;
        offset?: number;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array<ArrayBufferLike>;
        readerOptions?: ZipReaderConstructorOptions;
        relativePath?: boolean;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        useUnicodeFileNames?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText(text: string): Uint8Array<ArrayBufferLike>;
        onend(computedSize: number): Promise<void>;
        onprogress(progress: number, total: number): Promise<void>;
        onstart(total: number): Promise<void>;
    }

    Hierarchy (View Summary)

    Properties

    bufferedWrite? +compressionMethod? +creationDate? +dataDescriptor? +dataDescriptorSignature? encrypted? -encryptionStrength? -extendedTimestamp? -externalFileAttribute? -internalFileAttribute? -keepOrder? -lastAccessDate? -lastModDate? +encryptionStrength? +extendedTimestamp? +externalFileAttribute? +internalFileAttribute? +keepOrder? +lastAccessDate? +lastModDate? level? -mimeType? -msDosCompatible? +mimeType? +msDosCompatible? offset? -passThrough? +passThrough? password? -preventClose? -rawPassword? -readerOptions? -relativePath? +preventClose? +rawPassword? +readerOptions? +relativePath? signal? -supportZip64SplitFile? +supportZip64SplitFile? usdz? -useUnicodeFileNames? +useUnicodeFileNames? version? -versionMadeBy? +versionMadeBy? zip64? -zipCrypto? -

    Methods

    encodeText? +zipCrypto? +

    Methods

    encodeText? onend? onprogress? onstart? -

    Properties

    OptionalbufferedWrite

    bufferedWrite?: boolean

    true to write entry data in a buffer before appending it to the zip file.

    +

    Properties

    OptionalbufferedWrite

    bufferedWrite?: boolean

    true to write entry data in a buffer before appending it to the zip file.

    bufferedWrite is automatically set to true when compressing more than one entry in parallel.

    -

    Default Value

    false
+

    Default Value

    false
    -

    OptionalcompressionMethod

    compressionMethod?: number

    The compression method (e.g. 8 for DEFLATE, 0 for STORE).

    -

    OptionalcreationDate

    creationDate?: Date

    The creation date.

    -

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    -

    Default Value

    The current date.
+

    OptionalcompressionMethod

    compressionMethod?: number

    The compression method (e.g. 8 for DEFLATE, 0 for STORE).

    +

    OptionalcreationDate

    creationDate?: Date

    The creation date.

    +

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    +

    Default Value

    The current date.
    -

    OptionaldataDescriptor

    dataDescriptor?: boolean

    true to add a data descriptor.

    -

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    -

    Default Value

    true
+

    OptionaldataDescriptor

    dataDescriptor?: boolean

    true to add a data descriptor.

    +

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    +

    Default Value

    true
    -

    OptionaldataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    -

    Default Value

    false
+

    OptionaldataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    +

    Default Value

    false
    -

    Optionalencrypted

    encrypted?: boolean

    true to write encrypted data when passThrough is set to true.

    -

    OptionalencryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    -

    Default Value

    3
+

    Optionalencrypted

    encrypted?: boolean

    true to write encrypted data when passThrough is set to true.

    +

    OptionalencryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    +

    Default Value

    3
    -

    OptionalextendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    +

    OptionalextendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    When set to false, the maximum last modification date cannot exceed November 31, 2107 and the maximum accuracy is 2 seconds.

    -

    Default Value

    true
+

    Default Value

    true
    -

    OptionalexternalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    -

    Default Value

    0
+

    OptionalexternalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    +

    Default Value

    0
    -

    OptionalinternalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    -

    Default Value

    0
+

    OptionalinternalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    +

    Default Value

    0
    -

    OptionalkeepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    +

    OptionalkeepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip64 option to true explicitly. Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.

    -

    Default Value

    true
+

    Default Value

    true
    -

    OptionallastAccessDate

    lastAccessDate?: Date

    The last access date.

    -

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    -

    Default Value

    The current date.
+

    OptionallastAccessDate

    lastAccessDate?: Date

    The last access date.

    +

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    +

    Default Value

    The current date.
    -

    OptionallastModDate

    lastModDate?: Date

    The last modification date.

    -

    Default Value

    The current date.
+

    OptionallastModDate

    lastModDate?: Date

    The last modification date.

    +

    Default Value

    The current date.
    -

    Optionallevel

    level?: number

    The level of compression.

    +

    Optionallevel

    level?: number

    The level of compression.

    The minimum value is 0 and means that no compression is applied. The maximum value is 9.

    -

    Default Value

    5
+

    Default Value

    5
    -

    OptionalmimeType

    mimeType?: string

    The MIME type of the exported data when relevant.

    -

    OptionalmsDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    -

    Default Value

    true
+

    OptionalmimeType

    mimeType?: string

    The MIME type of the exported data when relevant.

    +

    OptionalmsDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    +

    Default Value

    true
    -

    Optionaloffset

    offset?: number

    The offset of the first entry in the zip file.

    -

    OptionalpassThrough

    passThrough?: boolean

    true to write the data as-is without compressing it and without crypting it.

    -

    Optionalpassword

    password?: string

    The password used to encrypt the content of the entry.

    -

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    -

    Default Value

    false
+

    Optionaloffset

    offset?: number

    The offset of the first entry in the zip file.

    +

    OptionalpassThrough

    passThrough?: boolean

    true to write the data as-is without compressing it and without crypting it.

    +

    Optionalpassword

    password?: string

    The password used to encrypt the content of the entry.

    +

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    +

    Default Value

    false
    -

    OptionalrawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    OptionalreaderOptions

    readerOptions?: ZipReaderConstructorOptions

    The options passed to the Reader instances

    -

    OptionalrelativePath

    relativePath?: boolean

    true to use filenames relative to the entry instead of full filenames.

    -

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    -

    OptionalsupportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    -

    Default Value

    true
+

    OptionalrawPassword

    rawPassword?: Uint8Array<ArrayBufferLike>

    The password used to encrypt the content of the entry (raw).

    +

    OptionalreaderOptions

    readerOptions?: ZipReaderConstructorOptions

    The options passed to the Reader instances

    +

    OptionalrelativePath

    relativePath?: boolean

    true to use filenames relative to the entry instead of full filenames.

    +

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    +

    OptionalsupportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    +

    Default Value

    true
    -

    Optionalusdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    -

    Default Value

    false
+

    Optionalusdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    +

    Default Value

    false
    -

    OptionaluseUnicodeFileNames

    useUnicodeFileNames?: boolean

    true to mark the file names as UTF-8 setting the general purpose bit 11 in the header (see Appendix D - Language Encoding (EFS)), false to mark the names as compliant with the original IBM Code Page 437.

    +

    OptionaluseUnicodeFileNames

    useUnicodeFileNames?: boolean

    true to mark the file names as UTF-8 setting the general purpose bit 11 in the header (see Appendix D - Language Encoding (EFS)), false to mark the names as compliant with the original IBM Code Page 437.

    Note that this does not ensure that the file names are in the correct encoding.

    -

    Default Value

    true
+

    Default Value

    true
    -

    Optionalversion

    version?: number

    The "Version" field.

    -

    OptionalversionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    -

    Default Value

    20
+

    Optionalversion

    version?: number

    The "Version" field.

    +

    OptionalversionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    +

    Default Value

    20
    -

    Optionalzip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    +

    Optionalzip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    zip64 is automatically set to true when necessary (e.g. compressed data larger than 4GB or with unknown size).

    -

    Default Value

    false
+

    Default Value

    false
    -

    OptionalzipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    +

    OptionalzipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    It is not recommended to set zipCrypto to true because the ZipCrypto encryption can be easily broken.

    -

    Default Value

    false
+

    Default Value

    false
    -

    Methods

    OptionalencodeText

    Methods

    OptionalencodeText

    • encodeText(text: string): Uint8Array<ArrayBufferLike>

    • Encode the filename and the comment of the entry.

      Parameters

      • text: string

        The text to encode.

        -

      Returns Uint8Array

      The encoded text or undefined if the text should be encoded by zip.js.

      -

    Optionalonend

    • onend(computedSize): Promise<void>

    • The function called when ending compression/decompression.

      +

    Returns Uint8Array<ArrayBufferLike>

    The encoded text or undefined if the text should be encoded by zip.js.

    +

    Optionalonend

    • onend(computedSize: number): Promise<void>

    • The function called when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optionalonprogress

    Optionalonprogress

    • onprogress(progress: number, total: number): Promise<void>

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optionalonstart

    Optionalonstart

    • onstart(total: number): Promise<void>

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/api/interfaces/ZipDirectoryEntryImportHttpOptions.html b/api/interfaces/ZipDirectoryEntryImportHttpOptions.html index 60ca20ea..f253c421 100644 --- a/api/interfaces/ZipDirectoryEntryImportHttpOptions.html +++ b/api/interfaces/ZipDirectoryEntryImportHttpOptions.html @@ -1,87 +1,87 @@ -ZipDirectoryEntryImportHttpOptions | @zip.js/zip.js

    Interface ZipDirectoryEntryImportHttpOptions

    Represents the options passed to ZipDirectoryEntry#importHttpContent.

    -
    interface ZipDirectoryEntryImportHttpOptions {
        checkPasswordOnly?: boolean;
        checkSignature?: boolean;
        combineSizeEocd?: boolean;
        commentEncoding?: string;
        extractAppendedData?: boolean;
        extractPrependedData?: boolean;
        filenameEncoding?: string;
        forceRangeRequests?: boolean;
        headers?: Iterable<[string, string], any, any> | Map<string, string>;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        preventHeadRequest?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useRangeHeader?: boolean;
        useWebWorkers?: boolean;
        useXHR?: boolean;
        decodeText?(value: Uint8Array, encoding: string): string;
    }

    Hierarchy (view full)

    Properties

    checkPasswordOnly? -checkSignature? -combineSizeEocd? -commentEncoding? -extractAppendedData? -extractPrependedData? -filenameEncoding? -forceRangeRequests? +ZipDirectoryEntryImportHttpOptions | @zip.js/zip.js

    Interface ZipDirectoryEntryImportHttpOptions

    Represents the options passed to ZipDirectoryEntry#importHttpContent.

    +
    interface ZipDirectoryEntryImportHttpOptions {
        checkPasswordOnly?: boolean;
        checkSignature?: boolean;
        combineSizeEocd?: boolean;
        commentEncoding?: string;
        extractAppendedData?: boolean;
        extractPrependedData?: boolean;
        filenameEncoding?: string;
        forceRangeRequests?: boolean;
        headers?: Iterable<[string, string], any, any> | Map<string, string>;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        preventHeadRequest?: boolean;
        rawPassword?: Uint8Array<ArrayBufferLike>;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useRangeHeader?: boolean;
        useWebWorkers?: boolean;
        useXHR?: boolean;
        decodeText(value: Uint8Array<ArrayBufferLike>, encoding: string): string;
    }

    Hierarchy (View Summary)

    Properties

    checkPasswordOnly? +checkSignature? +combineSizeEocd? +commentEncoding? +extractAppendedData? +extractPrependedData? +filenameEncoding? +forceRangeRequests? headers? -passThrough? +passThrough? password? -preventClose? -preventHeadRequest? -rawPassword? +preventClose? +preventHeadRequest? +rawPassword? signal? -transferStreams? -useCompressionStream? -useRangeHeader? -useWebWorkers? -useXHR? -

    Methods

    decodeText? -

    Properties

    OptionalcheckPasswordOnly

    checkPasswordOnly?: boolean

    true to check only if the password is valid.

    -

    Default Value

    false
+transferStreams?
+useCompressionStream?
+useRangeHeader?
+useWebWorkers?
+useXHR?
+

    Methods

    decodeText? +

    Properties

    OptionalcheckPasswordOnly

    checkPasswordOnly?: boolean

    true to check only if the password is valid.

    +

    Default Value

    false
    -

    OptionalcheckSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    -

    Default Value

    false
+

    OptionalcheckSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    +

    Default Value

    false
    -

    OptionalcombineSizeEocd

    combineSizeEocd?: boolean

    true to use Range: bytes=-22 on the first request and cache the EOCD, make sure beforehand that the server supports a suffix range request.

    -

    Default Value

    false
+

    OptionalcombineSizeEocd

    combineSizeEocd?: boolean

    true to use Range: bytes=-22 on the first request and cache the EOCD, make sure beforehand that the server supports a suffix range request.

    +

    Default Value

    false
    -

    OptionalcommentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    -

    OptionalextractAppendedData

    extractAppendedData?: boolean

    true to extract the appended data into ZipReader#appendedData.

    -

    Default Value

    false
+

    OptionalcommentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    +

    OptionalextractAppendedData

    extractAppendedData?: boolean

    true to extract the appended data into ZipReader#appendedData.

    +

    Default Value

    false
    -

    OptionalextractPrependedData

    extractPrependedData?: boolean

    true to extract the prepended data into ZipReader#prependedData.

    -

    Default Value

    false
+

    OptionalextractPrependedData

    extractPrependedData?: boolean

    true to extract the prepended data into ZipReader#prependedData.

    +

    Default Value

    false
    -

    OptionalfilenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    -

    OptionalforceRangeRequests

    forceRangeRequests?: boolean

    true to always use Range headers when fetching data.

    -

    Default Value

    false
+

    OptionalfilenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    +

    OptionalforceRangeRequests

    forceRangeRequests?: boolean

    true to always use Range headers when fetching data.

    +

    Default Value

    false
    -

    Optionalheaders

    headers?: Iterable<[string, string], any, any> | Map<string, string>

    The HTTP headers.

    -

    OptionalpassThrough

    passThrough?: boolean

    true to read the data as-is without decompressing it and without decrypting it.

    -

    Optionalpassword

    password?: string

    The password used to decrypt the content of the entry.

    -

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    -

    Default Value

    false
+

    Optionalheaders

    headers?: Iterable<[string, string], any, any> | Map<string, string>

    The HTTP headers.

    +

    OptionalpassThrough

    passThrough?: boolean

    true to read the data as-is without decompressing it and without decrypting it.

    +

    Optionalpassword

    password?: string

    The password used to decrypt the content of the entry.

    +

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    +

    Default Value

    false
    -

    OptionalpreventHeadRequest

    preventHeadRequest?: boolean

    true to prevent using HEAD HTTP request in order the get the size of the content. +

    OptionalpreventHeadRequest

    preventHeadRequest?: boolean

    true to prevent using HEAD HTTP request in order the get the size of the content. false to explicitly use HEAD, this is useful in case of CORS where Access-Control-Expose-Headers: Content-Range is not returned by the server.

    -

    Default Value

    false
+

    Default Value

    false
    -

    OptionalrawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    -

    OptionaltransferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    -

    Default Value

    true
+

    OptionalrawPassword

    rawPassword?: Uint8Array<ArrayBufferLike>

    The password used to encrypt the content of the entry (raw).

    +

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    +

    OptionaltransferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    +

    Default Value

    true
    -

    OptionaluseCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    -

    Default Value

    true
+

    OptionaluseCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    +

    Default Value

    true
    -

    OptionaluseRangeHeader

    useRangeHeader?: boolean

    true to use Range headers when fetching data from servers returning Accept-Ranges headers.

    -

    Default Value

    false
+

    OptionaluseRangeHeader

    useRangeHeader?: boolean

    true to use Range headers when fetching data from servers returning Accept-Ranges headers.

    +

    Default Value

    false
    -

    OptionaluseWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    -

    Default Value

    true
+

    OptionaluseWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Default Value

    true
    -

    OptionaluseXHR

    useXHR?: boolean

    true to rely XMLHttpRequest instead of fetch to fetch data.

    -

    Default Value

    false
+

    OptionaluseXHR

    useXHR?: boolean

    true to rely XMLHttpRequest instead of fetch to fetch data.

    +

    Default Value

    false
    -

    Methods

    OptionaldecodeText

    • decodeText(value, encoding): string

    • Decodes the filename and the comment of the entry.

      -

      Parameters

      • value: Uint8Array

        The raw text value.

        +

    Methods

    OptionaldecodeText

    • decodeText(value: Uint8Array<ArrayBufferLike>, encoding: string): string

    • Decodes the filename and the comment of the entry.

      +

      Parameters

      • value: Uint8Array<ArrayBufferLike>

        The raw text value.

      • encoding: string

        The encoding of the text.

      Returns string

      The decoded text value or undefined if the raw text value should be decoded by zip.js.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/api/interfaces/ZipLibrary.html b/api/interfaces/ZipLibrary.html index 805a6dd0..6d493f6f 100644 --- a/api/interfaces/ZipLibrary.html +++ b/api/interfaces/ZipLibrary.html @@ -1,8 +1,8 @@ -ZipLibrary | @zip.js/zip.js

    Interface ZipLibrary

    Represents the implementations zip.js uses to compress/decompress data.

    -
    interface ZipLibrary {
        Deflate: typeof ZipDeflate;
        Inflate: typeof ZipInflate;
    }

    Properties

    Deflate -Inflate -

    Properties

    Deflate

    Deflate: typeof ZipDeflate

    The class used to compress data.

    -

    Default Value

    ZipDeflate

    -

    Inflate

    Inflate: typeof ZipInflate

    The class used to decompress data.

    -

    Default Value

    ZipInflate

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +ZipLibrary | @zip.js/zip.js

    Interface ZipLibrary

    Represents the implementations zip.js uses to compress/decompress data.

    +
    interface ZipLibrary {
        Deflate: typeof ZipDeflate;
        Inflate: typeof ZipInflate;
    }

    Properties

    Deflate +Inflate +

    Properties

    Deflate

    Deflate: typeof ZipDeflate

    The class used to compress data.

    +

    Default Value

    ZipDeflate

    +

    Inflate

    Inflate: typeof ZipInflate

    The class used to decompress data.

    +

    Default Value

    ZipInflate

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/ZipReaderConstructorOptions.html b/api/interfaces/ZipReaderConstructorOptions.html index cfbc3ab2..04891834 100644 --- a/api/interfaces/ZipReaderConstructorOptions.html +++ b/api/interfaces/ZipReaderConstructorOptions.html @@ -1,59 +1,59 @@ -ZipReaderConstructorOptions | @zip.js/zip.js

    Interface ZipReaderConstructorOptions

    Represents the options passed to the constructor of ZipReader, and {@link ZipDirectory}#import*.

    -
    interface ZipReaderConstructorOptions {
        checkPasswordOnly?: boolean;
        checkSignature?: boolean;
        commentEncoding?: string;
        extractAppendedData?: boolean;
        extractPrependedData?: boolean;
        filenameEncoding?: string;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        decodeText?(value: Uint8Array, encoding: string): string;
    }

    Hierarchy (view full)

    Properties

    checkPasswordOnly? -checkSignature? -commentEncoding? -extractAppendedData? -extractPrependedData? -filenameEncoding? -passThrough? +ZipReaderConstructorOptions | @zip.js/zip.js

    Interface ZipReaderConstructorOptions

    Represents the options passed to the constructor of ZipReader, and {@link ZipDirectory}#import*.

    +
    interface ZipReaderConstructorOptions {
        checkPasswordOnly?: boolean;
        checkSignature?: boolean;
        commentEncoding?: string;
        extractAppendedData?: boolean;
        extractPrependedData?: boolean;
        filenameEncoding?: string;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array<ArrayBufferLike>;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        decodeText(value: Uint8Array<ArrayBufferLike>, encoding: string): string;
    }

    Hierarchy (View Summary)

    Properties

    checkPasswordOnly? +checkSignature? +commentEncoding? +extractAppendedData? +extractPrependedData? +filenameEncoding? +passThrough? password? -preventClose? -rawPassword? +preventClose? +rawPassword? signal? -transferStreams? -useCompressionStream? -useWebWorkers? -

    Methods

    decodeText? -

    Properties

    OptionalcheckPasswordOnly

    checkPasswordOnly?: boolean

    true to check only if the password is valid.

    -

    Default Value

    false
+transferStreams?
+useCompressionStream?
+useWebWorkers?
+

    Methods

    decodeText? +

    Properties

    OptionalcheckPasswordOnly

    checkPasswordOnly?: boolean

    true to check only if the password is valid.

    +

    Default Value

    false
    -

    OptionalcheckSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    -

    Default Value

    false
+

    OptionalcheckSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    +

    Default Value

    false
    -

    OptionalcommentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    -

    OptionalextractAppendedData

    extractAppendedData?: boolean

    true to extract the appended data into ZipReader#appendedData.

    -

    Default Value

    false
+

    OptionalcommentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    +

    OptionalextractAppendedData

    extractAppendedData?: boolean

    true to extract the appended data into ZipReader#appendedData.

    +

    Default Value

    false
    -

    OptionalextractPrependedData

    extractPrependedData?: boolean

    true to extract the prepended data into ZipReader#prependedData.

    -

    Default Value

    false
+

    OptionalextractPrependedData

    extractPrependedData?: boolean

    true to extract the prepended data into ZipReader#prependedData.

    +

    Default Value

    false
    -

    OptionalfilenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    -

    OptionalpassThrough

    passThrough?: boolean

    true to read the data as-is without decompressing it and without decrypting it.

    -

    Optionalpassword

    password?: string

    The password used to decrypt the content of the entry.

    -

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    -

    Default Value

    false
+

    OptionalfilenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    +

    OptionalpassThrough

    passThrough?: boolean

    true to read the data as-is without decompressing it and without decrypting it.

    +

    Optionalpassword

    password?: string

    The password used to decrypt the content of the entry.

    +

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    +

    Default Value

    false
    -

    OptionalrawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    -

    OptionaltransferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    -

    Default Value

    true
+

    OptionalrawPassword

    rawPassword?: Uint8Array<ArrayBufferLike>

    The password used to encrypt the content of the entry (raw).

    +

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    +

    OptionaltransferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    +

    Default Value

    true
    -

    OptionaluseCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    -

    Default Value

    true
+

    OptionaluseCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    +

    Default Value

    true
    -

    OptionaluseWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    -

    Default Value

    true
+

    OptionaluseWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Default Value

    true
    -

    Methods

    OptionaldecodeText

    Methods

    OptionaldecodeText

    • decodeText(value: Uint8Array<ArrayBufferLike>, encoding: string): string

    • Decodes the filename and the comment of the entry.

      +

      Parameters

      • value: Uint8Array<ArrayBufferLike>

        The raw text value.

      • encoding: string

        The encoding of the text.

      Returns string

      The decoded text value or undefined if the raw text value should be decoded by zip.js.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/api/interfaces/ZipReaderGetEntriesOptions.html b/api/interfaces/ZipReaderGetEntriesOptions.html index d03972f5..eb662a68 100644 --- a/api/interfaces/ZipReaderGetEntriesOptions.html +++ b/api/interfaces/ZipReaderGetEntriesOptions.html @@ -1,17 +1,17 @@ -ZipReaderGetEntriesOptions | @zip.js/zip.js

    Interface ZipReaderGetEntriesOptions

    Represents the options passed to ZipReader#getEntries and ZipReader#getEntriesGenerator.

    -
    interface ZipReaderGetEntriesOptions {
        commentEncoding?: string;
        filenameEncoding?: string;
        decodeText?(value: Uint8Array, encoding: string): string;
        onprogress?(progress: number, total: number, entry: EntryMetaData): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    commentEncoding? -filenameEncoding? -

    Methods

    decodeText? +ZipReaderGetEntriesOptions | @zip.js/zip.js

    Interface ZipReaderGetEntriesOptions

    Represents the options passed to ZipReader#getEntries and ZipReader#getEntriesGenerator.

    +
    interface ZipReaderGetEntriesOptions {
        commentEncoding?: string;
        filenameEncoding?: string;
        decodeText(value: Uint8Array<ArrayBufferLike>, encoding: string): string;
        onprogress(
            progress: number,
            total: number,
            entry: EntryMetaData,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Properties

    commentEncoding? +filenameEncoding? +

    Methods

    decodeText? onprogress? -

    Properties

    OptionalcommentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    -

    OptionalfilenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    -

    Methods

    OptionaldecodeText

    • decodeText(value, encoding): string

    • Decodes the filename and the comment of the entry.

      -

      Parameters

      • value: Uint8Array

        The raw text value.

        +

    Properties

    OptionalcommentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    +

    OptionalfilenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    +

    Methods

    OptionaldecodeText

    • decodeText(value: Uint8Array<ArrayBufferLike>, encoding: string): string

    • Decodes the filename and the comment of the entry.

      +

      Parameters

      • value: Uint8Array<ArrayBufferLike>

        The raw text value.

      • encoding: string

        The encoding of the text.

      Returns string

      The decoded text value or undefined if the raw text value should be decoded by zip.js.

      -

    Optionalonprogress

    Optionalonprogress

    • onprogress(progress: number, total: number, entry: EntryMetaData): Promise<void>

    • The function called each time an entry is read/written.

      Parameters

      • progress: number

        The entry index.

      • total: number

        The total number of entries.

      • entry: EntryMetaData

        The entry being read/written.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/api/interfaces/ZipReaderOptions.html b/api/interfaces/ZipReaderOptions.html index 60eb4311..2d8c92b6 100644 --- a/api/interfaces/ZipReaderOptions.html +++ b/api/interfaces/ZipReaderOptions.html @@ -1,30 +1,30 @@ -ZipReaderOptions | @zip.js/zip.js

    Interface ZipReaderOptions

    Represents options passed to the constructor of ZipReader and Entry#getData.

    -
    interface ZipReaderOptions {
        checkPasswordOnly?: boolean;
        checkSignature?: boolean;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
    }

    Hierarchy (view full)

    Properties

    checkPasswordOnly? -checkSignature? -passThrough? +ZipReaderOptions | @zip.js/zip.js

    Interface ZipReaderOptions

    Represents options passed to the constructor of ZipReader and Entry#getData.

    +
    interface ZipReaderOptions {
        checkPasswordOnly?: boolean;
        checkSignature?: boolean;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array<ArrayBufferLike>;
        signal?: AbortSignal;
        transferStreams?: boolean;
    }

    Hierarchy (View Summary)

    Properties

    checkPasswordOnly? +checkSignature? +passThrough? password? -preventClose? -rawPassword? +preventClose? +rawPassword? signal? -transferStreams? -

    Properties

    OptionalcheckPasswordOnly

    checkPasswordOnly?: boolean

    true to check only if the password is valid.

    -

    Default Value

    false
+transferStreams?
+

    Properties

    OptionalcheckPasswordOnly

    checkPasswordOnly?: boolean

    true to check only if the password is valid.

    +

    Default Value

    false
    -

    OptionalcheckSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    -

    Default Value

    false
+

    OptionalcheckSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    +

    Default Value

    false
    -

    OptionalpassThrough

    passThrough?: boolean

    true to read the data as-is without decompressing it and without decrypting it.

    -

    Optionalpassword

    password?: string

    The password used to decrypt the content of the entry.

    -

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    -

    Default Value

    false
+

    OptionalpassThrough

    passThrough?: boolean

    true to read the data as-is without decompressing it and without decrypting it.

    +

    Optionalpassword

    password?: string

    The password used to decrypt the content of the entry.

    +

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    +

    Default Value

    false
    -

    OptionalrawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    -

    OptionaltransferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    -

    Default Value

    true
+

    OptionalrawPassword

    rawPassword?: Uint8Array<ArrayBufferLike>

    The password used to encrypt the content of the entry (raw).

    +

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    +

    OptionaltransferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    +

    Default Value

    true
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/api/interfaces/ZipWriterAddDataOptions.html b/api/interfaces/ZipWriterAddDataOptions.html index e9753ff1..feaa1430 100644 --- a/api/interfaces/ZipWriterAddDataOptions.html +++ b/api/interfaces/ZipWriterAddDataOptions.html @@ -1,169 +1,169 @@ -ZipWriterAddDataOptions | @zip.js/zip.js

    Interface ZipWriterAddDataOptions

    Represents the options passed to ZipWriter#add.

    -
    interface ZipWriterAddDataOptions {
        bufferedWrite?: boolean;
        comment?: string;
        compressionMethod?: number;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        directory?: boolean;
        encrypted?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        extraField?: Map<number, Uint8Array>;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        msDosCompatible?: boolean;
        offset?: number;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        signature?: number;
        supportZip64SplitFile?: boolean;
        uncompressedSize?: number;
        usdz?: boolean;
        useCompressionStream?: boolean;
        useUnicodeFileNames?: boolean;
        useWebWorkers?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText?(text: string): Uint8Array;
        onend?(computedSize: number): Promise<void>;
        onprogress?(progress: number, total: number): Promise<void>;
        onstart?(total: number): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    bufferedWrite? +ZipWriterAddDataOptions | @zip.js/zip.js

    Interface ZipWriterAddDataOptions

    Represents the options passed to ZipWriter#add.

    +
    interface ZipWriterAddDataOptions {
        bufferedWrite?: boolean;
        comment?: string;
        compressionMethod?: number;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        directory?: boolean;
        encrypted?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        extraField?: Map<number, Uint8Array<ArrayBufferLike>>;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        msDosCompatible?: boolean;
        offset?: number;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array<ArrayBufferLike>;
        signal?: AbortSignal;
        signature?: number;
        supportZip64SplitFile?: boolean;
        uncompressedSize?: number;
        usdz?: boolean;
        useCompressionStream?: boolean;
        useUnicodeFileNames?: boolean;
        useWebWorkers?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText(text: string): Uint8Array<ArrayBufferLike>;
        onend(computedSize: number): Promise<void>;
        onprogress(progress: number, total: number): Promise<void>;
        onstart(total: number): Promise<void>;
    }

    Hierarchy (View Summary)

    Properties

    bufferedWrite? comment? -compressionMethod? -creationDate? -dataDescriptor? -dataDescriptorSignature? +compressionMethod? +creationDate? +dataDescriptor? +dataDescriptorSignature? directory? encrypted? -encryptionStrength? -extendedTimestamp? -externalFileAttribute? -extraField? -internalFileAttribute? -keepOrder? -lastAccessDate? -lastModDate? +encryptionStrength? +extendedTimestamp? +externalFileAttribute? +extraField? +internalFileAttribute? +keepOrder? +lastAccessDate? +lastModDate? level? -msDosCompatible? +msDosCompatible? offset? -passThrough? +passThrough? password? -preventClose? -rawPassword? +preventClose? +rawPassword? signal? signature? -supportZip64SplitFile? -uncompressedSize? +supportZip64SplitFile? +uncompressedSize? usdz? -useCompressionStream? -useUnicodeFileNames? -useWebWorkers? +useCompressionStream? +useUnicodeFileNames? +useWebWorkers? version? -versionMadeBy? +versionMadeBy? zip64? -zipCrypto? -

    Methods

    encodeText? +zipCrypto? +

    Methods

    encodeText? onend? onprogress? onstart? -

    Properties

    OptionalbufferedWrite

    bufferedWrite?: boolean

    true to write entry data in a buffer before appending it to the zip file.

    +

    Properties

    OptionalbufferedWrite

    bufferedWrite?: boolean

    true to write entry data in a buffer before appending it to the zip file.

    bufferedWrite is automatically set to true when compressing more than one entry in parallel.

    -

    Default Value

    false
+

    Default Value

    false
    -

    Optionalcomment

    comment?: string

    The comment of the entry.

    -

    OptionalcompressionMethod

    compressionMethod?: number

    The compression method (e.g. 8 for DEFLATE, 0 for STORE).

    -

    OptionalcreationDate

    creationDate?: Date

    The creation date.

    -

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    -

    Default Value

    The current date.
+

    Optionalcomment

    comment?: string

    The comment of the entry.

    +

    OptionalcompressionMethod

    compressionMethod?: number

    The compression method (e.g. 8 for DEFLATE, 0 for STORE).

    +

    OptionalcreationDate

    creationDate?: Date

    The creation date.

    +

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    +

    Default Value

    The current date.
    -

    OptionaldataDescriptor

    dataDescriptor?: boolean

    true to add a data descriptor.

    -

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    -

    Default Value

    true
+

    OptionaldataDescriptor

    dataDescriptor?: boolean

    true to add a data descriptor.

    +

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    +

    Default Value

    true
    -

    OptionaldataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    -

    Default Value

    false
+

    OptionaldataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    +

    Default Value

    false
    -

    Optionaldirectory

    directory?: boolean

    true if the entry is a directory.

    -

    Default Value

    false
+

    Optionaldirectory

    directory?: boolean

    true if the entry is a directory.

    +

    Default Value

    false
    -

    Optionalencrypted

    encrypted?: boolean

    true to write encrypted data when passThrough is set to true.

    -

    OptionalencryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    -

    Default Value

    3
+

    Optionalencrypted

    encrypted?: boolean

    true to write encrypted data when passThrough is set to true.

    +

    OptionalencryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    +

    Default Value

    3
    -

    OptionalextendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    +

    OptionalextendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    When set to false, the maximum last modification date cannot exceed November 31, 2107 and the maximum accuracy is 2 seconds.

    -

    Default Value

    true
+

    Default Value

    true
    -

    OptionalexternalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    -

    Default Value

    0
+

    OptionalexternalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    +

    Default Value

    0
    -

    OptionalextraField

    extraField?: Map<number, Uint8Array>

    The extra field of the entry.

    -

    OptionalinternalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    -

    Default Value

    0
+

    OptionalextraField

    extraField?: Map<number, Uint8Array<ArrayBufferLike>>

    The extra field of the entry.

    +

    OptionalinternalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    +

    Default Value

    0
    -

    OptionalkeepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    +

    OptionalkeepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip64 option to true explicitly. Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.

    -

    Default Value

    true
+

    Default Value

    true
    -

    OptionallastAccessDate

    lastAccessDate?: Date

    The last access date.

    -

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    -

    Default Value

    The current date.
+

    OptionallastAccessDate

    lastAccessDate?: Date

    The last access date.

    +

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    +

    Default Value

    The current date.
    -

    OptionallastModDate

    lastModDate?: Date

    The last modification date.

    -

    Default Value

    The current date.
+

    OptionallastModDate

    lastModDate?: Date

    The last modification date.

    +

    Default Value

    The current date.
    -

    Optionallevel

    level?: number

    The level of compression.

    +

    Optionallevel

    level?: number

    The level of compression.

    The minimum value is 0 and means that no compression is applied. The maximum value is 9.

    -

    Default Value

    5
+

    Default Value

    5
    -

    OptionalmsDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    -

    Default Value

    true
+

    OptionalmsDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    +

    Default Value

    true
    -

    Optionaloffset

    offset?: number

    The offset of the first entry in the zip file.

    -

    OptionalpassThrough

    passThrough?: boolean

    true to write the data as-is without compressing it and without crypting it.

    -

    Optionalpassword

    password?: string

    The password used to encrypt the content of the entry.

    -

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    -

    Default Value

    false
+

    Optionaloffset

    offset?: number

    The offset of the first entry in the zip file.

    +

    OptionalpassThrough

    passThrough?: boolean

    true to write the data as-is without compressing it and without crypting it.

    +

    Optionalpassword

    password?: string

    The password used to encrypt the content of the entry.

    +

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    +

    Default Value

    false
    -

    OptionalrawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    -

    Optionalsignature

    signature?: number

    The signature (CRC32 checksum) of the content. This option is ignored if the ZipWriterConstructorOptions#passThrough option is not set to true.

    -

    OptionalsupportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    -

    Default Value

    true
+

    OptionalrawPassword

    rawPassword?: Uint8Array<ArrayBufferLike>

    The password used to encrypt the content of the entry (raw).

    +

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    +

    Optionalsignature

    signature?: number

    The signature (CRC32 checksum) of the content. This option is ignored if the ZipWriterConstructorOptions#passThrough option is not set to true.

    +

    OptionalsupportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    +

    Default Value

    true
    -

    OptionaluncompressedSize

    uncompressedSize?: number

    The uncompressed size of the entry. This option is ignored if the ZipWriterConstructorOptions#passThrough option is not set to true.

    -

    Optionalusdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    -

    Default Value

    false
+

    OptionaluncompressedSize

    uncompressedSize?: number

    The uncompressed size of the entry. This option is ignored if the ZipWriterConstructorOptions#passThrough option is not set to true.

    +

    Optionalusdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    +

    Default Value

    false
    -

    OptionaluseCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    -

    Default Value

    true
+

    OptionaluseCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    +

    Default Value

    true
    -

    OptionaluseUnicodeFileNames

    useUnicodeFileNames?: boolean

    true to mark the file names as UTF-8 setting the general purpose bit 11 in the header (see Appendix D - Language Encoding (EFS)), false to mark the names as compliant with the original IBM Code Page 437.

    +

    OptionaluseUnicodeFileNames

    useUnicodeFileNames?: boolean

    true to mark the file names as UTF-8 setting the general purpose bit 11 in the header (see Appendix D - Language Encoding (EFS)), false to mark the names as compliant with the original IBM Code Page 437.

    Note that this does not ensure that the file names are in the correct encoding.

    -

    Default Value

    true
+

    Default Value

    true
    -

    OptionaluseWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    -

    Default Value

    true
+

    OptionaluseWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Default Value

    true
    -

    Optionalversion

    version?: number

    The "Version" field.

    -

    OptionalversionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    -

    Default Value

    20
+

    Optionalversion

    version?: number

    The "Version" field.

    +

    OptionalversionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    +

    Default Value

    20
    -

    Optionalzip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    +

    Optionalzip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    zip64 is automatically set to true when necessary (e.g. compressed data larger than 4GB or with unknown size).

    -

    Default Value

    false
+

    Default Value

    false
    -

    OptionalzipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    +

    OptionalzipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    It is not recommended to set zipCrypto to true because the ZipCrypto encryption can be easily broken.

    -

    Default Value

    false
+

    Default Value

    false
    -

    Methods

    OptionalencodeText

    Methods

    OptionalencodeText

    • encodeText(text: string): Uint8Array<ArrayBufferLike>

    • Encode the filename and the comment of the entry.

      Parameters

      • text: string

        The text to encode.

        -

      Returns Uint8Array

      The encoded text or undefined if the text should be encoded by zip.js.

      -

    Optionalonend

    • onend(computedSize): Promise<void>

    • The function called when ending compression/decompression.

      +

    Returns Uint8Array<ArrayBufferLike>

    The encoded text or undefined if the text should be encoded by zip.js.

    +

    Optionalonend

    • onend(computedSize: number): Promise<void>

    • The function called when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optionalonprogress

    Optionalonprogress

    • onprogress(progress: number, total: number): Promise<void>

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optionalonstart

    Optionalonstart

    • onstart(total: number): Promise<void>

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/api/interfaces/ZipWriterCloseOptions.html b/api/interfaces/ZipWriterCloseOptions.html index bf46ecb5..afde3b1c 100644 --- a/api/interfaces/ZipWriterCloseOptions.html +++ b/api/interfaces/ZipWriterCloseOptions.html @@ -1,18 +1,18 @@ -ZipWriterCloseOptions | @zip.js/zip.js

    Interface ZipWriterCloseOptions

    Represents the options passed to ZipWriter#close.

    -
    interface ZipWriterCloseOptions {
        preventClose?: boolean;
        zip64?: boolean;
        onprogress?(progress: number, total: number, entry: EntryMetaData): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    preventClose? +ZipWriterCloseOptions | @zip.js/zip.js

    Interface ZipWriterCloseOptions

    Represents the options passed to ZipWriter#close.

    +
    interface ZipWriterCloseOptions {
        preventClose?: boolean;
        zip64?: boolean;
        onprogress(
            progress: number,
            total: number,
            entry: EntryMetaData,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Properties

    preventClose? zip64?

    Methods

    onprogress? -

    Properties

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    -

    Default Value

    false
+

    Properties

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    +

    Default Value

    false
    -

    Optionalzip64

    zip64?: boolean

    true to use Zip64 to write the entries directory.

    -

    Default Value

    false
+

    Optionalzip64

    zip64?: boolean

    true to use Zip64 to write the entries directory.

    +

    Default Value

    false
    -

    Methods

    Optionalonprogress

    • onprogress(progress, total, entry): Promise<void>

    • The function called each time an entry is read/written.

      +

    Methods

    Optionalonprogress

    • onprogress(progress: number, total: number, entry: EntryMetaData): Promise<void>

    • The function called each time an entry is read/written.

      Parameters

      • progress: number

        The entry index.

      • total: number

        The total number of entries.

      • entry: EntryMetaData

        The entry being read/written.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/api/interfaces/ZipWriterConstructorOptions.html b/api/interfaces/ZipWriterConstructorOptions.html index 51326e0d..fff6dccc 100644 --- a/api/interfaces/ZipWriterConstructorOptions.html +++ b/api/interfaces/ZipWriterConstructorOptions.html @@ -1,133 +1,133 @@ -ZipWriterConstructorOptions | @zip.js/zip.js

    Interface ZipWriterConstructorOptions

    Represents options passed to the constructor of ZipWriter, ZipWriter#add and {@link ZipDirectoryEntry}#export*.

    -
    interface ZipWriterConstructorOptions {
        bufferedWrite?: boolean;
        compressionMethod?: number;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        encrypted?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        msDosCompatible?: boolean;
        offset?: number;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        useUnicodeFileNames?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText?(text: string): Uint8Array;
    }

    Hierarchy (view full)

    Properties

    bufferedWrite? -compressionMethod? -creationDate? -dataDescriptor? -dataDescriptorSignature? +ZipWriterConstructorOptions | @zip.js/zip.js

    Interface ZipWriterConstructorOptions

    Represents options passed to the constructor of ZipWriter, ZipWriter#add and {@link ZipDirectoryEntry}#export*.

    +
    interface ZipWriterConstructorOptions {
        bufferedWrite?: boolean;
        compressionMethod?: number;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        encrypted?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        msDosCompatible?: boolean;
        offset?: number;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array<ArrayBufferLike>;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        useUnicodeFileNames?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText(text: string): Uint8Array<ArrayBufferLike>;
    }

    Hierarchy (View Summary)

    Properties

    bufferedWrite? +compressionMethod? +creationDate? +dataDescriptor? +dataDescriptorSignature? encrypted? -encryptionStrength? -extendedTimestamp? -externalFileAttribute? -internalFileAttribute? -keepOrder? -lastAccessDate? -lastModDate? +encryptionStrength? +extendedTimestamp? +externalFileAttribute? +internalFileAttribute? +keepOrder? +lastAccessDate? +lastModDate? level? -msDosCompatible? +msDosCompatible? offset? -passThrough? +passThrough? password? -preventClose? -rawPassword? +preventClose? +rawPassword? signal? -supportZip64SplitFile? +supportZip64SplitFile? usdz? -useUnicodeFileNames? +useUnicodeFileNames? version? -versionMadeBy? +versionMadeBy? zip64? -zipCrypto? -

    Methods

    encodeText? -

    Properties

    OptionalbufferedWrite

    bufferedWrite?: boolean

    true to write entry data in a buffer before appending it to the zip file.

    +zipCrypto? +

    Methods

    encodeText? +

    Properties

    OptionalbufferedWrite

    bufferedWrite?: boolean

    true to write entry data in a buffer before appending it to the zip file.

    bufferedWrite is automatically set to true when compressing more than one entry in parallel.

    -

    Default Value

    false
+

    Default Value

    false
    -

    OptionalcompressionMethod

    compressionMethod?: number

    The compression method (e.g. 8 for DEFLATE, 0 for STORE).

    -

    OptionalcreationDate

    creationDate?: Date

    The creation date.

    -

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    -

    Default Value

    The current date.
+

    OptionalcompressionMethod

    compressionMethod?: number

    The compression method (e.g. 8 for DEFLATE, 0 for STORE).

    +

    OptionalcreationDate

    creationDate?: Date

    The creation date.

    +

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    +

    Default Value

    The current date.
    -

    OptionaldataDescriptor

    dataDescriptor?: boolean

    true to add a data descriptor.

    -

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    -

    Default Value

    true
+

    OptionaldataDescriptor

    dataDescriptor?: boolean

    true to add a data descriptor.

    +

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    +

    Default Value

    true
    -

    OptionaldataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    -

    Default Value

    false
+

    OptionaldataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    +

    Default Value

    false
    -

    Optionalencrypted

    encrypted?: boolean

    true to write encrypted data when passThrough is set to true.

    -

    OptionalencryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    -

    Default Value

    3
+

    Optionalencrypted

    encrypted?: boolean

    true to write encrypted data when passThrough is set to true.

    +

    OptionalencryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    +

    Default Value

    3
    -

    OptionalextendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    +

    OptionalextendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    When set to false, the maximum last modification date cannot exceed November 31, 2107 and the maximum accuracy is 2 seconds.

    -

    Default Value

    true
+

    Default Value

    true
    -

    OptionalexternalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    -

    Default Value

    0
+

    OptionalexternalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    +

    Default Value

    0
    -

    OptionalinternalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    -

    Default Value

    0
+

    OptionalinternalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    +

    Default Value

    0
    -

    OptionalkeepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    +

    OptionalkeepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip64 option to true explicitly. Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.

    -

    Default Value

    true
+

    Default Value

    true
    -

    OptionallastAccessDate

    lastAccessDate?: Date

    The last access date.

    -

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    -

    Default Value

    The current date.
+

    OptionallastAccessDate

    lastAccessDate?: Date

    The last access date.

    +

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    +

    Default Value

    The current date.
    -

    OptionallastModDate

    lastModDate?: Date

    The last modification date.

    -

    Default Value

    The current date.
+

    OptionallastModDate

    lastModDate?: Date

    The last modification date.

    +

    Default Value

    The current date.
    -

    Optionallevel

    level?: number

    The level of compression.

    +

    Optionallevel

    level?: number

    The level of compression.

    The minimum value is 0 and means that no compression is applied. The maximum value is 9.

    -

    Default Value

    5
+

    Default Value

    5
    -

    OptionalmsDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    -

    Default Value

    true
+

    OptionalmsDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    +

    Default Value

    true
    -

    Optionaloffset

    offset?: number

    The offset of the first entry in the zip file.

    -

    OptionalpassThrough

    passThrough?: boolean

    true to write the data as-is without compressing it and without crypting it.

    -

    Optionalpassword

    password?: string

    The password used to encrypt the content of the entry.

    -

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    -

    Default Value

    false
+

    Optionaloffset

    offset?: number

    The offset of the first entry in the zip file.

    +

    OptionalpassThrough

    passThrough?: boolean

    true to write the data as-is without compressing it and without crypting it.

    +

    Optionalpassword

    password?: string

    The password used to encrypt the content of the entry.

    +

    OptionalpreventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    +

    Default Value

    false
    -

    OptionalrawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    -

    OptionalsupportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    -

    Default Value

    true
+

    OptionalrawPassword

    rawPassword?: Uint8Array<ArrayBufferLike>

    The password used to encrypt the content of the entry (raw).

    +

    Optionalsignal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    +

    OptionalsupportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    +

    Default Value

    true
    -

    Optionalusdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    -

    Default Value

    false
+

    Optionalusdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    +

    Default Value

    false
    -

    OptionaluseUnicodeFileNames

    useUnicodeFileNames?: boolean

    true to mark the file names as UTF-8 setting the general purpose bit 11 in the header (see Appendix D - Language Encoding (EFS)), false to mark the names as compliant with the original IBM Code Page 437.

    +

    OptionaluseUnicodeFileNames

    useUnicodeFileNames?: boolean

    true to mark the file names as UTF-8 setting the general purpose bit 11 in the header (see Appendix D - Language Encoding (EFS)), false to mark the names as compliant with the original IBM Code Page 437.

    Note that this does not ensure that the file names are in the correct encoding.

    -

    Default Value

    true
+

    Default Value

    true
    -

    Optionalversion

    version?: number

    The "Version" field.

    -

    OptionalversionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    -

    Default Value

    20
+

    Optionalversion

    version?: number

    The "Version" field.

    +

    OptionalversionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    +

    Default Value

    20
    -

    Optionalzip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    +

    Optionalzip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    zip64 is automatically set to true when necessary (e.g. compressed data larger than 4GB or with unknown size).

    -

    Default Value

    false
+

    Default Value

    false
    -

    OptionalzipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    +

    OptionalzipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    It is not recommended to set zipCrypto to true because the ZipCrypto encryption can be easily broken.

    -

    Default Value

    false
+

    Default Value

    false
    -

    Methods

    OptionalencodeText

    • encodeText(text): Uint8Array

    • Encode the filename and the comment of the entry.

      +

    Methods

    OptionalencodeText

    • encodeText(text: string): Uint8Array<ArrayBufferLike>

    • Encode the filename and the comment of the entry.

      Parameters

      • text: string

        The text to encode.

        -

      Returns Uint8Array

      The encoded text or undefined if the text should be encoded by zip.js.

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Returns Uint8Array<ArrayBufferLike>

    The encoded text or undefined if the text should be encoded by zip.js.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/api/interfaces/dataHandler.html b/api/interfaces/dataHandler.html index 5abc3640..a89c5d5e 100644 --- a/api/interfaces/dataHandler.html +++ b/api/interfaces/dataHandler.html @@ -1,3 +1,3 @@ -dataHandler | @zip.js/zip.js

    Interface dataHandler

    Represents the callback function used to handle data events.

    -
    • dataHandler(data): void

    • Parameters

      • data: Uint8Array

        The processed chunk of data.

        -

      Returns void

    Settings

    Member Visibility
    +dataHandler | @zip.js/zip.js

    Interface dataHandler

    Represents the callback function used to handle data events.

    +
    • dataHandler(data: Uint8Array<ArrayBufferLike>): void

    • Parameters

      • data: Uint8Array<ArrayBufferLike>

        The processed chunk of data.

        +

      Returns void

    Settings

    Member Visibility
    diff --git a/api/interfaces/registerDataHandler.html b/api/interfaces/registerDataHandler.html index 8f256f5c..5b6535b3 100644 --- a/api/interfaces/registerDataHandler.html +++ b/api/interfaces/registerDataHandler.html @@ -1,4 +1,4 @@ -registerDataHandler | @zip.js/zip.js

    Interface registerDataHandler

    Represents the callback function used to register the data event handler.

    -
    • registerDataHandler(codec, onData): void

    • Parameters

      • codec: EventBasedCodec

        The third-party codec instance.

        +registerDataHandler | @zip.js/zip.js

        Interface registerDataHandler

        Represents the callback function used to register the data event handler.

        +

        Settings

        Member Visibility
        +

      Returns void

    Settings

    Member Visibility
    diff --git a/api/modules.html b/api/modules.html index e6801fbb..647e2f3d 100644 --- a/api/modules.html +++ b/api/modules.html @@ -1,89 +1 @@ -@zip.js/zip.js

    @zip.js/zip.js

    Index

    Classes

    BlobReader -BlobWriter -CodecStream -Data64URIReader -Data64URIWriter -EventBasedCodec -FS -HttpRangeReader -HttpReader -Reader -SplitDataReader -SplitDataWriter -SplitZipReader -SplitZipWriter -SyncCodec -TextReader -TextWriter -TransformStreamLike -Uint8ArrayReader -Uint8ArrayWriter -Writer -ZipDeflate -ZipDirectoryEntry -ZipEntry -ZipFileEntry -ZipInflate -ZipReader -ZipReaderStream -ZipWriter -ZipWriterStream -

    Interfaces

    Configuration -dataHandler -Entry -EntryDataOnprogressOptions -EntryGetDataCheckPasswordOptions -EntryGetDataOptions -EntryMetaData -EntryOnprogressOptions -EventBasedZipLibrary -FileSystemEntryLike -FileSystemHandleLike -GetEntriesOptions -HttpOptions -HttpRangeOptions -Initializable -ReadableReader -registerDataHandler -URLString -WorkerConfiguration -WritableWriter -ZipDirectoryEntryExportOptions -ZipDirectoryEntryImportHttpOptions -ZipLibrary -ZipReaderConstructorOptions -ZipReaderGetEntriesOptions -ZipReaderOptions -ZipWriterAddDataOptions -ZipWriterCloseOptions -ZipWriterConstructorOptions -

    Variables

    ERR_BAD_FORMAT -ERR_CENTRAL_DIRECTORY_NOT_FOUND -ERR_DUPLICATED_NAME -ERR_ENCRYPTED -ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND -ERR_EOCDR_NOT_FOUND -ERR_EXTRAFIELD_ZIP64_NOT_FOUND -ERR_HTTP_RANGE -ERR_INVALID_COMMENT -ERR_INVALID_ENCRYPTION_STRENGTH -ERR_INVALID_ENTRY_COMMENT -ERR_INVALID_ENTRY_NAME -ERR_INVALID_EXTRAFIELD_DATA -ERR_INVALID_EXTRAFIELD_TYPE -ERR_INVALID_PASSWORD -ERR_INVALID_SIGNATURE -ERR_INVALID_VERSION -ERR_ITERATOR_COMPLETED_TOO_SOON -ERR_LOCAL_FILE_HEADER_NOT_FOUND -ERR_SPLIT_ZIP_FILE -ERR_UNDEFINED_UNCOMPRESSED_SIZE -ERR_UNSUPPORTED_COMPRESSION -ERR_UNSUPPORTED_ENCRYPTION -ERR_UNSUPPORTED_FORMAT -fs -

    Functions

    configure -getMimeType -initShimAsyncCodec -terminateWorkers -

    Settings

    Member Visibility
    +@zip.js/zip.js

    @zip.js/zip.js

    Classes

    BlobReader
    BlobWriter
    CodecStream
    Data64URIReader
    Data64URIWriter
    EventBasedCodec
    FS
    HttpRangeReader
    HttpReader
    Reader
    SplitDataReader
    SplitDataWriter
    SplitZipReader
    SplitZipWriter
    SyncCodec
    TextReader
    TextWriter
    TransformStreamLike
    Uint8ArrayReader
    Uint8ArrayWriter
    Writer
    ZipDeflate
    ZipDirectoryEntry
    ZipEntry
    ZipFileEntry
    ZipInflate
    ZipReader
    ZipReaderStream
    ZipWriter
    ZipWriterStream

    Interfaces

    Configuration
    dataHandler
    Entry
    EntryDataOnprogressOptions
    EntryGetDataCheckPasswordOptions
    EntryGetDataOptions
    EntryMetaData
    EntryOnprogressOptions
    EventBasedZipLibrary
    FileSystemEntryLike
    FileSystemHandleLike
    GetEntriesOptions
    HttpOptions
    HttpRangeOptions
    Initializable
    ReadableReader
    registerDataHandler
    URLString
    WorkerConfiguration
    WritableWriter
    ZipDirectoryEntryExportOptions
    ZipDirectoryEntryImportHttpOptions
    ZipLibrary
    ZipReaderConstructorOptions
    ZipReaderGetEntriesOptions
    ZipReaderOptions
    ZipWriterAddDataOptions
    ZipWriterCloseOptions
    ZipWriterConstructorOptions

    Variables

    ERR_BAD_FORMAT
    ERR_CENTRAL_DIRECTORY_NOT_FOUND
    ERR_DUPLICATED_NAME
    ERR_ENCRYPTED
    ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND
    ERR_EOCDR_NOT_FOUND
    ERR_EXTRAFIELD_ZIP64_NOT_FOUND
    ERR_HTTP_RANGE
    ERR_INVALID_COMMENT
    ERR_INVALID_ENCRYPTION_STRENGTH
    ERR_INVALID_ENTRY_COMMENT
    ERR_INVALID_ENTRY_NAME
    ERR_INVALID_EXTRAFIELD_DATA
    ERR_INVALID_EXTRAFIELD_TYPE
    ERR_INVALID_PASSWORD
    ERR_INVALID_SIGNATURE
    ERR_INVALID_VERSION
    ERR_ITERATOR_COMPLETED_TOO_SOON
    ERR_LOCAL_FILE_HEADER_NOT_FOUND
    ERR_SPLIT_ZIP_FILE
    ERR_UNDEFINED_UNCOMPRESSED_SIZE
    ERR_UNSUPPORTED_COMPRESSION
    ERR_UNSUPPORTED_ENCRYPTION
    ERR_UNSUPPORTED_FORMAT
    fs

    Functions

    configure
    getMimeType
    initShimAsyncCodec
    terminateWorkers

    Settings

    Member Visibility

    On This Page

    Classes
    Interfaces
    Variables
    Functions
    diff --git a/api/variables/ERR_BAD_FORMAT.html b/api/variables/ERR_BAD_FORMAT.html index f8e841cf..1dc7e308 100644 --- a/api/variables/ERR_BAD_FORMAT.html +++ b/api/variables/ERR_BAD_FORMAT.html @@ -1,2 +1,2 @@ -ERR_BAD_FORMAT | @zip.js/zip.js

    Variable ERR_BAD_FORMATConst

    ERR_BAD_FORMAT: string

    Zip format error

    -

    Settings

    Member Visibility
    +ERR_BAD_FORMAT | @zip.js/zip.js

    Variable ERR_BAD_FORMATConst

    ERR_BAD_FORMAT: string

    Zip format error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_CENTRAL_DIRECTORY_NOT_FOUND.html b/api/variables/ERR_CENTRAL_DIRECTORY_NOT_FOUND.html index 6d58b16a..a2fd471d 100644 --- a/api/variables/ERR_CENTRAL_DIRECTORY_NOT_FOUND.html +++ b/api/variables/ERR_CENTRAL_DIRECTORY_NOT_FOUND.html @@ -1,2 +1,2 @@ -ERR_CENTRAL_DIRECTORY_NOT_FOUND | @zip.js/zip.js

    Variable ERR_CENTRAL_DIRECTORY_NOT_FOUNDConst

    ERR_CENTRAL_DIRECTORY_NOT_FOUND: string

    Central Directory not found error

    -

    Settings

    Member Visibility
    +ERR_CENTRAL_DIRECTORY_NOT_FOUND | @zip.js/zip.js

    Variable ERR_CENTRAL_DIRECTORY_NOT_FOUNDConst

    ERR_CENTRAL_DIRECTORY_NOT_FOUND: string

    Central Directory not found error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_DUPLICATED_NAME.html b/api/variables/ERR_DUPLICATED_NAME.html index eaf433f1..42e4b021 100644 --- a/api/variables/ERR_DUPLICATED_NAME.html +++ b/api/variables/ERR_DUPLICATED_NAME.html @@ -1,2 +1,2 @@ -ERR_DUPLICATED_NAME | @zip.js/zip.js

    Variable ERR_DUPLICATED_NAMEConst

    ERR_DUPLICATED_NAME: string

    Duplicate entry error

    -

    Settings

    Member Visibility
    +ERR_DUPLICATED_NAME | @zip.js/zip.js

    Variable ERR_DUPLICATED_NAMEConst

    ERR_DUPLICATED_NAME: string

    Duplicate entry error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_ENCRYPTED.html b/api/variables/ERR_ENCRYPTED.html index 1e4fda15..1158f554 100644 --- a/api/variables/ERR_ENCRYPTED.html +++ b/api/variables/ERR_ENCRYPTED.html @@ -1,2 +1,2 @@ -ERR_ENCRYPTED | @zip.js/zip.js

    Variable ERR_ENCRYPTEDConst

    ERR_ENCRYPTED: string

    Encrypted entry error

    -

    Settings

    Member Visibility
    +ERR_ENCRYPTED | @zip.js/zip.js

    Variable ERR_ENCRYPTEDConst

    ERR_ENCRYPTED: string

    Encrypted entry error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND.html b/api/variables/ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND.html index d43e86c7..62a1e200 100644 --- a/api/variables/ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND.html +++ b/api/variables/ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND.html @@ -1,2 +1,2 @@ -ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND | @zip.js/zip.js

    Variable ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUNDConst

    ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND: string

    Zip64 End of Central Directory Locator not found error

    -

    Settings

    Member Visibility
    +ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND | @zip.js/zip.js

    Variable ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUNDConst

    ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND: string

    Zip64 End of Central Directory Locator not found error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_EOCDR_NOT_FOUND.html b/api/variables/ERR_EOCDR_NOT_FOUND.html index 477e0829..aba046d8 100644 --- a/api/variables/ERR_EOCDR_NOT_FOUND.html +++ b/api/variables/ERR_EOCDR_NOT_FOUND.html @@ -1,2 +1,2 @@ -ERR_EOCDR_NOT_FOUND | @zip.js/zip.js

    Variable ERR_EOCDR_NOT_FOUNDConst

    ERR_EOCDR_NOT_FOUND: string

    End of Central Directory Record not found error

    -

    Settings

    Member Visibility
    +ERR_EOCDR_NOT_FOUND | @zip.js/zip.js

    Variable ERR_EOCDR_NOT_FOUNDConst

    ERR_EOCDR_NOT_FOUND: string

    End of Central Directory Record not found error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_EXTRAFIELD_ZIP64_NOT_FOUND.html b/api/variables/ERR_EXTRAFIELD_ZIP64_NOT_FOUND.html index 28c8237a..ff5460ce 100644 --- a/api/variables/ERR_EXTRAFIELD_ZIP64_NOT_FOUND.html +++ b/api/variables/ERR_EXTRAFIELD_ZIP64_NOT_FOUND.html @@ -1,2 +1,2 @@ -ERR_EXTRAFIELD_ZIP64_NOT_FOUND | @zip.js/zip.js

    Variable ERR_EXTRAFIELD_ZIP64_NOT_FOUNDConst

    ERR_EXTRAFIELD_ZIP64_NOT_FOUND: string

    Extra field Zip64 not found error

    -

    Settings

    Member Visibility
    +ERR_EXTRAFIELD_ZIP64_NOT_FOUND | @zip.js/zip.js

    Variable ERR_EXTRAFIELD_ZIP64_NOT_FOUNDConst

    ERR_EXTRAFIELD_ZIP64_NOT_FOUND: string

    Extra field Zip64 not found error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_HTTP_RANGE.html b/api/variables/ERR_HTTP_RANGE.html index 031e611d..84cf4f99 100644 --- a/api/variables/ERR_HTTP_RANGE.html +++ b/api/variables/ERR_HTTP_RANGE.html @@ -1,2 +1,2 @@ -ERR_HTTP_RANGE | @zip.js/zip.js

    Variable ERR_HTTP_RANGEConst

    ERR_HTTP_RANGE: string

    HTTP range error

    -

    Settings

    Member Visibility
    +ERR_HTTP_RANGE | @zip.js/zip.js

    Variable ERR_HTTP_RANGEConst

    ERR_HTTP_RANGE: string

    HTTP range error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_INVALID_COMMENT.html b/api/variables/ERR_INVALID_COMMENT.html index 74341bd0..7349d0f3 100644 --- a/api/variables/ERR_INVALID_COMMENT.html +++ b/api/variables/ERR_INVALID_COMMENT.html @@ -1,2 +1,2 @@ -ERR_INVALID_COMMENT | @zip.js/zip.js

    Variable ERR_INVALID_COMMENTConst

    ERR_INVALID_COMMENT: string

    Invalid comment error

    -

    Settings

    Member Visibility
    +ERR_INVALID_COMMENT | @zip.js/zip.js

    Variable ERR_INVALID_COMMENTConst

    ERR_INVALID_COMMENT: string

    Invalid comment error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_INVALID_ENCRYPTION_STRENGTH.html b/api/variables/ERR_INVALID_ENCRYPTION_STRENGTH.html index 833b28c9..7fe4a30b 100644 --- a/api/variables/ERR_INVALID_ENCRYPTION_STRENGTH.html +++ b/api/variables/ERR_INVALID_ENCRYPTION_STRENGTH.html @@ -1,2 +1,2 @@ -ERR_INVALID_ENCRYPTION_STRENGTH | @zip.js/zip.js

    Variable ERR_INVALID_ENCRYPTION_STRENGTHConst

    ERR_INVALID_ENCRYPTION_STRENGTH: string

    Invalid encryption strength error

    -

    Settings

    Member Visibility
    +ERR_INVALID_ENCRYPTION_STRENGTH | @zip.js/zip.js

    Variable ERR_INVALID_ENCRYPTION_STRENGTHConst

    ERR_INVALID_ENCRYPTION_STRENGTH: string

    Invalid encryption strength error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_INVALID_ENTRY_COMMENT.html b/api/variables/ERR_INVALID_ENTRY_COMMENT.html index a9fa0736..44a79599 100644 --- a/api/variables/ERR_INVALID_ENTRY_COMMENT.html +++ b/api/variables/ERR_INVALID_ENTRY_COMMENT.html @@ -1,2 +1,2 @@ -ERR_INVALID_ENTRY_COMMENT | @zip.js/zip.js

    Variable ERR_INVALID_ENTRY_COMMENTConst

    ERR_INVALID_ENTRY_COMMENT: string

    Invalid entry comment error

    -

    Settings

    Member Visibility
    +ERR_INVALID_ENTRY_COMMENT | @zip.js/zip.js

    Variable ERR_INVALID_ENTRY_COMMENTConst

    ERR_INVALID_ENTRY_COMMENT: string

    Invalid entry comment error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_INVALID_ENTRY_NAME.html b/api/variables/ERR_INVALID_ENTRY_NAME.html index cdb1d23c..8c0ea9d4 100644 --- a/api/variables/ERR_INVALID_ENTRY_NAME.html +++ b/api/variables/ERR_INVALID_ENTRY_NAME.html @@ -1,2 +1,2 @@ -ERR_INVALID_ENTRY_NAME | @zip.js/zip.js

    Variable ERR_INVALID_ENTRY_NAMEConst

    ERR_INVALID_ENTRY_NAME: string

    Invalid entry name error

    -

    Settings

    Member Visibility
    +ERR_INVALID_ENTRY_NAME | @zip.js/zip.js

    Variable ERR_INVALID_ENTRY_NAMEConst

    ERR_INVALID_ENTRY_NAME: string

    Invalid entry name error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_INVALID_EXTRAFIELD_DATA.html b/api/variables/ERR_INVALID_EXTRAFIELD_DATA.html index f05860ad..03793a50 100644 --- a/api/variables/ERR_INVALID_EXTRAFIELD_DATA.html +++ b/api/variables/ERR_INVALID_EXTRAFIELD_DATA.html @@ -1,2 +1,2 @@ -ERR_INVALID_EXTRAFIELD_DATA | @zip.js/zip.js

    Variable ERR_INVALID_EXTRAFIELD_DATAConst

    ERR_INVALID_EXTRAFIELD_DATA: string

    Invalid extra field data error

    -

    Settings

    Member Visibility
    +ERR_INVALID_EXTRAFIELD_DATA | @zip.js/zip.js

    Variable ERR_INVALID_EXTRAFIELD_DATAConst

    ERR_INVALID_EXTRAFIELD_DATA: string

    Invalid extra field data error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_INVALID_EXTRAFIELD_TYPE.html b/api/variables/ERR_INVALID_EXTRAFIELD_TYPE.html index edff6dc9..31e90b83 100644 --- a/api/variables/ERR_INVALID_EXTRAFIELD_TYPE.html +++ b/api/variables/ERR_INVALID_EXTRAFIELD_TYPE.html @@ -1,2 +1,2 @@ -ERR_INVALID_EXTRAFIELD_TYPE | @zip.js/zip.js

    Variable ERR_INVALID_EXTRAFIELD_TYPEConst

    ERR_INVALID_EXTRAFIELD_TYPE: string

    Invalid extra field type error

    -

    Settings

    Member Visibility
    +ERR_INVALID_EXTRAFIELD_TYPE | @zip.js/zip.js

    Variable ERR_INVALID_EXTRAFIELD_TYPEConst

    ERR_INVALID_EXTRAFIELD_TYPE: string

    Invalid extra field type error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_INVALID_PASSWORD.html b/api/variables/ERR_INVALID_PASSWORD.html index 4098fb9f..05da22aa 100644 --- a/api/variables/ERR_INVALID_PASSWORD.html +++ b/api/variables/ERR_INVALID_PASSWORD.html @@ -1,2 +1,2 @@ -ERR_INVALID_PASSWORD | @zip.js/zip.js

    Variable ERR_INVALID_PASSWORDConst

    ERR_INVALID_PASSWORD: string

    Invalid password error

    -

    Settings

    Member Visibility
    +ERR_INVALID_PASSWORD | @zip.js/zip.js

    Variable ERR_INVALID_PASSWORDConst

    ERR_INVALID_PASSWORD: string

    Invalid password error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_INVALID_SIGNATURE.html b/api/variables/ERR_INVALID_SIGNATURE.html index e5385b01..40a176ec 100644 --- a/api/variables/ERR_INVALID_SIGNATURE.html +++ b/api/variables/ERR_INVALID_SIGNATURE.html @@ -1,2 +1,2 @@ -ERR_INVALID_SIGNATURE | @zip.js/zip.js

    Variable ERR_INVALID_SIGNATUREConst

    ERR_INVALID_SIGNATURE: string

    Invalid signature error

    -

    Settings

    Member Visibility
    +ERR_INVALID_SIGNATURE | @zip.js/zip.js

    Variable ERR_INVALID_SIGNATUREConst

    ERR_INVALID_SIGNATURE: string

    Invalid signature error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_INVALID_VERSION.html b/api/variables/ERR_INVALID_VERSION.html index 6f4d696e..483917e3 100644 --- a/api/variables/ERR_INVALID_VERSION.html +++ b/api/variables/ERR_INVALID_VERSION.html @@ -1,2 +1,2 @@ -ERR_INVALID_VERSION | @zip.js/zip.js

    Variable ERR_INVALID_VERSIONConst

    ERR_INVALID_VERSION: string

    Invalid version error

    -

    Settings

    Member Visibility
    +ERR_INVALID_VERSION | @zip.js/zip.js

    Variable ERR_INVALID_VERSIONConst

    ERR_INVALID_VERSION: string

    Invalid version error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_ITERATOR_COMPLETED_TOO_SOON.html b/api/variables/ERR_ITERATOR_COMPLETED_TOO_SOON.html index 77efaaaa..8aa1223c 100644 --- a/api/variables/ERR_ITERATOR_COMPLETED_TOO_SOON.html +++ b/api/variables/ERR_ITERATOR_COMPLETED_TOO_SOON.html @@ -1,2 +1,2 @@ -ERR_ITERATOR_COMPLETED_TOO_SOON | @zip.js/zip.js

    Variable ERR_ITERATOR_COMPLETED_TOO_SOONConst

    ERR_ITERATOR_COMPLETED_TOO_SOON: string

    Iteration completed too soon error

    -

    Settings

    Member Visibility
    +ERR_ITERATOR_COMPLETED_TOO_SOON | @zip.js/zip.js

    Variable ERR_ITERATOR_COMPLETED_TOO_SOONConst

    ERR_ITERATOR_COMPLETED_TOO_SOON: string

    Iteration completed too soon error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_LOCAL_FILE_HEADER_NOT_FOUND.html b/api/variables/ERR_LOCAL_FILE_HEADER_NOT_FOUND.html index 6331496d..66821f84 100644 --- a/api/variables/ERR_LOCAL_FILE_HEADER_NOT_FOUND.html +++ b/api/variables/ERR_LOCAL_FILE_HEADER_NOT_FOUND.html @@ -1,2 +1,2 @@ -ERR_LOCAL_FILE_HEADER_NOT_FOUND | @zip.js/zip.js

    Variable ERR_LOCAL_FILE_HEADER_NOT_FOUNDConst

    ERR_LOCAL_FILE_HEADER_NOT_FOUND: string

    Local file header not found error

    -

    Settings

    Member Visibility
    +ERR_LOCAL_FILE_HEADER_NOT_FOUND | @zip.js/zip.js

    Variable ERR_LOCAL_FILE_HEADER_NOT_FOUNDConst

    ERR_LOCAL_FILE_HEADER_NOT_FOUND: string

    Local file header not found error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_SPLIT_ZIP_FILE.html b/api/variables/ERR_SPLIT_ZIP_FILE.html index b95ffce4..f3da7750 100644 --- a/api/variables/ERR_SPLIT_ZIP_FILE.html +++ b/api/variables/ERR_SPLIT_ZIP_FILE.html @@ -1,2 +1,2 @@ -ERR_SPLIT_ZIP_FILE | @zip.js/zip.js

    Variable ERR_SPLIT_ZIP_FILEConst

    ERR_SPLIT_ZIP_FILE: string

    Split zip file error

    -

    Settings

    Member Visibility
    +ERR_SPLIT_ZIP_FILE | @zip.js/zip.js

    Variable ERR_SPLIT_ZIP_FILEConst

    ERR_SPLIT_ZIP_FILE: string

    Split zip file error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_UNDEFINED_UNCOMPRESSED_SIZE.html b/api/variables/ERR_UNDEFINED_UNCOMPRESSED_SIZE.html index 4043aabd..d58b8993 100644 --- a/api/variables/ERR_UNDEFINED_UNCOMPRESSED_SIZE.html +++ b/api/variables/ERR_UNDEFINED_UNCOMPRESSED_SIZE.html @@ -1,2 +1,2 @@ -ERR_UNDEFINED_UNCOMPRESSED_SIZE | @zip.js/zip.js

    Variable ERR_UNDEFINED_UNCOMPRESSED_SIZEConst

    ERR_UNDEFINED_UNCOMPRESSED_SIZE: string

    Undefined uncompressed size error

    -

    Settings

    Member Visibility
    +ERR_UNDEFINED_UNCOMPRESSED_SIZE | @zip.js/zip.js

    Variable ERR_UNDEFINED_UNCOMPRESSED_SIZEConst

    ERR_UNDEFINED_UNCOMPRESSED_SIZE: string

    Undefined uncompressed size error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_UNSUPPORTED_COMPRESSION.html b/api/variables/ERR_UNSUPPORTED_COMPRESSION.html index a923db87..b2b89470 100644 --- a/api/variables/ERR_UNSUPPORTED_COMPRESSION.html +++ b/api/variables/ERR_UNSUPPORTED_COMPRESSION.html @@ -1,2 +1,2 @@ -ERR_UNSUPPORTED_COMPRESSION | @zip.js/zip.js

    Variable ERR_UNSUPPORTED_COMPRESSIONConst

    ERR_UNSUPPORTED_COMPRESSION: string

    Unsupported compression error

    -

    Settings

    Member Visibility
    +ERR_UNSUPPORTED_COMPRESSION | @zip.js/zip.js

    Variable ERR_UNSUPPORTED_COMPRESSIONConst

    ERR_UNSUPPORTED_COMPRESSION: string

    Unsupported compression error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_UNSUPPORTED_ENCRYPTION.html b/api/variables/ERR_UNSUPPORTED_ENCRYPTION.html index 27e3e347..1ca9c3ea 100644 --- a/api/variables/ERR_UNSUPPORTED_ENCRYPTION.html +++ b/api/variables/ERR_UNSUPPORTED_ENCRYPTION.html @@ -1,2 +1,2 @@ -ERR_UNSUPPORTED_ENCRYPTION | @zip.js/zip.js

    Variable ERR_UNSUPPORTED_ENCRYPTIONConst

    ERR_UNSUPPORTED_ENCRYPTION: string

    Unsupported encryption error

    -

    Settings

    Member Visibility
    +ERR_UNSUPPORTED_ENCRYPTION | @zip.js/zip.js

    Variable ERR_UNSUPPORTED_ENCRYPTIONConst

    ERR_UNSUPPORTED_ENCRYPTION: string

    Unsupported encryption error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/ERR_UNSUPPORTED_FORMAT.html b/api/variables/ERR_UNSUPPORTED_FORMAT.html index 88f77b7c..eb97f77b 100644 --- a/api/variables/ERR_UNSUPPORTED_FORMAT.html +++ b/api/variables/ERR_UNSUPPORTED_FORMAT.html @@ -1,2 +1,2 @@ -ERR_UNSUPPORTED_FORMAT | @zip.js/zip.js

    Variable ERR_UNSUPPORTED_FORMATConst

    ERR_UNSUPPORTED_FORMAT: string

    Invalid format error

    -

    Settings

    Member Visibility
    +ERR_UNSUPPORTED_FORMAT | @zip.js/zip.js

    Variable ERR_UNSUPPORTED_FORMATConst

    ERR_UNSUPPORTED_FORMAT: string

    Invalid format error

    +

    Settings

    Member Visibility
    diff --git a/api/variables/fs-1.html b/api/variables/fs-1.html index 5fe39aa5..12ffee3f 100644 --- a/api/variables/fs-1.html +++ b/api/variables/fs-1.html @@ -1,8 +1,8 @@ -fs | @zip.js/zip.js

    Variable fsConst

    fs: {
        FS: typeof FS;
        ZipDirectoryEntry: typeof ZipDirectoryEntry;
        ZipFileEntry: typeof ZipFileEntry;
    }

    The Filesystem API.

    -

    Type declaration

    Settings

    Member Visibility
    +fs | @zip.js/zip.js

    Variable fsConst

    fs: {
        FS: typeof FS;
        ZipDirectoryEntry: typeof ZipDirectoryEntry;
        ZipFileEntry: typeof ZipFileEntry;
    }

    The Filesystem API.

    +

    Type declaration

    Settings

    Member Visibility