@xyo-network/archivist 2.57.5 → 2.58.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/CookieArchivist.js +0 -1
- package/dist/cjs/CookieArchivist.js.map +1 -1
- package/dist/cjs/StorageArchivist.js +0 -1
- package/dist/cjs/StorageArchivist.js.map +1 -1
- package/dist/docs.json +92530 -58797
- package/dist/esm/CookieArchivist.js +1 -2
- package/dist/esm/CookieArchivist.js.map +1 -1
- package/dist/esm/StorageArchivist.js +1 -2
- package/dist/esm/StorageArchivist.js.map +1 -1
- package/dist/types/ArchivingModule.d.ts +18 -16
- package/dist/types/ArchivingModule.d.ts.map +1 -1
- package/dist/types/CookieArchivist.d.ts.map +1 -1
- package/dist/types/StorageArchivist.d.ts.map +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/AbstractArchivist.html +139 -98
- package/docs/classes/ArchivingModule.html +118 -75
- package/docs/classes/ArchivistWrapper.html +40 -50
- package/docs/classes/CookieArchivist.html +138 -103
- package/docs/classes/MemoryArchivist.html +132 -90
- package/docs/classes/StorageArchivist.html +143 -108
- package/docs/index.html +0 -5
- package/docs/interfaces/Archivist.html +3 -29
- package/docs/interfaces/ArchivistModuleEventData.html +7 -12
- package/docs/interfaces/ArchivistParents.html +0 -5
- package/docs/interfaces/ReadArchivist.html +0 -5
- package/docs/interfaces/StashArchivist.html +2 -7
- package/docs/interfaces/WriteArchivist.html +0 -5
- package/docs/interfaces/XyoArchivistParentWrappers.html +3 -8
- package/docs/modules.html +0 -10
- package/docs/types/ArchivingModuleConfig.html +1 -6
- package/docs/types/ArchivistAllQuery.html +0 -5
- package/docs/types/ArchivistAllQuerySchema.html +0 -5
- package/docs/types/ArchivistClearQuery.html +0 -5
- package/docs/types/ArchivistClearQuerySchema.html +0 -5
- package/docs/types/ArchivistCommitQuery.html +0 -5
- package/docs/types/ArchivistCommitQuerySchema.html +0 -5
- package/docs/types/ArchivistConfig.html +0 -5
- package/docs/types/ArchivistConfigSchema.html +0 -5
- package/docs/types/ArchivistDeleteQuery.html +0 -5
- package/docs/types/ArchivistDeleteQuerySchema.html +0 -5
- package/docs/types/ArchivistGetQuery.html +0 -5
- package/docs/types/ArchivistGetQuerySchema.html +0 -5
- package/docs/types/ArchivistInsertQuery.html +0 -5
- package/docs/types/ArchivistInsertQuerySchema.html +0 -5
- package/docs/types/ArchivistModule.html +2 -7
- package/docs/types/ArchivistModuleQueries.html +1 -6
- package/docs/types/ArchivistParams.html +1 -6
- package/docs/types/ArchivistQuery.html +1 -6
- package/docs/types/ArchivistQueryBase.html +2 -7
- package/docs/types/ArchivistQueryRoot.html +1 -6
- package/docs/types/CookieArchivistConfig.html +1 -6
- package/docs/types/CookieArchivistConfigSchema.html +2 -7
- package/docs/types/CookieArchivistParams.html +1 -6
- package/docs/types/MemoryArchivistConfig.html +0 -5
- package/docs/types/MemoryArchivistConfigSchema.html +0 -5
- package/docs/types/MemoryArchivistParams.html +0 -5
- package/docs/types/StorageArchivistConfig.html +1 -6
- package/docs/types/StorageArchivistConfigSchema.html +2 -7
- package/docs/types/StorageArchivistParams.html +1 -6
- package/docs/variables/ArchivistAllQuerySchema-1.html +0 -5
- package/docs/variables/ArchivistClearQuerySchema-1.html +0 -5
- package/docs/variables/ArchivistCommitQuerySchema-1.html +0 -5
- package/docs/variables/ArchivistConfigSchema-1.html +0 -5
- package/docs/variables/ArchivistDeleteQuerySchema-1.html +0 -5
- package/docs/variables/ArchivistGetQuerySchema-1.html +0 -5
- package/docs/variables/ArchivistInsertQuerySchema-1.html +0 -5
- package/docs/variables/CookieArchivistConfigSchema-1.html +2 -7
- package/docs/variables/MemoryArchivistConfigSchema-1.html +0 -5
- package/docs/variables/StorageArchivistConfigSchema-1.html +2 -7
- package/package.json +20 -20
- package/src/CookieArchivist.ts +0 -2
- package/src/StorageArchivist.ts +0 -2
- package/docs/interfaces/FindArchivist.html +0 -141
- package/docs/types/ArchivistFindQuery.html +0 -98
- package/docs/types/ArchivistFindQuerySchema.html +0 -99
- package/docs/types/PayloadArchivist.html +0 -101
- package/docs/variables/ArchivistFindQuerySchema-1.html +0 -99
package/docs/index.html
CHANGED
|
@@ -55,7 +55,6 @@
|
|
|
55
55
|
<li><a href="interfaces/Archivist.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Archivist</span></a></li>
|
|
56
56
|
<li><a href="interfaces/ArchivistModuleEventData.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Archivist<wbr/>Module<wbr/>Event<wbr/>Data</span></a></li>
|
|
57
57
|
<li><a href="interfaces/ArchivistParents.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Archivist<wbr/>Parents</span></a></li>
|
|
58
|
-
<li><a href="interfaces/FindArchivist.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Find<wbr/>Archivist</span></a></li>
|
|
59
58
|
<li><a href="interfaces/ReadArchivist.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Read<wbr/>Archivist</span></a></li>
|
|
60
59
|
<li><a href="interfaces/StashArchivist.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Stash<wbr/>Archivist</span></a></li>
|
|
61
60
|
<li><a href="interfaces/WriteArchivist.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Write<wbr/>Archivist</span></a></li>
|
|
@@ -71,8 +70,6 @@
|
|
|
71
70
|
<li><a href="types/ArchivistConfigSchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|
|
72
71
|
<li><a href="types/ArchivistDeleteQuery.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Delete<wbr/>Query</span></a></li>
|
|
73
72
|
<li><a href="types/ArchivistDeleteQuerySchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Delete<wbr/>Query<wbr/>Schema</span></a></li>
|
|
74
|
-
<li><a href="types/ArchivistFindQuery.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Find<wbr/>Query</span></a></li>
|
|
75
|
-
<li><a href="types/ArchivistFindQuerySchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Find<wbr/>Query<wbr/>Schema</span></a></li>
|
|
76
73
|
<li><a href="types/ArchivistGetQuery.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Get<wbr/>Query</span></a></li>
|
|
77
74
|
<li><a href="types/ArchivistGetQuerySchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Get<wbr/>Query<wbr/>Schema</span></a></li>
|
|
78
75
|
<li><a href="types/ArchivistInsertQuery.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Insert<wbr/>Query</span></a></li>
|
|
@@ -89,7 +86,6 @@
|
|
|
89
86
|
<li><a href="types/MemoryArchivistConfig.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Memory<wbr/>Archivist<wbr/>Config</span></a></li>
|
|
90
87
|
<li><a href="types/MemoryArchivistConfigSchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Memory<wbr/>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|
|
91
88
|
<li><a href="types/MemoryArchivistParams.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Memory<wbr/>Archivist<wbr/>Params</span></a></li>
|
|
92
|
-
<li><a href="types/PayloadArchivist.html" class="deprecated"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Payload<wbr/>Archivist</span></a></li>
|
|
93
89
|
<li><a href="types/StorageArchivistConfig.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Storage<wbr/>Archivist<wbr/>Config</span></a></li>
|
|
94
90
|
<li><a href="types/StorageArchivistConfigSchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Storage<wbr/>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|
|
95
91
|
<li><a href="types/StorageArchivistParams.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Storage<wbr/>Archivist<wbr/>Params</span></a></li>
|
|
@@ -98,7 +94,6 @@
|
|
|
98
94
|
<li><a href="variables/ArchivistCommitQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Commit<wbr/>Query<wbr/>Schema</span></a></li>
|
|
99
95
|
<li><a href="variables/ArchivistConfigSchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|
|
100
96
|
<li><a href="variables/ArchivistDeleteQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Delete<wbr/>Query<wbr/>Schema</span></a></li>
|
|
101
|
-
<li><a href="variables/ArchivistFindQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Find<wbr/>Query<wbr/>Schema</span></a></li>
|
|
102
97
|
<li><a href="variables/ArchivistGetQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Get<wbr/>Query<wbr/>Schema</span></a></li>
|
|
103
98
|
<li><a href="variables/ArchivistInsertQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Insert<wbr/>Query<wbr/>Schema</span></a></li>
|
|
104
99
|
<li><a href="variables/CookieArchivistConfigSchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Cookie<wbr/>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<ul class="tsd-breadcrumb">
|
|
15
15
|
<li><a href="../modules.html">@xyo-network/archivist</a></li>
|
|
16
16
|
<li><a href="Archivist.html">Archivist</a></li></ul>
|
|
17
|
-
<h1>Interface Archivist<TReadResponse, TWriteResponse, TWrite,
|
|
17
|
+
<h1>Interface Archivist<TReadResponse, TWriteResponse, TWrite, TId></h1></div>
|
|
18
18
|
<section class="tsd-panel">
|
|
19
19
|
<h4>Type Parameters</h4>
|
|
20
20
|
<ul class="tsd-type-parameter-list">
|
|
@@ -25,22 +25,17 @@
|
|
|
25
25
|
<li>
|
|
26
26
|
<h4><span class="tsd-kind-type-parameter">TWrite</span> = <span class="tsd-signature-type tsd-kind-type-parameter">TReadResponse</span></h4></li>
|
|
27
27
|
<li>
|
|
28
|
-
<h4><span class="tsd-kind-type-parameter">TFindResponse</span> = <span class="tsd-signature-type tsd-kind-type-parameter">TReadResponse</span></h4></li>
|
|
29
|
-
<li>
|
|
30
|
-
<h4><span class="tsd-kind-type-parameter">TFindFilter</span> = <span class="tsd-signature-type ">PayloadFindFilter</span></h4></li>
|
|
31
|
-
<li>
|
|
32
28
|
<h4><span class="tsd-kind-type-parameter">TId</span> = <span class="tsd-signature-type">string</span></h4></li></ul></section>
|
|
33
29
|
<section class="tsd-panel tsd-hierarchy">
|
|
34
30
|
<h4>Hierarchy</h4>
|
|
35
31
|
<ul class="tsd-hierarchy">
|
|
36
32
|
<li><a href="ReadArchivist.html" class="tsd-signature-type tsd-kind-interface">ReadArchivist</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TReadResponse</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TId</span><span class="tsd-signature-symbol">></span></li>
|
|
37
|
-
<li><a href="FindArchivist.html" class="tsd-signature-type tsd-kind-interface">FindArchivist</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TReadResponse</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TFindResponse</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TFindFilter</span><span class="tsd-signature-symbol">></span></li>
|
|
38
33
|
<li><a href="WriteArchivist.html" class="tsd-signature-type tsd-kind-interface">WriteArchivist</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TReadResponse</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TWriteResponse</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TWrite</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">TId</span><span class="tsd-signature-symbol">></span></li>
|
|
39
34
|
<li><a href="StashArchivist.html" class="tsd-signature-type tsd-kind-interface">StashArchivist</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TWriteResponse</span><span class="tsd-signature-symbol">></span>
|
|
40
35
|
<ul class="tsd-hierarchy">
|
|
41
36
|
<li><span class="target">Archivist</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
42
37
|
<ul>
|
|
43
|
-
<li>Defined in modules/packages/archivist/packages/model/dist/types/Archivist.d.ts:
|
|
38
|
+
<li>Defined in modules/packages/archivist/packages/model/dist/types/Archivist.d.ts:21</li></ul></aside>
|
|
44
39
|
<section class="tsd-panel-group tsd-index-group">
|
|
45
40
|
<section class="tsd-panel tsd-index-panel">
|
|
46
41
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -52,7 +47,6 @@
|
|
|
52
47
|
<a href="Archivist.html#clear" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clear?</span></a>
|
|
53
48
|
<a href="Archivist.html#commit" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>commit?</span></a>
|
|
54
49
|
<a href="Archivist.html#delete" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete?</span></a>
|
|
55
|
-
<a href="Archivist.html#find" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>find</span></a>
|
|
56
50
|
<a href="Archivist.html#get" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get</span></a>
|
|
57
51
|
<a href="Archivist.html#insert" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>insert</span></a>
|
|
58
52
|
</div></section></div></details></section></section>
|
|
@@ -84,7 +78,7 @@
|
|
|
84
78
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promisable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TWriteResponse</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
85
79
|
<p>Inherited from <a href="StashArchivist.html">StashArchivist</a>.<a href="StashArchivist.html#commit">commit</a></p>
|
|
86
80
|
<ul>
|
|
87
|
-
<li>Defined in modules/packages/archivist/packages/model/dist/types/Archivist.d.ts:
|
|
81
|
+
<li>Defined in modules/packages/archivist/packages/model/dist/types/Archivist.d.ts:18</li></ul></aside></li></ul></section>
|
|
88
82
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="delete" class="tsd-anchor"></a>
|
|
89
83
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
90
84
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -99,20 +93,6 @@
|
|
|
99
93
|
<p>Inherited from <a href="WriteArchivist.html">WriteArchivist</a>.<a href="WriteArchivist.html#delete">delete</a></p>
|
|
100
94
|
<ul>
|
|
101
95
|
<li>Defined in modules/packages/archivist/packages/model/dist/types/Archivist.d.ts:14</li></ul></aside></li></ul></section>
|
|
102
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="find" class="tsd-anchor"></a>
|
|
103
|
-
<h3 class="tsd-anchor-link"><span>find</span><a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
104
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
105
|
-
<li class="tsd-signature tsd-anchor-link" id="find.find-1"><span class="tsd-kind-call-signature">find</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">PromisableArray</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TFindResponse</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span><a href="#find.find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
106
|
-
<li class="tsd-description">
|
|
107
|
-
<div class="tsd-parameters">
|
|
108
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
109
|
-
<ul class="tsd-parameter-list">
|
|
110
|
-
<li>
|
|
111
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">filter</span>: <span class="tsd-signature-type tsd-kind-type-parameter">TFindFilter</span></h5></li></ul></div>
|
|
112
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">PromisableArray</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">TFindResponse</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
113
|
-
<p>Inherited from <a href="FindArchivist.html">FindArchivist</a>.<a href="FindArchivist.html#find">find</a></p>
|
|
114
|
-
<ul>
|
|
115
|
-
<li>Defined in modules/packages/archivist/packages/model/dist/types/Archivist.d.ts:18</li></ul></aside></li></ul></section>
|
|
116
96
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="get" class="tsd-anchor"></a>
|
|
117
97
|
<h3 class="tsd-anchor-link"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
118
98
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
@@ -163,7 +143,6 @@
|
|
|
163
143
|
<li><a href="#clear" class="tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clear</span></a></li>
|
|
164
144
|
<li><a href="#commit" class="tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>commit</span></a></li>
|
|
165
145
|
<li><a href="#delete" class="tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete</span></a></li>
|
|
166
|
-
<li><a href="#find" class="tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>find</span></a></li>
|
|
167
146
|
<li><a href="#get" class="tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get</span></a></li>
|
|
168
147
|
<li><a href="#insert" class="tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>insert</span></a></li></ul></div></details></div>
|
|
169
148
|
<div class="site-menu">
|
|
@@ -178,7 +157,6 @@
|
|
|
178
157
|
<li><a href="Archivist.html" class="current"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Archivist</span></a></li>
|
|
179
158
|
<li><a href="ArchivistModuleEventData.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Archivist<wbr/>Module<wbr/>Event<wbr/>Data</span></a></li>
|
|
180
159
|
<li><a href="ArchivistParents.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Archivist<wbr/>Parents</span></a></li>
|
|
181
|
-
<li><a href="FindArchivist.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Find<wbr/>Archivist</span></a></li>
|
|
182
160
|
<li><a href="ReadArchivist.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Read<wbr/>Archivist</span></a></li>
|
|
183
161
|
<li><a href="StashArchivist.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Stash<wbr/>Archivist</span></a></li>
|
|
184
162
|
<li><a href="WriteArchivist.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Write<wbr/>Archivist</span></a></li>
|
|
@@ -194,8 +172,6 @@
|
|
|
194
172
|
<li><a href="../types/ArchivistConfigSchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|
|
195
173
|
<li><a href="../types/ArchivistDeleteQuery.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Delete<wbr/>Query</span></a></li>
|
|
196
174
|
<li><a href="../types/ArchivistDeleteQuerySchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Delete<wbr/>Query<wbr/>Schema</span></a></li>
|
|
197
|
-
<li><a href="../types/ArchivistFindQuery.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Find<wbr/>Query</span></a></li>
|
|
198
|
-
<li><a href="../types/ArchivistFindQuerySchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Find<wbr/>Query<wbr/>Schema</span></a></li>
|
|
199
175
|
<li><a href="../types/ArchivistGetQuery.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Get<wbr/>Query</span></a></li>
|
|
200
176
|
<li><a href="../types/ArchivistGetQuerySchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Get<wbr/>Query<wbr/>Schema</span></a></li>
|
|
201
177
|
<li><a href="../types/ArchivistInsertQuery.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Archivist<wbr/>Insert<wbr/>Query</span></a></li>
|
|
@@ -212,7 +188,6 @@
|
|
|
212
188
|
<li><a href="../types/MemoryArchivistConfig.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Memory<wbr/>Archivist<wbr/>Config</span></a></li>
|
|
213
189
|
<li><a href="../types/MemoryArchivistConfigSchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Memory<wbr/>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|
|
214
190
|
<li><a href="../types/MemoryArchivistParams.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Memory<wbr/>Archivist<wbr/>Params</span></a></li>
|
|
215
|
-
<li><a href="../types/PayloadArchivist.html" class="deprecated"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Payload<wbr/>Archivist</span></a></li>
|
|
216
191
|
<li><a href="../types/StorageArchivistConfig.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Storage<wbr/>Archivist<wbr/>Config</span></a></li>
|
|
217
192
|
<li><a href="../types/StorageArchivistConfigSchema.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Storage<wbr/>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|
|
218
193
|
<li><a href="../types/StorageArchivistParams.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Storage<wbr/>Archivist<wbr/>Params</span></a></li>
|
|
@@ -221,7 +196,6 @@
|
|
|
221
196
|
<li><a href="../variables/ArchivistCommitQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Commit<wbr/>Query<wbr/>Schema</span></a></li>
|
|
222
197
|
<li><a href="../variables/ArchivistConfigSchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|
|
223
198
|
<li><a href="../variables/ArchivistDeleteQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Delete<wbr/>Query<wbr/>Schema</span></a></li>
|
|
224
|
-
<li><a href="../variables/ArchivistFindQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Find<wbr/>Query<wbr/>Schema</span></a></li>
|
|
225
199
|
<li><a href="../variables/ArchivistGetQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Get<wbr/>Query<wbr/>Schema</span></a></li>
|
|
226
200
|
<li><a href="../variables/ArchivistInsertQuerySchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Archivist<wbr/>Insert<wbr/>Query<wbr/>Schema</span></a></li>
|
|
227
201
|
<li><a href="../variables/CookieArchivistConfigSchema-1.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Cookie<wbr/>Archivist<wbr/>Config<wbr/>Schema</span></a></li>
|