Skip to content

Commit 1aa7177

Browse files
committed
docs: generating docs
[ci skip]
1 parent 5f74972 commit 1aa7177

File tree

1,571 files changed

+20982
-3268
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,571 files changed

+20982
-3268
lines changed

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/ErrorPolykey.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
328328
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>polykey</span></a>
329329
<ul class="tsd-small-nested-navigation">
330330
<li><a href="../modules/acl.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>acl</span></a></li>
331+
<li><a href="../modules/audit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>audit</span></a></li>
331332
<li><a href="../modules/bootstrap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>bootstrap</span></a></li>
332333
<li><a href="../modules/claims.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>claims</span></a></li>
333334
<li><a href="../modules/client.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>client</span></a></li>
@@ -378,7 +379,8 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
378379
<li><a href="../types/RecordKeyFromValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Record<wbr/>Key<wbr/>From<wbr/>Value</span></a></li>
379380
<li><a href="../types/Ref.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ref</span></a></li>
380381
<li><a href="../types/Timer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Timer</span></a></li>
381-
<li><a href="../variables/config.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>config</span></a></li></ul></nav></div></div></div>
382+
<li><a href="../variables/brand.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>brand</span></a></li>
383+
<li><a href="../variables/config.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>config</span></a></li></ul></nav></div></div></div>
382384
<div class="tsd-generator">
383385
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
384386
<div class="overlay"></div></body></html>

docs/classes/EventPolykey.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ <h4>Hierarchy</h4>
4343
<li><a href="events.EventNotificationsManager.html" class="tsd-signature-type tsd-kind-class">EventNotificationsManager</a></li>
4444
<li><a href="events.EventSchema.html" class="tsd-signature-type tsd-kind-class">EventSchema</a></li>
4545
<li><a href="events.EventStatus.html" class="tsd-signature-type tsd-kind-class">EventStatus</a></li>
46-
<li><a href="events.EventTasks.html" class="tsd-signature-type tsd-kind-class">EventTasks</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
46+
<li><a href="events.EventTasks.html" class="tsd-signature-type tsd-kind-class">EventTasks</a></li>
47+
<li><a href="audit.events.EventAudit.html" class="tsd-signature-type tsd-kind-class">EventAudit</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
4748
<ul>
4849
<li>Defined in <a href="https://github.com/MatrixAI/Polykey/blob/master/src/EventPolykey.ts#L3">src/EventPolykey.ts:3</a></li></ul></aside>
4950
<section class="tsd-panel-group tsd-index-group">
@@ -464,6 +465,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
464465
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>polykey</span></a>
465466
<ul class="tsd-small-nested-navigation">
466467
<li><a href="../modules/acl.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>acl</span></a></li>
468+
<li><a href="../modules/audit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>audit</span></a></li>
467469
<li><a href="../modules/bootstrap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>bootstrap</span></a></li>
468470
<li><a href="../modules/claims.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>claims</span></a></li>
469471
<li><a href="../modules/client.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>client</span></a></li>
@@ -514,7 +516,8 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
514516
<li><a href="../types/RecordKeyFromValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Record<wbr/>Key<wbr/>From<wbr/>Value</span></a></li>
515517
<li><a href="../types/Ref.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ref</span></a></li>
516518
<li><a href="../types/Timer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Timer</span></a></li>
517-
<li><a href="../variables/config.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>config</span></a></li></ul></nav></div></div></div>
519+
<li><a href="../variables/brand.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>brand</span></a></li>
520+
<li><a href="../variables/config.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>config</span></a></li></ul></nav></div></div></div>
518521
<div class="tsd-generator">
519522
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
520523
<div class="overlay"></div></body></html>

0 commit comments

Comments
 (0)