added Release Workflow

FynniX · Apr 20, 2024 · c720881 · c720881
1 parent 4e7c895
commit c720881
Show file tree

Hide file tree

Showing 50 changed files with 161 additions and 116 deletions.
diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -0,0 +1,45 @@
+name: Release
+
+on:
+  push:
+    tags: ['*']
+
+jobs:
+  prebuild:
+    runs-on: windows-2019
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 8
+
+      - name: Setup environment
+        run: pnpm install
+
+      - name: Prebuild addon
+        run: pnpm run prebuild:build
+
+      - name: Prebuild upload
+        run: pnpm run prebuild:upload
+        env:
+          GITHUB_AUTH_TOKEN: ${{ secrets.GH_TOKEN }}
+
+  publish:
+    runs-on: windows-2019
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 8
+
+      - name: Setup environment
+        run: pnpm install
+
+      - name: Publish package
+        uses: JS-DevTools/npm-publish@v2
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
diff --git a/docs/classes/index.MappedBuffer.html b/docs/classes/index.MappedBuffer.html
diff --git a/docs/classes/utils_BufferReader.BufferReader.html b/docs/classes/utils_BufferReader.BufferReader.html
diff --git a/docs/classes/utils_BufferWriter.BufferWriter.html b/docs/classes/utils_BufferWriter.BufferWriter.html
diff --git a/docs/classes/utils_SchemaReader.SchemaReader.html b/docs/classes/utils_SchemaReader.SchemaReader.html
diff --git a/docs/classes/utils_StructBuilder.StructBuilder.html b/docs/classes/utils_StructBuilder.StructBuilder.html
diff --git a/docs/classes/utils_parser_SchemaLexer.default.html b/docs/classes/utils_parser_SchemaLexer.default.html
diff --git a/docs/classes/utils_parser_SchemaListener.default.html b/docs/classes/utils_parser_SchemaListener.default.html
diff --git a/docs/classes/utils_parser_SchemaParser.ArrayContext.html b/docs/classes/utils_parser_SchemaParser.ArrayContext.html
diff --git a/docs/classes/utils_parser_SchemaParser.DimensionContext.html b/docs/classes/utils_parser_SchemaParser.DimensionContext.html
diff --git a/docs/classes/utils_parser_SchemaParser.PrimitiveTypeContext.html b/docs/classes/utils_parser_SchemaParser.PrimitiveTypeContext.html
diff --git a/docs/classes/utils_parser_SchemaParser.SchemaContext.html b/docs/classes/utils_parser_SchemaParser.SchemaContext.html
diff --git a/docs/classes/utils_parser_SchemaParser.StructContext.html b/docs/classes/utils_parser_SchemaParser.StructContext.html
diff --git a/docs/classes/utils_parser_SchemaParser.TypeContext.html b/docs/classes/utils_parser_SchemaParser.TypeContext.html
diff --git a/docs/classes/utils_parser_SchemaParser.UserTypeContext.html b/docs/classes/utils_parser_SchemaParser.UserTypeContext.html
diff --git a/docs/classes/utils_parser_SchemaParser.default.html b/docs/classes/utils_parser_SchemaParser.default.html
diff --git a/docs/classes/utils_parser_SchemaVisitor.default.html b/docs/classes/utils_parser_SchemaVisitor.default.html
diff --git a/docs/enums/enums_CollectionType.CollectionType.html b/docs/enums/enums_CollectionType.CollectionType.html
diff --git a/docs/enums/enums_DeclarationType.DeclarationType.html b/docs/enums/enums_DeclarationType.DeclarationType.html
diff --git a/docs/enums/enums_Endian.Endian.html b/docs/enums/enums_Endian.Endian.html
diff --git a/docs/enums/enums_PrimitiveType.PrimitiveType.html b/docs/enums/enums_PrimitiveType.PrimitiveType.html
diff --git a/docs/enums/enums_VarType.VarType.html b/docs/enums/enums_VarType.VarType.html
diff --git a/docs/functions/utils_TypeSizes.calculateArraySize.html b/docs/functions/utils_TypeSizes.calculateArraySize.html
@@ -159,7 +159,7 @@
 </style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/FynniX/node-mapped-buffer/">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-mapped-buffer</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">node-mapped-buffer</a></li><li><a href="../modules/utils_TypeSizes.html">utils/TypeSizes</a></li><li><a href="utils_TypeSizes.calculateArraySize.html">calculateArraySize</a></li></ul><h1>Function calculateArraySize</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="calculateArraySize" class="tsd-anchor"></a><span class="tsd-kind-call-signature">calculate<wbr/>Array<wbr/>Size</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arr</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#calculateArraySize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Calculates the size of an array based on the given array collection.</p>
 </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">arr</span>: <a href="../interfaces/interfaces_ArrayCollection.ArrayCollection.html" class="tsd-signature-type tsd-kind-interface">ArrayCollection</a></span><div class="tsd-comment tsd-typography"><p>The array collection to calculate the size of.</p>
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The size of the array.</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/FynniX/node-mapped-buffers/blob/4396595441ff167a76bc5a46e87f8507724ed880/lib/utils/TypeSizes.ts#L62">lib/utils/TypeSizes.ts:62</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>node-mapped-buffer</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/FynniX/node-mapped-buffers/blob/4e7c89526009cd65d37fa4e1d9a1cbc92d563ec9/lib/utils/TypeSizes.ts#L62">lib/utils/TypeSizes.ts:62</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>node-mapped-buffer</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
           try {
             const generateLinkElement = document.querySelector(".tsd-generator a");
             const link = document.createElement("a");