@xyo-network/sdk-js 3.14.16 → 3.14.17

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.
Files changed (738) hide show
  1. package/README.md +9 -84
  2. package/docs/README.md +748 -0
  3. package/docs/classes/AbstractData.md +127 -0
  4. package/docs/classes/AbstractModuleResolver.md +666 -0
  5. package/docs/classes/Account.md +431 -0
  6. package/docs/classes/AddressValue.md +251 -0
  7. package/docs/classes/ArchivistWrapper.md +2073 -0
  8. package/docs/classes/BaseEmitter.md +643 -0
  9. package/docs/classes/BoundWitnessBuilder.md +1387 -0
  10. package/docs/classes/BoundWitnessValidator.md +243 -0
  11. package/docs/classes/BoundWitnessWrapper.md +697 -0
  12. package/docs/classes/BridgeWrapper.md +1807 -0
  13. package/docs/classes/CompositeModuleResolver.md +824 -0
  14. package/docs/classes/Data.md +173 -0
  15. package/docs/classes/DeadModuleError.md +191 -0
  16. package/docs/classes/DivinerWrapper.md +1819 -0
  17. package/docs/classes/EllipticKey.md +180 -0
  18. package/docs/classes/Events.md +743 -0
  19. package/docs/classes/Huri.md +161 -0
  20. package/docs/classes/IsAttachableArchivistInstanceFactory.md +55 -0
  21. package/docs/classes/IsAttachableBridgeInstanceFactory.md +55 -0
  22. package/docs/classes/IsAttachableDivinerInstanceFactory.md +55 -0
  23. package/docs/classes/IsAttachableModuleInstanceFactory.md +55 -0
  24. package/docs/classes/IsAttachableNodeInstanceFactory.md +55 -0
  25. package/docs/classes/IsAttachableSentinelInstanceFactory.md +55 -0
  26. package/docs/classes/IsAttachableWitnessInstanceFactory.md +55 -0
  27. package/docs/classes/IsInstanceFactory.md +55 -0
  28. package/docs/classes/IsModuleFactory.md +43 -0
  29. package/docs/classes/ManifestWrapper.md +689 -0
  30. package/docs/classes/ManifestWrapperEx.md +743 -0
  31. package/docs/classes/ModuleDetailsError.md +179 -0
  32. package/docs/classes/ModuleFactory.md +243 -0
  33. package/docs/classes/ModuleWrapper.md +1559 -0
  34. package/docs/classes/NameRegistrarTransformer.md +53 -0
  35. package/docs/classes/NodeWrapper.md +1983 -0
  36. package/docs/classes/ObjectHasher.md +657 -0
  37. package/docs/classes/PayloadBuilder.md +967 -0
  38. package/docs/classes/PayloadHasher.md +657 -0
  39. package/docs/classes/PayloadValidator.md +121 -0
  40. package/docs/classes/PayloadWrapper.md +462 -0
  41. package/docs/classes/PayloadWrapperBase.md +225 -0
  42. package/docs/classes/PrivateKey.md +265 -0
  43. package/docs/classes/PublicKey.md +261 -0
  44. package/docs/classes/QueryBoundWitnessBuilder.md +1459 -0
  45. package/docs/classes/QueryBoundWitnessWrapper.md +861 -0
  46. package/docs/classes/ResolveHelper.md +217 -0
  47. package/docs/classes/SequenceParser.md +469 -0
  48. package/docs/classes/SimpleModuleResolver.md +779 -0
  49. package/docs/classes/WasmSupport.md +231 -0
  50. package/docs/classes/WitnessWrapper.md +1803 -0
  51. package/docs/functions/constructableModuleWrapper.md +33 -0
  52. package/docs/functions/creatableModule.md +39 -0
  53. package/docs/functions/creatableModuleFactory.md +39 -0
  54. package/docs/functions/isPayloadOfSchemaType.md +33 -0
  55. package/docs/functions/labeledCreatableModuleFactory.md +39 -0
  56. package/docs/interfaces/AddressChildFields.md +41 -0
  57. package/docs/interfaces/AddressFields.md +17 -0
  58. package/docs/interfaces/AddressObjectFilter.md +95 -0
  59. package/docs/interfaces/AddressToWeakInstanceCache.md +45 -0
  60. package/docs/interfaces/AllArchivist.md +35 -0
  61. package/docs/interfaces/AllArchivistFunctions.md +27 -0
  62. package/docs/interfaces/ArchivingModuleConfig.md +21 -0
  63. package/docs/interfaces/ArchivingReentrancyConfig.md +21 -0
  64. package/docs/interfaces/Archivist.md +163 -0
  65. package/docs/interfaces/ArchivistInstance.md +1299 -0
  66. package/docs/interfaces/ArchivistLabels.md +23 -0
  67. package/docs/interfaces/ArchivistModuleEventData.md +157 -0
  68. package/docs/interfaces/ArchivistModuleInstance.md +486 -0
  69. package/docs/interfaces/ArchivistNextOptions.md +57 -0
  70. package/docs/interfaces/ArchivistParamFields.md +13 -0
  71. package/docs/interfaces/ArchivistParentInstances.md +29 -0
  72. package/docs/interfaces/ArchivistParents.md +29 -0
  73. package/docs/interfaces/ArchivistRawQueryFunctions.md +151 -0
  74. package/docs/interfaces/ArchivistStorage.md +15 -0
  75. package/docs/interfaces/AttachableArchivistInstance.md +1331 -0
  76. package/docs/interfaces/AttachableBridgeInstance.md +1141 -0
  77. package/docs/interfaces/AttachableDivinerInstance.md +1085 -0
  78. package/docs/interfaces/AttachableModuleInstance.md +1018 -0
  79. package/docs/interfaces/AttachableNodeInstance.md +1309 -0
  80. package/docs/interfaces/AttachableSentinelInstance.md +1069 -0
  81. package/docs/interfaces/AttachableWitnessInstance.md +1077 -0
  82. package/docs/interfaces/BoundWitnessBlockField.md +17 -0
  83. package/docs/interfaces/BoundWitnessChainField.md +17 -0
  84. package/docs/interfaces/BoundWitnessFields.md +105 -0
  85. package/docs/interfaces/BoundWitnessMeta.md +29 -0
  86. package/docs/interfaces/BoundWitnessOptionalFields.md +49 -0
  87. package/docs/interfaces/BoundWitnessRequiredFields.md +45 -0
  88. package/docs/interfaces/BridgeExposeOptions.md +25 -0
  89. package/docs/interfaces/BridgeInstance.md +1105 -0
  90. package/docs/interfaces/BridgeModule.md +486 -0
  91. package/docs/interfaces/BridgeModuleEventData.md +269 -0
  92. package/docs/interfaces/BridgeParams.md +143 -0
  93. package/docs/interfaces/BridgeQueryFunctions.md +97 -0
  94. package/docs/interfaces/BridgeRawQueryFunctions.md +93 -0
  95. package/docs/interfaces/BridgeUnexposeOptions.md +33 -0
  96. package/docs/interfaces/CacheConfig.md +29 -0
  97. package/docs/interfaces/ChildCertificationFields.md +21 -0
  98. package/docs/interfaces/CompositeModuleResolverParams.md +69 -0
  99. package/docs/interfaces/ConfigManifest.md +61 -0
  100. package/docs/interfaces/CreatableModule.md +139 -0
  101. package/docs/interfaces/CreatableModuleRegistry.md +9 -0
  102. package/docs/interfaces/CustomSentinelInstance.md +1033 -0
  103. package/docs/interfaces/CustomSentinelModule.md +485 -0
  104. package/docs/interfaces/DataHashStorageMeta.md +17 -0
  105. package/docs/interfaces/DataInstance.md +37 -0
  106. package/docs/interfaces/DivineEndEventData.md +55 -0
  107. package/docs/interfaces/DivineStartEventData.md +43 -0
  108. package/docs/interfaces/DivinerInstance.md +1053 -0
  109. package/docs/interfaces/DivinerModule.md +485 -0
  110. package/docs/interfaces/DivinerQueryFunctions.md +67 -0
  111. package/docs/interfaces/EventFunctions.md +235 -0
  112. package/docs/interfaces/ExposedEventData.md +43 -0
  113. package/docs/interfaces/FetchedPayload.md +27 -0
  114. package/docs/interfaces/FullArchivist.md +147 -0
  115. package/docs/interfaces/HashStorageMeta.md +33 -0
  116. package/docs/interfaces/HuriOptions.md +21 -0
  117. package/docs/interfaces/JobEndEventData.md +47 -0
  118. package/docs/interfaces/JobStartEventData.md +43 -0
  119. package/docs/interfaces/Labels.md +15 -0
  120. package/docs/interfaces/Manifest.md +18 -0
  121. package/docs/interfaces/ManifestWrapperExParams.md +45 -0
  122. package/docs/interfaces/Module.md +492 -0
  123. package/docs/interfaces/ModuleAttachedEventData.md +29 -0
  124. package/docs/interfaces/ModuleBusyEventData.md +43 -0
  125. package/docs/interfaces/ModuleConfigFields.md +130 -0
  126. package/docs/interfaces/ModuleDescription.md +37 -0
  127. package/docs/interfaces/ModuleDetachedEventData.md +29 -0
  128. package/docs/interfaces/ModuleErrorEventData.md +43 -0
  129. package/docs/interfaces/ModuleEventData.md +106 -0
  130. package/docs/interfaces/ModuleFactoryLocatorInstance.md +159 -0
  131. package/docs/interfaces/ModuleFamilyFunctions.md +131 -0
  132. package/docs/interfaces/ModuleFields.md +173 -0
  133. package/docs/interfaces/ModuleFilterOptions.md +87 -0
  134. package/docs/interfaces/ModuleIdentifierTransformer.md +13 -0
  135. package/docs/interfaces/ModuleInstance.md +987 -0
  136. package/docs/interfaces/ModuleManifest.md +57 -0
  137. package/docs/interfaces/ModuleNameResolver.md +39 -0
  138. package/docs/interfaces/ModuleQueriedEventData.md +51 -0
  139. package/docs/interfaces/ModuleQueryFunctions.md +99 -0
  140. package/docs/interfaces/ModuleRegisteredEventData.md +29 -0
  141. package/docs/interfaces/ModuleRepository.md +391 -0
  142. package/docs/interfaces/ModuleResolvedEventArgs.md +21 -0
  143. package/docs/interfaces/ModuleResolver.md +243 -0
  144. package/docs/interfaces/ModuleResolverInstance.md +317 -0
  145. package/docs/interfaces/ModuleResolverParams.md +41 -0
  146. package/docs/interfaces/ModuleSecurityConfig.md +41 -0
  147. package/docs/interfaces/ModuleSubscribeFilter.md +17 -0
  148. package/docs/interfaces/ModuleTask.md +55 -0
  149. package/docs/interfaces/ModuleUnregisteredEventData.md +29 -0
  150. package/docs/interfaces/NameObjectFilter.md +95 -0
  151. package/docs/interfaces/NextOptions.md +47 -0
  152. package/docs/interfaces/NodeInstance.md +1277 -0
  153. package/docs/interfaces/NodeManifest.md +85 -0
  154. package/docs/interfaces/NodeManifestPayload.md +93 -0
  155. package/docs/interfaces/NodeModule.md +486 -0
  156. package/docs/interfaces/NodeModuleEventData.md +157 -0
  157. package/docs/interfaces/NodeQueryFunctions.md +197 -0
  158. package/docs/interfaces/NodeRegistrationFunctions.md +57 -0
  159. package/docs/interfaces/ObjectFilterOptions.md +86 -0
  160. package/docs/interfaces/ObjectResolver.md +209 -0
  161. package/docs/interfaces/ObjectResolverInstance.md +275 -0
  162. package/docs/interfaces/ObserveEndEventData.md +55 -0
  163. package/docs/interfaces/ObserveStartEventData.md +43 -0
  164. package/docs/interfaces/PackageManifest.md +37 -0
  165. package/docs/interfaces/PayloadBuilderOptions.md +21 -0
  166. package/docs/interfaces/PayloadFields.md +23 -0
  167. package/docs/interfaces/PayloadFindFilter.md +29 -0
  168. package/docs/interfaces/PayloadMetaFields.md +21 -0
  169. package/docs/interfaces/PayloadSet.md +21 -0
  170. package/docs/interfaces/QueryFields.md +53 -0
  171. package/docs/interfaces/QueryFulfillFinishedEventData.md +55 -0
  172. package/docs/interfaces/QueryFulfillStartedEventData.md +47 -0
  173. package/docs/interfaces/QueryObjectFilter.md +95 -0
  174. package/docs/interfaces/QuerySendFinishedEventData.md +55 -0
  175. package/docs/interfaces/QuerySendStartedEventData.md +47 -0
  176. package/docs/interfaces/ReadArchivist.md +68 -0
  177. package/docs/interfaces/ReadArchivistFunctions.md +55 -0
  178. package/docs/interfaces/ReadWriteArchivist.md +135 -0
  179. package/docs/interfaces/ReportEndEventData.md +51 -0
  180. package/docs/interfaces/ReportStartEventData.md +43 -0
  181. package/docs/interfaces/ResolveHelperConfig.md +69 -0
  182. package/docs/interfaces/ResolveStrategy.md +41 -0
  183. package/docs/interfaces/ResolverEventEmitter.md +27 -0
  184. package/docs/interfaces/SchemaField.md +23 -0
  185. package/docs/interfaces/SchemaFields.md +21 -0
  186. package/docs/interfaces/SearchableStorage.md +37 -0
  187. package/docs/interfaces/Sentinel.md +60 -0
  188. package/docs/interfaces/SentinelInstance.md +1038 -0
  189. package/docs/interfaces/SentinelJob.md +13 -0
  190. package/docs/interfaces/SentinelModule.md +486 -0
  191. package/docs/interfaces/SentinelModuleEventData.md +275 -0
  192. package/docs/interfaces/SequenceStorageMeta.md +17 -0
  193. package/docs/interfaces/SourcesMetaField.md +17 -0
  194. package/docs/interfaces/StashArchivist.md +35 -0
  195. package/docs/interfaces/StashArchivistFunctions.md +28 -0
  196. package/docs/interfaces/State.md +19 -0
  197. package/docs/interfaces/StateDictionary.md +9 -0
  198. package/docs/interfaces/StorageMeta.md +45 -0
  199. package/docs/interfaces/TaskEndEventData.md +55 -0
  200. package/docs/interfaces/TaskStartEventData.md +51 -0
  201. package/docs/interfaces/Timestamp.md +15 -0
  202. package/docs/interfaces/UnexposedEventData.md +43 -0
  203. package/docs/interfaces/WithLabels.md +21 -0
  204. package/docs/interfaces/WithOptionalLabels.md +21 -0
  205. package/docs/interfaces/WitnessInstance.md +1045 -0
  206. package/docs/interfaces/WitnessModule.md +485 -0
  207. package/docs/interfaces/WitnessQueryFunctions.md +59 -0
  208. package/docs/interfaces/WriteArchivist.md +92 -0
  209. package/docs/interfaces/WriteArchivistFunctions.md +75 -0
  210. package/docs/type-aliases/AddressChildPayload.md +7 -0
  211. package/docs/type-aliases/AddressChildSchema.md +7 -0
  212. package/docs/type-aliases/AddressModuleFilter.md +13 -0
  213. package/docs/type-aliases/AddressPayload.md +7 -0
  214. package/docs/type-aliases/AddressPreviousHashPayload.md +7 -0
  215. package/docs/type-aliases/AddressPreviousHashSchema.md +7 -0
  216. package/docs/type-aliases/AddressSchema.md +7 -0
  217. package/docs/type-aliases/AllValidator.md +19 -0
  218. package/docs/type-aliases/AllValidatorFactory.md +17 -0
  219. package/docs/type-aliases/AnyBoundWitness.md +7 -0
  220. package/docs/type-aliases/AnyConfigSchema.md +13 -0
  221. package/docs/type-aliases/AnyModuleConfig.md +7 -0
  222. package/docs/type-aliases/AnyModuleFilter.md +13 -0
  223. package/docs/type-aliases/AnyObjectFilter.md +13 -0
  224. package/docs/type-aliases/AnyPayload.md +7 -0
  225. package/docs/type-aliases/ArchivistAllQuery.md +7 -0
  226. package/docs/type-aliases/ArchivistAllQuerySchema.md +7 -0
  227. package/docs/type-aliases/ArchivistClearQuery.md +7 -0
  228. package/docs/type-aliases/ArchivistClearQuerySchema.md +7 -0
  229. package/docs/type-aliases/ArchivistCommitQuery.md +7 -0
  230. package/docs/type-aliases/ArchivistCommitQuerySchema.md +7 -0
  231. package/docs/type-aliases/ArchivistConfig.md +17 -0
  232. package/docs/type-aliases/ArchivistConfigSchema.md +7 -0
  233. package/docs/type-aliases/ArchivistDeleteQuery.md +7 -0
  234. package/docs/type-aliases/ArchivistDeleteQuerySchema.md +7 -0
  235. package/docs/type-aliases/ArchivistGetQuery.md +7 -0
  236. package/docs/type-aliases/ArchivistGetQuerySchema.md +7 -0
  237. package/docs/type-aliases/ArchivistInsertQuery.md +7 -0
  238. package/docs/type-aliases/ArchivistInsertQuerySchema.md +7 -0
  239. package/docs/type-aliases/ArchivistModuleQueries.md +7 -0
  240. package/docs/type-aliases/ArchivistNextQuery.md +7 -0
  241. package/docs/type-aliases/ArchivistNextQuerySchema.md +7 -0
  242. package/docs/type-aliases/ArchivistParams.md +17 -0
  243. package/docs/type-aliases/ArchivistQueries.md +7 -0
  244. package/docs/type-aliases/ArchivistTask.md +7 -0
  245. package/docs/type-aliases/AsyncPayloadValidationFunction.md +25 -0
  246. package/docs/type-aliases/AttachableArchivistInstanceTypeCheck.md +13 -0
  247. package/docs/type-aliases/AttachableBridgeInstanceTypeCheck.md +13 -0
  248. package/docs/type-aliases/AttachableDivinerInstanceTypeCheck.md +13 -0
  249. package/docs/type-aliases/AttachableModuleInstanceTypeCheck.md +13 -0
  250. package/docs/type-aliases/AttachableNodeInstanceTypeCheck.md +13 -0
  251. package/docs/type-aliases/AttachableSentinelInstanceTypeCheck.md +13 -0
  252. package/docs/type-aliases/AttachableWitnessInstanceTypeCheck.md +13 -0
  253. package/docs/type-aliases/BoundWitness.md +13 -0
  254. package/docs/type-aliases/BoundWitnessSchema.md +7 -0
  255. package/docs/type-aliases/BridgeClientConfig.md +31 -0
  256. package/docs/type-aliases/BridgeConfig.md +25 -0
  257. package/docs/type-aliases/BridgeConfigSchema.md +7 -0
  258. package/docs/type-aliases/BridgeConnectQuery.md +7 -0
  259. package/docs/type-aliases/BridgeConnectQuerySchema.md +7 -0
  260. package/docs/type-aliases/BridgeDisconnectQuery.md +7 -0
  261. package/docs/type-aliases/BridgeDisconnectQuerySchema.md +7 -0
  262. package/docs/type-aliases/BridgeExposeQuery.md +7 -0
  263. package/docs/type-aliases/BridgeExposeQuerySchema.md +7 -0
  264. package/docs/type-aliases/BridgeHostConfig.md +23 -0
  265. package/docs/type-aliases/BridgeModuleQueries.md +7 -0
  266. package/docs/type-aliases/BridgeQueries.md +7 -0
  267. package/docs/type-aliases/BridgeUnexposeQuery.md +7 -0
  268. package/docs/type-aliases/BridgeUnexposeQuerySchema.md +7 -0
  269. package/docs/type-aliases/ChildCertification.md +7 -0
  270. package/docs/type-aliases/ChildCertificationSchema.md +7 -0
  271. package/docs/type-aliases/ColonPair.md +13 -0
  272. package/docs/type-aliases/ConstructableModuleWrapper.md +177 -0
  273. package/docs/type-aliases/CosigningAddressSet.md +7 -0
  274. package/docs/type-aliases/CreatableModuleFactory.md +39 -0
  275. package/docs/type-aliases/CustomWitnessInstance.md +25 -0
  276. package/docs/type-aliases/CustomWitnessModule.md +25 -0
  277. package/docs/type-aliases/DappPackageManifestPayloadSchema.md +7 -0
  278. package/docs/type-aliases/DebugLogger.md +36 -0
  279. package/docs/type-aliases/DebugOptions.md +33 -0
  280. package/docs/type-aliases/Direction.md +7 -0
  281. package/docs/type-aliases/DivineEndEventArgs.md +21 -0
  282. package/docs/type-aliases/DivineStartEventArgs.md +17 -0
  283. package/docs/type-aliases/DivinedPayload.md +17 -0
  284. package/docs/type-aliases/DivinerConfig.md +17 -0
  285. package/docs/type-aliases/DivinerConfigSchema.md +7 -0
  286. package/docs/type-aliases/DivinerDivineQuery.md +7 -0
  287. package/docs/type-aliases/DivinerDivineQuerySchema.md +7 -0
  288. package/docs/type-aliases/DivinerDivineResult.md +13 -0
  289. package/docs/type-aliases/DivinerModuleEventData.md +21 -0
  290. package/docs/type-aliases/DivinerModuleQueries.md +7 -0
  291. package/docs/type-aliases/DivinerParams.md +17 -0
  292. package/docs/type-aliases/DivinerQueries.md +7 -0
  293. package/docs/type-aliases/DivinerTask.md +7 -0
  294. package/docs/type-aliases/Epoch.md +7 -0
  295. package/docs/type-aliases/EventAnyListener.md +27 -0
  296. package/docs/type-aliases/EventArgs.md +7 -0
  297. package/docs/type-aliases/EventData.md +11 -0
  298. package/docs/type-aliases/EventListener.md +23 -0
  299. package/docs/type-aliases/EventListenerInfo.md +29 -0
  300. package/docs/type-aliases/EventName.md +7 -0
  301. package/docs/type-aliases/EventUnsubscribeFunction.md +11 -0
  302. package/docs/type-aliases/EventsParams.md +7 -0
  303. package/docs/type-aliases/ExposedEventArgs.md +13 -0
  304. package/docs/type-aliases/GeneratedBoundWitnessFields.md +7 -0
  305. package/docs/type-aliases/HuriFetchFunction.md +17 -0
  306. package/docs/type-aliases/HydratedBoundWitness.md +17 -0
  307. package/docs/type-aliases/HydratedBoundWitnessWithStorageMeta.md +17 -0
  308. package/docs/type-aliases/IdentityFunction.md +23 -0
  309. package/docs/type-aliases/IndexDescription.md +49 -0
  310. package/docs/type-aliases/IndexDirection.md +9 -0
  311. package/docs/type-aliases/InstanceTypeCheck.md +13 -0
  312. package/docs/type-aliases/JobEndEventArgs.md +13 -0
  313. package/docs/type-aliases/JobStartEventArgs.md +13 -0
  314. package/docs/type-aliases/LabeledCreatableModuleFactory.md +13 -0
  315. package/docs/type-aliases/LocalSequence.md +7 -0
  316. package/docs/type-aliases/MetaEventData.md +45 -0
  317. package/docs/type-aliases/ModuleAddressQuery.md +7 -0
  318. package/docs/type-aliases/ModuleAddressQuerySchema.md +7 -0
  319. package/docs/type-aliases/ModuleAlias.md +7 -0
  320. package/docs/type-aliases/ModuleAttachedEventArgs.md +13 -0
  321. package/docs/type-aliases/ModuleBusyEventArgs.md +13 -0
  322. package/docs/type-aliases/ModuleConfig.md +17 -0
  323. package/docs/type-aliases/ModuleConfigSchema.md +7 -0
  324. package/docs/type-aliases/ModuleDescriptionPayload.md +7 -0
  325. package/docs/type-aliases/ModuleDescriptionSchema.md +7 -0
  326. package/docs/type-aliases/ModuleDetachedEventArgs.md +13 -0
  327. package/docs/type-aliases/ModuleError.md +7 -0
  328. package/docs/type-aliases/ModuleErrorEventArgs.md +13 -0
  329. package/docs/type-aliases/ModuleErrorSchema.md +7 -0
  330. package/docs/type-aliases/ModuleEventArgs.md +17 -0
  331. package/docs/type-aliases/ModuleFilter.md +17 -0
  332. package/docs/type-aliases/ModuleFilterPayload.md +7 -0
  333. package/docs/type-aliases/ModuleFilterPayloadSchema.md +7 -0
  334. package/docs/type-aliases/ModuleIdentifier.md +7 -0
  335. package/docs/type-aliases/ModuleIdentifierPart.md +7 -0
  336. package/docs/type-aliases/ModuleIdentifierTransformerFunc.md +17 -0
  337. package/docs/type-aliases/ModuleLimitationLabelName.md +7 -0
  338. package/docs/type-aliases/ModuleManifestPayload.md +7 -0
  339. package/docs/type-aliases/ModuleManifestPayloadSchema.md +7 -0
  340. package/docs/type-aliases/ModuleManifestQuery.md +7 -0
  341. package/docs/type-aliases/ModuleManifestQuerySchema.md +7 -0
  342. package/docs/type-aliases/ModuleName.md +7 -0
  343. package/docs/type-aliases/ModuleParams.md +17 -0
  344. package/docs/type-aliases/ModulePipeLine.md +7 -0
  345. package/docs/type-aliases/ModuleQueriedEventArgs.md +13 -0
  346. package/docs/type-aliases/ModuleQueries.md +7 -0
  347. package/docs/type-aliases/ModuleQueryHandlerResult.md +7 -0
  348. package/docs/type-aliases/ModuleQueryResult.md +21 -0
  349. package/docs/type-aliases/ModuleRegisteredEventArgs.md +13 -0
  350. package/docs/type-aliases/ModuleResolveDirection.md +7 -0
  351. package/docs/type-aliases/ModuleState.md +13 -0
  352. package/docs/type-aliases/ModuleStateQuery.md +7 -0
  353. package/docs/type-aliases/ModuleStateQuerySchema.md +7 -0
  354. package/docs/type-aliases/ModuleStateSchema.md +7 -0
  355. package/docs/type-aliases/ModuleStatus.md +7 -0
  356. package/docs/type-aliases/ModuleSubscribeQuery.md +7 -0
  357. package/docs/type-aliases/ModuleSubscribeQuerySchema.md +7 -0
  358. package/docs/type-aliases/ModuleTypeCheck.md +13 -0
  359. package/docs/type-aliases/ModuleUnregisteredEventArgs.md +13 -0
  360. package/docs/type-aliases/ModuleWrapperParams.md +13 -0
  361. package/docs/type-aliases/NameModuleFilter.md +13 -0
  362. package/docs/type-aliases/NodeAttachQuery.md +7 -0
  363. package/docs/type-aliases/NodeAttachQuerySchema.md +7 -0
  364. package/docs/type-aliases/NodeAttachedQuery.md +7 -0
  365. package/docs/type-aliases/NodeAttachedQuerySchema.md +7 -0
  366. package/docs/type-aliases/NodeCertifyQuery.md +7 -0
  367. package/docs/type-aliases/NodeCertifyQuerySchema.md +7 -0
  368. package/docs/type-aliases/NodeConfig.md +17 -0
  369. package/docs/type-aliases/NodeConfigSchema.md +7 -0
  370. package/docs/type-aliases/NodeDetachQuery.md +7 -0
  371. package/docs/type-aliases/NodeDetachQuerySchema.md +7 -0
  372. package/docs/type-aliases/NodeManifestPayloadSchema.md +7 -0
  373. package/docs/type-aliases/NodeModuleQueries.md +7 -0
  374. package/docs/type-aliases/NodeParams.md +17 -0
  375. package/docs/type-aliases/NodeQueries.md +7 -0
  376. package/docs/type-aliases/NodeRegisteredQuery.md +7 -0
  377. package/docs/type-aliases/NodeRegisteredQuerySchema.md +7 -0
  378. package/docs/type-aliases/Nonce.md +7 -0
  379. package/docs/type-aliases/ObjectCategory.md +7 -0
  380. package/docs/type-aliases/ObjectFilter.md +13 -0
  381. package/docs/type-aliases/ObjectResolverPriority.md +7 -0
  382. package/docs/type-aliases/ObserveEndEventArgs.md +21 -0
  383. package/docs/type-aliases/ObserveStartEventArgs.md +17 -0
  384. package/docs/type-aliases/OptionalConfigSchema.md +19 -0
  385. package/docs/type-aliases/OverridablePayload.md +13 -0
  386. package/docs/type-aliases/PackageManifestPayload.md +7 -0
  387. package/docs/type-aliases/PackageManifestPayloadSchema.md +7 -0
  388. package/docs/type-aliases/Payload.md +19 -0
  389. package/docs/type-aliases/PayloadLoader.md +17 -0
  390. package/docs/type-aliases/PayloadLoaderFactory.md +11 -0
  391. package/docs/type-aliases/PayloadProperty.md +15 -0
  392. package/docs/type-aliases/PayloadSchema.md +7 -0
  393. package/docs/type-aliases/PayloadSetPayload.md +7 -0
  394. package/docs/type-aliases/PayloadSetSchema.md +7 -0
  395. package/docs/type-aliases/PayloadValidationFunction.md +15 -0
  396. package/docs/type-aliases/PayloadValue.md +19 -0
  397. package/docs/type-aliases/PayloadValueExpression.md +33 -0
  398. package/docs/type-aliases/PayloadWithOptionalSources.md +21 -0
  399. package/docs/type-aliases/PayloadWithSources.md +17 -0
  400. package/docs/type-aliases/QualifiedSequence.md +7 -0
  401. package/docs/type-aliases/Query.md +17 -0
  402. package/docs/type-aliases/QueryBoundWitness.md +7 -0
  403. package/docs/type-aliases/QueryBoundWitnessFields.md +23 -0
  404. package/docs/type-aliases/QueryFulfillFinishedEventArgs.md +13 -0
  405. package/docs/type-aliases/QueryFulfillStartedEventArgs.md +13 -0
  406. package/docs/type-aliases/QueryModuleFilter.md +13 -0
  407. package/docs/type-aliases/QuerySendFinishedEventArgs.md +13 -0
  408. package/docs/type-aliases/QuerySendStartedEventArgs.md +13 -0
  409. package/docs/type-aliases/ReportEndEventArgs.md +13 -0
  410. package/docs/type-aliases/ReportStartEventArgs.md +13 -0
  411. package/docs/type-aliases/ReservedModuleIdentifierCharacter.md +7 -0
  412. package/docs/type-aliases/ResolvedArchivistTask.md +7 -0
  413. package/docs/type-aliases/ResolvedDivinerTask.md +7 -0
  414. package/docs/type-aliases/ResolvedModuleTask.md +27 -0
  415. package/docs/type-aliases/ResolvedTask.md +7 -0
  416. package/docs/type-aliases/ResolvedWitnessTask.md +7 -0
  417. package/docs/type-aliases/Schema.md +9 -0
  418. package/docs/type-aliases/SentinelAutomationPayload.md +9 -0
  419. package/docs/type-aliases/SentinelAutomationSchema.md +7 -0
  420. package/docs/type-aliases/SentinelBaseAutomationPayload.md +13 -0
  421. package/docs/type-aliases/SentinelConfig.md +17 -0
  422. package/docs/type-aliases/SentinelConfigSchema.md +7 -0
  423. package/docs/type-aliases/SentinelEventAutomationPayload.md +9 -0
  424. package/docs/type-aliases/SentinelEventAutomationSchema.md +7 -0
  425. package/docs/type-aliases/SentinelIntervalAutomationPayload.md +9 -0
  426. package/docs/type-aliases/SentinelIntervalAutomationSchema.md +7 -0
  427. package/docs/type-aliases/SentinelModuleQueries.md +7 -0
  428. package/docs/type-aliases/SentinelParams.md +17 -0
  429. package/docs/type-aliases/SentinelQueries.md +7 -0
  430. package/docs/type-aliases/SentinelReportQuery.md +7 -0
  431. package/docs/type-aliases/SentinelReportQuerySchema.md +7 -0
  432. package/docs/type-aliases/Sequence.md +7 -0
  433. package/docs/type-aliases/Signed.md +19 -0
  434. package/docs/type-aliases/SignedBoundWitness.md +7 -0
  435. package/docs/type-aliases/SignedHydratedBoundWitness.md +17 -0
  436. package/docs/type-aliases/SignedHydratedBoundWitnessWithStorageMeta.md +17 -0
  437. package/docs/type-aliases/SimpleModuleResolverParams.md +13 -0
  438. package/docs/type-aliases/SyncPayloadValidationFunction.md +25 -0
  439. package/docs/type-aliases/Task.md +7 -0
  440. package/docs/type-aliases/TaskEndEventArgs.md +13 -0
  441. package/docs/type-aliases/TaskStartEventArgs.md +13 -0
  442. package/docs/type-aliases/UnexposedEventArgs.md +13 -0
  443. package/docs/type-aliases/UnsignedBoundWitness.md +13 -0
  444. package/docs/type-aliases/UnsignedQueryBoundWitness.md +7 -0
  445. package/docs/type-aliases/Visibility.md +7 -0
  446. package/docs/type-aliases/WasmFeature.md +7 -0
  447. package/docs/type-aliases/WithAnySchema.md +13 -0
  448. package/docs/type-aliases/WithBlock.md +7 -0
  449. package/docs/type-aliases/WithDataHashStorageMeta.md +13 -0
  450. package/docs/type-aliases/WithHashStorageMeta.md +13 -0
  451. package/docs/type-aliases/WithOnlyClientMeta.md +13 -0
  452. package/docs/type-aliases/WithOptionalSchema.md +13 -0
  453. package/docs/type-aliases/WithOptionalSources.md +17 -0
  454. package/docs/type-aliases/WithPartialDataHashStorageMeta.md +13 -0
  455. package/docs/type-aliases/WithPartialHashStorageMeta.md +13 -0
  456. package/docs/type-aliases/WithPartialSequenceStorageMeta.md +13 -0
  457. package/docs/type-aliases/WithPartialStorageMeta.md +13 -0
  458. package/docs/type-aliases/WithPayload.md +13 -0
  459. package/docs/type-aliases/WithSchema.md +15 -0
  460. package/docs/type-aliases/WithSequenceStorageMeta.md +13 -0
  461. package/docs/type-aliases/WithSources.md +13 -0
  462. package/docs/type-aliases/WithStorageMeta.md +13 -0
  463. package/docs/type-aliases/WithTimestamp.md +15 -0
  464. package/docs/type-aliases/WithoutClientMeta.md +13 -0
  465. package/docs/type-aliases/WithoutMeta.md +13 -0
  466. package/docs/type-aliases/WithoutPrivateStorageMeta.md +13 -0
  467. package/docs/type-aliases/WithoutSchema.md +13 -0
  468. package/docs/type-aliases/WithoutStorageMeta.md +13 -0
  469. package/docs/type-aliases/WitnessConfig.md +17 -0
  470. package/docs/type-aliases/WitnessConfigSchema.md +7 -0
  471. package/docs/type-aliases/WitnessModuleEventData.md +21 -0
  472. package/docs/type-aliases/WitnessModuleQueries.md +7 -0
  473. package/docs/type-aliases/WitnessObserveQuery.md +7 -0
  474. package/docs/type-aliases/WitnessObserveQuerySchema.md +7 -0
  475. package/docs/type-aliases/WitnessParams.md +17 -0
  476. package/docs/type-aliases/WitnessQueries.md +7 -0
  477. package/docs/type-aliases/WitnessTask.md +7 -0
  478. package/docs/variables/AddressChildSchema.md +7 -0
  479. package/docs/variables/AddressPreviousHashSchema.md +7 -0
  480. package/docs/variables/AddressRegEx.md +7 -0
  481. package/docs/variables/AddressSchema.md +7 -0
  482. package/docs/variables/ArchivistAllQuerySchema.md +7 -0
  483. package/docs/variables/ArchivistClearQuerySchema.md +7 -0
  484. package/docs/variables/ArchivistCommitQuerySchema.md +7 -0
  485. package/docs/variables/ArchivistConfigSchema.md +7 -0
  486. package/docs/variables/ArchivistDeleteQuerySchema.md +7 -0
  487. package/docs/variables/ArchivistGetQuerySchema.md +7 -0
  488. package/docs/variables/ArchivistInsertQuerySchema.md +7 -0
  489. package/docs/variables/ArchivistNextQuerySchema.md +7 -0
  490. package/docs/variables/BoundWitnessJsonSchema-1.md +107 -0
  491. package/docs/variables/BoundWitnessSchema.md +7 -0
  492. package/docs/variables/BridgeConfigSchema.md +7 -0
  493. package/docs/variables/BridgeConnectQuerySchema.md +7 -0
  494. package/docs/variables/BridgeDisconnectQuerySchema.md +7 -0
  495. package/docs/variables/BridgeExposeQuerySchema.md +7 -0
  496. package/docs/variables/BridgeUnexposeQuerySchema.md +7 -0
  497. package/docs/variables/ChildCertificationSchema.md +7 -0
  498. package/docs/variables/DappPackageManifestPayloadSchema.md +7 -0
  499. package/docs/variables/DisallowedModuleIdentifierCharacters.md +125 -0
  500. package/docs/variables/DivinerConfigSchema.md +7 -0
  501. package/docs/variables/DivinerDivineQuerySchema.md +7 -0
  502. package/docs/variables/GeneratedBoundWitnessFields.md +7 -0
  503. package/docs/variables/HashRegEx.md +7 -0
  504. package/docs/variables/HexRegEx.md +7 -0
  505. package/docs/variables/HexRegExMinMax.md +21 -0
  506. package/docs/variables/IndexSeparator.md +7 -0
  507. package/docs/variables/LocalSequenceConstants.md +65 -0
  508. package/docs/variables/MODULE_PATH_SEPARATOR.md +7 -0
  509. package/docs/variables/ModuleAddressQuerySchema.md +7 -0
  510. package/docs/variables/ModuleConfigSchema.md +7 -0
  511. package/docs/variables/ModuleDescriptionSchema.md +7 -0
  512. package/docs/variables/ModuleErrorSchema.md +7 -0
  513. package/docs/variables/ModuleFilterPayloadSchema.md +7 -0
  514. package/docs/variables/ModuleLimitationLabelName.md +7 -0
  515. package/docs/variables/ModuleLimitationViewLabel.md +13 -0
  516. package/docs/variables/ModuleManifestPayloadSchema.md +7 -0
  517. package/docs/variables/ModuleManifestQuerySchema.md +7 -0
  518. package/docs/variables/ModuleStateQuerySchema.md +7 -0
  519. package/docs/variables/ModuleStateSchema.md +7 -0
  520. package/docs/variables/ModuleSubscribeQuerySchema.md +7 -0
  521. package/docs/variables/NodeAttachQuerySchema.md +7 -0
  522. package/docs/variables/NodeAttachedQuerySchema.md +7 -0
  523. package/docs/variables/NodeCertifyQuerySchema.md +7 -0
  524. package/docs/variables/NodeConfigSchema.md +7 -0
  525. package/docs/variables/NodeDetachQuerySchema.md +7 -0
  526. package/docs/variables/NodeManifestPayloadSchema.md +7 -0
  527. package/docs/variables/NodeRegisteredQuerySchema.md +7 -0
  528. package/docs/variables/ObjectResolverPriority.md +33 -0
  529. package/docs/variables/PackageManifestPayloadSchema.md +7 -0
  530. package/docs/variables/PayloadSchema.md +7 -0
  531. package/docs/variables/PayloadSetSchema.md +7 -0
  532. package/docs/variables/QualifiedSequenceConstants.md +21 -0
  533. package/docs/variables/ReservedModuleIdentifierCharacters.md +7 -0
  534. package/docs/variables/SchemaRegEx.md +7 -0
  535. package/docs/variables/SentinelAutomationSchema.md +7 -0
  536. package/docs/variables/SentinelConfigSchema.md +7 -0
  537. package/docs/variables/SentinelEventAutomationSchema.md +7 -0
  538. package/docs/variables/SentinelIntervalAutomationSchema.md +7 -0
  539. package/docs/variables/SentinelReportQuerySchema.md +7 -0
  540. package/docs/variables/SequenceComparer.md +17 -0
  541. package/docs/variables/SequenceComponentLengths.md +29 -0
  542. package/docs/variables/SequenceComponentMinMax.md +33 -0
  543. package/docs/variables/SequenceConstants.md +77 -0
  544. package/docs/variables/SequenceNonceComponentLengths.md +17 -0
  545. package/docs/variables/SignatureRegEx.md +7 -0
  546. package/docs/variables/Uint256RegEx.md +7 -0
  547. package/docs/variables/WasmFeatureDetectors.md +435 -0
  548. package/docs/variables/WithFactory.md +49 -0
  549. package/docs/variables/WitnessConfigSchema.md +7 -0
  550. package/docs/variables/WitnessObserveQuerySchema.md +7 -0
  551. package/docs/variables/addressesContains.md +27 -0
  552. package/docs/variables/addressesContainsAll.md +29 -0
  553. package/docs/variables/addressesContainsAny.md +31 -0
  554. package/docs/variables/asAddressPayload.md +59 -0
  555. package/docs/variables/asAnyPayload.md +59 -0
  556. package/docs/variables/asArchivistInstance.md +59 -0
  557. package/docs/variables/asArchivistModule.md +59 -0
  558. package/docs/variables/asAttachableArchivistInstance.md +59 -0
  559. package/docs/variables/asAttachableBridgeInstance.md +59 -0
  560. package/docs/variables/asAttachableDivinerInstance.md +59 -0
  561. package/docs/variables/asAttachableModuleInstance.md +59 -0
  562. package/docs/variables/asAttachableNodeInstance.md +59 -0
  563. package/docs/variables/asAttachableSentinelInstance.md +59 -0
  564. package/docs/variables/asAttachableWitnessInstance.md +59 -0
  565. package/docs/variables/asBlock.md +17 -0
  566. package/docs/variables/asBoundWitness.md +23 -0
  567. package/docs/variables/asBoundWitnessWithStorageMeta.md +23 -0
  568. package/docs/variables/asBridgeInstance.md +59 -0
  569. package/docs/variables/asBridgeModule.md +59 -0
  570. package/docs/variables/asDataHashStorageMeta.md +59 -0
  571. package/docs/variables/asDivinerInstance.md +59 -0
  572. package/docs/variables/asDivinerModule.md +59 -0
  573. package/docs/variables/asHashStorageMeta.md +59 -0
  574. package/docs/variables/asModule.md +59 -0
  575. package/docs/variables/asModuleInstance.md +59 -0
  576. package/docs/variables/asModuleObject.md +59 -0
  577. package/docs/variables/asModuleState.md +59 -0
  578. package/docs/variables/asNodeInstance.md +59 -0
  579. package/docs/variables/asNodeModule.md +59 -0
  580. package/docs/variables/asOptionalAddressPayload.md +23 -0
  581. package/docs/variables/asOptionalBoundWitness.md +23 -0
  582. package/docs/variables/asOptionalBoundWitnessWithStorageMeta.md +23 -0
  583. package/docs/variables/asOptionalDataHashStorageMeta.md +23 -0
  584. package/docs/variables/asOptionalHashStorageMeta.md +23 -0
  585. package/docs/variables/asOptionalSequenceStorageMeta.md +23 -0
  586. package/docs/variables/asOptionalStorageMeta.md +23 -0
  587. package/docs/variables/asPayload.md +69 -0
  588. package/docs/variables/asSchema.md +59 -0
  589. package/docs/variables/asSentinelInstance.md +59 -0
  590. package/docs/variables/asSentinelModule.md +59 -0
  591. package/docs/variables/asSequenceStorageMeta.md +59 -0
  592. package/docs/variables/asStorageMeta.md +59 -0
  593. package/docs/variables/asWitnessInstance.md +59 -0
  594. package/docs/variables/asWitnessModule.md +59 -0
  595. package/docs/variables/assignCreatableModuleRegistry.md +25 -0
  596. package/docs/variables/boundWitnessJsonSchema.md +7 -0
  597. package/docs/variables/boundWitnessProperties.md +7 -0
  598. package/docs/variables/buildStandardIndexName.md +24 -0
  599. package/docs/variables/combineWalletPaths.md +21 -0
  600. package/docs/variables/duplicateModules.md +37 -0
  601. package/docs/variables/formatWalletPath.md +17 -0
  602. package/docs/variables/getBoundWitness.md +21 -0
  603. package/docs/variables/getTypedBoundWitness.md +31 -0
  604. package/docs/variables/hasAllLabels.md +29 -0
  605. package/docs/variables/hasBlock.md +17 -0
  606. package/docs/variables/hasEmptyFields.md +23 -0
  607. package/docs/variables/hasLabels.md +17 -0
  608. package/docs/variables/hydrateBoundWitness.md +21 -0
  609. package/docs/variables/hydrateTypedBoundWitness.md +31 -0
  610. package/docs/variables/includesReservedModuleIdentifierCharacter.md +17 -0
  611. package/docs/variables/isAddressModuleFilter.md +17 -0
  612. package/docs/variables/isAddressObjectFilter.md +23 -0
  613. package/docs/variables/isAddressPayload.md +19 -0
  614. package/docs/variables/isAnyPayload.md +17 -0
  615. package/docs/variables/isArchivistInstance.md +7 -0
  616. package/docs/variables/isArchivistModule.md +7 -0
  617. package/docs/variables/isAttachableArchivistInstance.md +7 -0
  618. package/docs/variables/isAttachableBridgeInstance.md +7 -0
  619. package/docs/variables/isAttachableDivinerInstance.md +7 -0
  620. package/docs/variables/isAttachableModuleInstance.md +7 -0
  621. package/docs/variables/isAttachableNodeInstance.md +7 -0
  622. package/docs/variables/isAttachableSentinelInstance.md +7 -0
  623. package/docs/variables/isAttachableWitnessInstance.md +7 -0
  624. package/docs/variables/isBoundWitness.md +17 -0
  625. package/docs/variables/isBoundWitnessWithStorageMeta.md +17 -0
  626. package/docs/variables/isBoundWitnessWrapper.md +27 -0
  627. package/docs/variables/isBridgeInstance.md +7 -0
  628. package/docs/variables/isBridgeModule.md +7 -0
  629. package/docs/variables/isDataHashStorageMeta.md +17 -0
  630. package/docs/variables/isDivinerInstance.md +7 -0
  631. package/docs/variables/isDivinerModule.md +7 -0
  632. package/docs/variables/isEpoch.md +17 -0
  633. package/docs/variables/isHashStorageMeta.md +17 -0
  634. package/docs/variables/isLocalSequence.md +17 -0
  635. package/docs/variables/isModule.md +7 -0
  636. package/docs/variables/isModuleError.md +17 -0
  637. package/docs/variables/isModuleIdentifierPart.md +17 -0
  638. package/docs/variables/isModuleInstance.md +7 -0
  639. package/docs/variables/isModuleName.md +17 -0
  640. package/docs/variables/isModuleObject.md +7 -0
  641. package/docs/variables/isModuleResolver.md +17 -0
  642. package/docs/variables/isModuleState.md +23 -0
  643. package/docs/variables/isModuleStateWithSources.md +23 -0
  644. package/docs/variables/isNameModuleFilter.md +17 -0
  645. package/docs/variables/isNameObjectFilter.md +23 -0
  646. package/docs/variables/isNodeInstance.md +7 -0
  647. package/docs/variables/isNodeModule.md +7 -0
  648. package/docs/variables/isNonce.md +17 -0
  649. package/docs/variables/isObjectResolver.md +23 -0
  650. package/docs/variables/isPackageManifestPayload.md +17 -0
  651. package/docs/variables/isPayload.md +33 -0
  652. package/docs/variables/isPayloadOfSchemaTypeWithSources.md +33 -0
  653. package/docs/variables/isPayloadWrapper.md +17 -0
  654. package/docs/variables/isPayloadWrapperBase.md +17 -0
  655. package/docs/variables/isQualifiedSequence.md +17 -0
  656. package/docs/variables/isQueryBoundWitness.md +17 -0
  657. package/docs/variables/isQueryBoundWitnessWithStorageMeta.md +17 -0
  658. package/docs/variables/isQueryModuleFilter.md +17 -0
  659. package/docs/variables/isQueryObjectFilter.md +23 -0
  660. package/docs/variables/isSchema.md +17 -0
  661. package/docs/variables/isSentinelInstance.md +7 -0
  662. package/docs/variables/isSentinelIntervalAutomation.md +17 -0
  663. package/docs/variables/isSentinelModule.md +7 -0
  664. package/docs/variables/isSequence.md +17 -0
  665. package/docs/variables/isSequenceStorageMeta.md +17 -0
  666. package/docs/variables/isSerializable.md +21 -0
  667. package/docs/variables/isSigned.md +17 -0
  668. package/docs/variables/isStorageMeta.md +17 -0
  669. package/docs/variables/isUnsigned.md +17 -0
  670. package/docs/variables/isValidAbsoluteWalletPath.md +17 -0
  671. package/docs/variables/isValidRelativeWalletPath.md +17 -0
  672. package/docs/variables/isWitnessInstance.md +7 -0
  673. package/docs/variables/isWitnessModule.md +7 -0
  674. package/docs/variables/mixinResolverEventEmitter.md +23 -0
  675. package/docs/variables/notBoundWitness.md +17 -0
  676. package/docs/variables/notPayloadOfSchemaType.md +33 -0
  677. package/docs/variables/omitSchema.md +23 -0
  678. package/docs/variables/payloadHashesContains.md +29 -0
  679. package/docs/variables/payloadHashesContainsAll.md +29 -0
  680. package/docs/variables/payloadHashesContainsAny.md +31 -0
  681. package/docs/variables/payloadJsonSchema.md +7 -0
  682. package/docs/variables/payloadPropertiesJsonSchema.md +7 -0
  683. package/docs/variables/payloadSchemasContains.md +29 -0
  684. package/docs/variables/payloadSchemasContainsAll.md +29 -0
  685. package/docs/variables/payloadSchemasContainsAny.md +31 -0
  686. package/docs/variables/registerCreatableModuleFactories.md +25 -0
  687. package/docs/variables/registerCreatableModuleFactory.md +35 -0
  688. package/docs/variables/removeEmptyFields.md +23 -0
  689. package/docs/variables/requiredAttachableArchivistInstanceFunctions.md +7 -0
  690. package/docs/variables/requiredAttachableBridgeInstanceFunctions.md +7 -0
  691. package/docs/variables/requiredAttachableDivinerInstanceFunctions.md +7 -0
  692. package/docs/variables/requiredAttachableModuleInstanceFunctions.md +7 -0
  693. package/docs/variables/requiredAttachableNodeInstanceFunctions.md +7 -0
  694. package/docs/variables/requiredAttachableSentinelInstanceFunctions.md +7 -0
  695. package/docs/variables/requiredAttachableWitnessInstanceFunctions.md +7 -0
  696. package/docs/variables/requiredModuleInstanceFunctions.md +7 -0
  697. package/docs/variables/requiredModuleQueries.md +7 -0
  698. package/docs/variables/requiredModuleShape.md +7 -0
  699. package/docs/variables/resolveAddressToInstance.md +33 -0
  700. package/docs/variables/resolveAddressToInstanceAll.md +29 -0
  701. package/docs/variables/resolveAddressToInstanceDown.md +29 -0
  702. package/docs/variables/resolveAddressToInstanceSiblings.md +29 -0
  703. package/docs/variables/resolveAddressToInstanceUp.md +29 -0
  704. package/docs/variables/resolveAll.md +25 -0
  705. package/docs/variables/resolveAllDown.md +29 -0
  706. package/docs/variables/resolveAllUp.md +25 -0
  707. package/docs/variables/resolveLocalNameToAddress.md +29 -0
  708. package/docs/variables/resolveLocalNameToAddressAll.md +25 -0
  709. package/docs/variables/resolveLocalNameToAddressDown.md +25 -0
  710. package/docs/variables/resolveLocalNameToAddressUp.md +21 -0
  711. package/docs/variables/resolveLocalNameToInstance.md +29 -0
  712. package/docs/variables/resolveLocalNameToInstanceAll.md +25 -0
  713. package/docs/variables/resolveLocalNameToInstanceDown.md +25 -0
  714. package/docs/variables/resolveLocalNameToInstanceUp.md +21 -0
  715. package/docs/variables/resolvePathToAddress.md +29 -0
  716. package/docs/variables/resolvePathToInstance.md +29 -0
  717. package/docs/variables/sortFields.md +23 -0
  718. package/docs/variables/transformModuleIdentifier.md +21 -0
  719. package/docs/variables/tryGetTypedBoundWitness.md +31 -0
  720. package/docs/variables/tryHydrateTypedBoundWitness.md +31 -0
  721. package/docs/variables/withArchivistInstance.md +27 -0
  722. package/docs/variables/withArchivistModule.md +27 -0
  723. package/docs/variables/withBridgeInstance.md +27 -0
  724. package/docs/variables/withBridgeModule.md +27 -0
  725. package/docs/variables/withDivinerInstance.md +27 -0
  726. package/docs/variables/withDivinerModule.md +27 -0
  727. package/docs/variables/withModule.md +27 -0
  728. package/docs/variables/withModuleInstance.md +27 -0
  729. package/docs/variables/withNodeInstance.md +27 -0
  730. package/docs/variables/withNodeModule.md +27 -0
  731. package/docs/variables/withSentinelInstance.md +27 -0
  732. package/docs/variables/withSentinelModule.md +27 -0
  733. package/docs/variables/withWitnessInstance.md +27 -0
  734. package/docs/variables/withWitnessModule.md +27 -0
  735. package/package.json +19 -18
  736. package/scripts/README.template.md +23 -0
  737. package/scripts/generate-docs-for-package.mjs +71 -0
  738. package/scripts/readme-gen.mjs +37 -0
@@ -0,0 +1,1819 @@
1
+ [@xyo-network/sdk-js](../README.md) / DivinerWrapper
2
+
3
+ # Class: DivinerWrapper\<TWrappedModule, TIn, TOut\>
4
+
5
+ Defined in: packages/modules/packages/diviner/packages/wrapper/dist/types/DivinerWrapper.d.ts:7
6
+
7
+ ## Extends
8
+
9
+ - [`ModuleWrapper`](ModuleWrapper.md)\<`TWrappedModule`\>
10
+
11
+ ## Type Parameters
12
+
13
+ ### TWrappedModule
14
+
15
+ `TWrappedModule` *extends* [`DivinerModule`](../interfaces/DivinerModule.md)\<[`DivinerParams`](../type-aliases/DivinerParams.md)\>
16
+
17
+ ### TIn
18
+
19
+ `TIn` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
20
+
21
+ ### TOut
22
+
23
+ `TOut` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
24
+
25
+ ## Implements
26
+
27
+ - [`DivinerInstance`](../interfaces/DivinerInstance.md)\<`TWrappedModule`\[`"params"`\], `TIn`, `TOut`\>
28
+
29
+ ## Constructors
30
+
31
+ ### Constructor
32
+
33
+ > **new DivinerWrapper**\<`TWrappedModule`, `TIn`, `TOut`\>(`params`): `DivinerWrapper`\<`TWrappedModule`, `TIn`, `TOut`\>
34
+
35
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:36
36
+
37
+ #### Parameters
38
+
39
+ ##### params
40
+
41
+ [`ModuleWrapperParams`](../type-aliases/ModuleWrapperParams.md)\<`TWrappedModule`\>
42
+
43
+ #### Returns
44
+
45
+ `DivinerWrapper`\<`TWrappedModule`, `TIn`, `TOut`\>
46
+
47
+ #### Inherited from
48
+
49
+ [`ModuleWrapper`](ModuleWrapper.md).[`constructor`](ModuleWrapper.md#constructor)
50
+
51
+ ## Properties
52
+
53
+ ### eventData
54
+
55
+ > **eventData**: `TWrappedModule`\[`"eventData"`\]
56
+
57
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:31
58
+
59
+ #### Implementation of
60
+
61
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`eventData`](../interfaces/DivinerInstance.md#eventdata)
62
+
63
+ #### Inherited from
64
+
65
+ [`ModuleWrapper`](ModuleWrapper.md).[`eventData`](ModuleWrapper.md#eventdata)
66
+
67
+ ***
68
+
69
+ ### defaultLogger?
70
+
71
+ > `static` `optional` **defaultLogger**: `Logger`
72
+
73
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:9
74
+
75
+ #### Inherited from
76
+
77
+ [`ModuleWrapper`](ModuleWrapper.md).[`defaultLogger`](ModuleWrapper.md#defaultlogger)
78
+
79
+ ***
80
+
81
+ ### globalInstances
82
+
83
+ > `readonly` `static` **globalInstances**: `Record`\<`string`, `WeakRef`\<`Base`\<`undefined` \| `BaseParamsFields`\>\>[]\>
84
+
85
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:10
86
+
87
+ #### Inherited from
88
+
89
+ [`ModuleWrapper`](ModuleWrapper.md).[`globalInstances`](ModuleWrapper.md#globalinstances)
90
+
91
+ ***
92
+
93
+ ### globalInstancesCountHistory
94
+
95
+ > `readonly` `static` **globalInstancesCountHistory**: `Record`\<`string`, `number`[]\>
96
+
97
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:11
98
+
99
+ #### Inherited from
100
+
101
+ [`ModuleWrapper`](ModuleWrapper.md).[`globalInstancesCountHistory`](ModuleWrapper.md#globalinstancescounthistory)
102
+
103
+ ***
104
+
105
+ ### instanceIdentityCheck
106
+
107
+ > `readonly` `static` **instanceIdentityCheck**: `any`
108
+
109
+ Defined in: packages/modules/packages/diviner/packages/wrapper/dist/types/DivinerWrapper.d.ts:8
110
+
111
+ #### Overrides
112
+
113
+ [`ModuleWrapper`](ModuleWrapper.md).[`instanceIdentityCheck`](ModuleWrapper.md#instanceidentitycheck)
114
+
115
+ ***
116
+
117
+ ### moduleIdentityCheck
118
+
119
+ > `readonly` `static` **moduleIdentityCheck**: [`ModuleTypeCheck`](../type-aliases/ModuleTypeCheck.md)\<[`DivinerModule`](../interfaces/DivinerModule.md)\<`any`, [`DivinerModuleEventData`](../type-aliases/DivinerModuleEventData.md)\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`any`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>, [`Payload`](../type-aliases/Payload.md), [`Payload`](../type-aliases/Payload.md)\>\>\>
120
+
121
+ Defined in: packages/modules/packages/diviner/packages/wrapper/dist/types/DivinerWrapper.d.ts:19
122
+
123
+ #### Overrides
124
+
125
+ [`ModuleWrapper`](ModuleWrapper.md).[`moduleIdentityCheck`](ModuleWrapper.md#moduleidentitycheck)
126
+
127
+ ***
128
+
129
+ ### requiredQueries
130
+
131
+ > `readonly` `static` **requiredQueries**: `string`[]
132
+
133
+ Defined in: packages/modules/packages/diviner/packages/wrapper/dist/types/DivinerWrapper.d.ts:30
134
+
135
+ #### Overrides
136
+
137
+ [`ModuleWrapper`](ModuleWrapper.md).[`requiredQueries`](ModuleWrapper.md#requiredqueries)
138
+
139
+ ***
140
+
141
+ ### uniqueName
142
+
143
+ > `readonly` `static` **uniqueName**: `string`
144
+
145
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:12
146
+
147
+ #### Inherited from
148
+
149
+ [`ModuleWrapper`](ModuleWrapper.md).[`uniqueName`](ModuleWrapper.md#uniquename)
150
+
151
+ ## Accessors
152
+
153
+ ### account
154
+
155
+ #### Get Signature
156
+
157
+ > **get** **account**(): `AccountInstance`
158
+
159
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:37
160
+
161
+ ##### Returns
162
+
163
+ `AccountInstance`
164
+
165
+ #### Implementation of
166
+
167
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`account`](../interfaces/DivinerInstance.md#account)
168
+
169
+ #### Inherited from
170
+
171
+ [`ModuleWrapper`](ModuleWrapper.md).[`account`](ModuleWrapper.md#account)
172
+
173
+ ***
174
+
175
+ ### additionalSigners
176
+
177
+ #### Get Signature
178
+
179
+ > **get** **additionalSigners**(): `AccountInstance`[]
180
+
181
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:38
182
+
183
+ ##### Returns
184
+
185
+ `AccountInstance`[]
186
+
187
+ #### Inherited from
188
+
189
+ [`ModuleWrapper`](ModuleWrapper.md).[`additionalSigners`](ModuleWrapper.md#additionalsigners)
190
+
191
+ ***
192
+
193
+ ### address
194
+
195
+ #### Get Signature
196
+
197
+ > **get** **address**(): `Lowercase`\<`string`\>
198
+
199
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:39
200
+
201
+ ##### Returns
202
+
203
+ `Lowercase`\<`string`\>
204
+
205
+ #### Implementation of
206
+
207
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`address`](../interfaces/DivinerInstance.md#address)
208
+
209
+ #### Inherited from
210
+
211
+ [`ModuleWrapper`](ModuleWrapper.md).[`address`](ModuleWrapper.md#address)
212
+
213
+ ***
214
+
215
+ ### config
216
+
217
+ #### Get Signature
218
+
219
+ > **get** **config**(): `Exclude`\<`TWrappedModule`\[`"params"`\]\[`"config"`\], `undefined`\>
220
+
221
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:40
222
+
223
+ ##### Returns
224
+
225
+ `Exclude`\<`TWrappedModule`\[`"params"`\]\[`"config"`\], `undefined`\>
226
+
227
+ #### Implementation of
228
+
229
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`config`](../interfaces/DivinerInstance.md#config)
230
+
231
+ #### Inherited from
232
+
233
+ [`ModuleWrapper`](ModuleWrapper.md).[`config`](ModuleWrapper.md#config)
234
+
235
+ ***
236
+
237
+ ### downResolver
238
+
239
+ #### Get Signature
240
+
241
+ > **get** **downResolver**(): [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
242
+
243
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:41
244
+
245
+ ##### Returns
246
+
247
+ [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
248
+
249
+ #### Inherited from
250
+
251
+ [`ModuleWrapper`](ModuleWrapper.md).[`downResolver`](ModuleWrapper.md#downresolver)
252
+
253
+ ***
254
+
255
+ ### id
256
+
257
+ #### Get Signature
258
+
259
+ > **get** **id**(): `string`
260
+
261
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:42
262
+
263
+ The name (if specified) or address of the module
264
+
265
+ ##### Returns
266
+
267
+ `string`
268
+
269
+ The name (if specified) or address of the module
270
+
271
+ #### Implementation of
272
+
273
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`id`](../interfaces/DivinerInstance.md#id)
274
+
275
+ #### Inherited from
276
+
277
+ [`ModuleWrapper`](ModuleWrapper.md).[`id`](ModuleWrapper.md#id)
278
+
279
+ ***
280
+
281
+ ### logger
282
+
283
+ #### Get Signature
284
+
285
+ > **get** **logger**(): `undefined` \| `Logger`
286
+
287
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:27
288
+
289
+ ##### Returns
290
+
291
+ `undefined` \| `Logger`
292
+
293
+ #### Inherited from
294
+
295
+ [`ModuleWrapper`](ModuleWrapper.md).[`logger`](ModuleWrapper.md#logger)
296
+
297
+ ***
298
+
299
+ ### mod
300
+
301
+ #### Get Signature
302
+
303
+ > **get** **mod**(): `TWrappedModule`
304
+
305
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:43
306
+
307
+ ##### Returns
308
+
309
+ `TWrappedModule`
310
+
311
+ #### Inherited from
312
+
313
+ [`ModuleWrapper`](ModuleWrapper.md).[`mod`](ModuleWrapper.md#mod)
314
+
315
+ ***
316
+
317
+ ### modName
318
+
319
+ #### Get Signature
320
+
321
+ > **get** **modName**(): `undefined` \| `string`
322
+
323
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:44
324
+
325
+ ##### Returns
326
+
327
+ `undefined` \| `string`
328
+
329
+ #### Implementation of
330
+
331
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`modName`](../interfaces/DivinerInstance.md#modname)
332
+
333
+ #### Inherited from
334
+
335
+ [`ModuleWrapper`](ModuleWrapper.md).[`modName`](ModuleWrapper.md#modname)
336
+
337
+ ***
338
+
339
+ ### params
340
+
341
+ #### Get Signature
342
+
343
+ > **get** **params**(): `TParams`
344
+
345
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:28
346
+
347
+ ##### Returns
348
+
349
+ `TParams`
350
+
351
+ #### Implementation of
352
+
353
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`params`](../interfaces/DivinerInstance.md#params)
354
+
355
+ #### Inherited from
356
+
357
+ [`ModuleWrapper`](ModuleWrapper.md).[`params`](ModuleWrapper.md#params)
358
+
359
+ ***
360
+
361
+ ### priority
362
+
363
+ #### Get Signature
364
+
365
+ > **get** **priority**(): `1`
366
+
367
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:45
368
+
369
+ ##### Returns
370
+
371
+ `1`
372
+
373
+ #### Implementation of
374
+
375
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`priority`](../interfaces/DivinerInstance.md#priority)
376
+
377
+ #### Inherited from
378
+
379
+ [`ModuleWrapper`](ModuleWrapper.md).[`priority`](ModuleWrapper.md#priority)
380
+
381
+ ***
382
+
383
+ ### privateResolver
384
+
385
+ #### Get Signature
386
+
387
+ > **get** **privateResolver**(): [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
388
+
389
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:46
390
+
391
+ ##### Returns
392
+
393
+ [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
394
+
395
+ #### Inherited from
396
+
397
+ [`ModuleWrapper`](ModuleWrapper.md).[`privateResolver`](ModuleWrapper.md#privateresolver)
398
+
399
+ ***
400
+
401
+ ### queries
402
+
403
+ #### Get Signature
404
+
405
+ > **get** **queries**(): `string`[]
406
+
407
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:47
408
+
409
+ ##### Returns
410
+
411
+ `string`[]
412
+
413
+ #### Implementation of
414
+
415
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`queries`](../interfaces/DivinerInstance.md#queries)
416
+
417
+ #### Inherited from
418
+
419
+ [`ModuleWrapper`](ModuleWrapper.md).[`queries`](ModuleWrapper.md#queries)
420
+
421
+ ***
422
+
423
+ ### status
424
+
425
+ #### Get Signature
426
+
427
+ > **get** **status**(): [`ModuleStatus`](../type-aliases/ModuleStatus.md)
428
+
429
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:48
430
+
431
+ ##### Returns
432
+
433
+ [`ModuleStatus`](../type-aliases/ModuleStatus.md)
434
+
435
+ #### Set Signature
436
+
437
+ > **set** **status**(`value`): `void`
438
+
439
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:50
440
+
441
+ ##### Parameters
442
+
443
+ ###### value
444
+
445
+ [`ModuleStatus`](../type-aliases/ModuleStatus.md)
446
+
447
+ ##### Returns
448
+
449
+ `void`
450
+
451
+ #### Implementation of
452
+
453
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`status`](../interfaces/DivinerInstance.md#status)
454
+
455
+ #### Inherited from
456
+
457
+ [`ModuleWrapper`](ModuleWrapper.md).[`status`](ModuleWrapper.md#status)
458
+
459
+ ***
460
+
461
+ ### upResolver
462
+
463
+ #### Get Signature
464
+
465
+ > **get** **upResolver**(): [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
466
+
467
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:49
468
+
469
+ ##### Returns
470
+
471
+ [`ModuleResolverInstance`](../interfaces/ModuleResolverInstance.md)
472
+
473
+ #### Inherited from
474
+
475
+ [`ModuleWrapper`](ModuleWrapper.md).[`upResolver`](ModuleWrapper.md#upresolver)
476
+
477
+ ***
478
+
479
+ ### historyInterval
480
+
481
+ #### Get Signature
482
+
483
+ > **get** `static` **historyInterval**(): `number`
484
+
485
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:20
486
+
487
+ ##### Returns
488
+
489
+ `number`
490
+
491
+ #### Set Signature
492
+
493
+ > **set** `static` **historyInterval**(`value`): `void`
494
+
495
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:21
496
+
497
+ ##### Parameters
498
+
499
+ ###### value
500
+
501
+ `number`
502
+
503
+ ##### Returns
504
+
505
+ `void`
506
+
507
+ #### Inherited from
508
+
509
+ [`ModuleWrapper`](ModuleWrapper.md).[`historyInterval`](ModuleWrapper.md#historyinterval)
510
+
511
+ ***
512
+
513
+ ### historyTime
514
+
515
+ #### Get Signature
516
+
517
+ > **get** `static` **historyTime**(): `number`
518
+
519
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:22
520
+
521
+ ##### Returns
522
+
523
+ `number`
524
+
525
+ #### Set Signature
526
+
527
+ > **set** `static` **historyTime**(`value`): `void`
528
+
529
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:23
530
+
531
+ ##### Parameters
532
+
533
+ ###### value
534
+
535
+ `number`
536
+
537
+ ##### Returns
538
+
539
+ `void`
540
+
541
+ #### Inherited from
542
+
543
+ [`ModuleWrapper`](ModuleWrapper.md).[`historyTime`](ModuleWrapper.md#historytime)
544
+
545
+ ***
546
+
547
+ ### maxGcFrequency
548
+
549
+ #### Get Signature
550
+
551
+ > **get** `static` **maxGcFrequency**(): `number`
552
+
553
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:24
554
+
555
+ ##### Returns
556
+
557
+ `number`
558
+
559
+ #### Set Signature
560
+
561
+ > **set** `static` **maxGcFrequency**(`value`): `void`
562
+
563
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:25
564
+
565
+ ##### Parameters
566
+
567
+ ###### value
568
+
569
+ `number`
570
+
571
+ ##### Returns
572
+
573
+ `void`
574
+
575
+ #### Inherited from
576
+
577
+ [`ModuleWrapper`](ModuleWrapper.md).[`maxGcFrequency`](ModuleWrapper.md#maxgcfrequency)
578
+
579
+ ***
580
+
581
+ ### maxHistoryDepth
582
+
583
+ #### Get Signature
584
+
585
+ > **get** `static` **maxHistoryDepth**(): `number`
586
+
587
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:26
588
+
589
+ ##### Returns
590
+
591
+ `number`
592
+
593
+ #### Inherited from
594
+
595
+ [`ModuleWrapper`](ModuleWrapper.md).[`maxHistoryDepth`](ModuleWrapper.md#maxhistorydepth)
596
+
597
+ ## Methods
598
+
599
+ ### addParent()
600
+
601
+ > **addParent**(`mod`): `void`
602
+
603
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:68
604
+
605
+ #### Parameters
606
+
607
+ ##### mod
608
+
609
+ [`ModuleInstance`](../interfaces/ModuleInstance.md)
610
+
611
+ #### Returns
612
+
613
+ `void`
614
+
615
+ #### Implementation of
616
+
617
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`addParent`](../interfaces/DivinerInstance.md#addparent)
618
+
619
+ #### Inherited from
620
+
621
+ [`ModuleWrapper`](ModuleWrapper.md).[`addParent`](ModuleWrapper.md#addparent)
622
+
623
+ ***
624
+
625
+ ### addressPreviousHash()
626
+
627
+ > **addressPreviousHash**(): `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>
628
+
629
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:69
630
+
631
+ #### Returns
632
+
633
+ `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>
634
+
635
+ #### Inherited from
636
+
637
+ [`ModuleWrapper`](ModuleWrapper.md).[`addressPreviousHash`](ModuleWrapper.md#addressprevioushash)
638
+
639
+ ***
640
+
641
+ ### clearListeners()
642
+
643
+ > **clearListeners**(`eventNames`): `void`
644
+
645
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:70
646
+
647
+ #### Parameters
648
+
649
+ ##### eventNames
650
+
651
+ `Parameters`\<`TWrappedModule`\[`"clearListeners"`\]\>\[`0`\]
652
+
653
+ #### Returns
654
+
655
+ `void`
656
+
657
+ #### Implementation of
658
+
659
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`clearListeners`](../interfaces/DivinerInstance.md#clearlisteners)
660
+
661
+ #### Inherited from
662
+
663
+ [`ModuleWrapper`](ModuleWrapper.md).[`clearListeners`](ModuleWrapper.md#clearlisteners)
664
+
665
+ ***
666
+
667
+ ### divine()
668
+
669
+ > **divine**(`payloads?`, `_retryConfig?`): `Promise`\<[`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<[`WithSources`](../type-aliases/WithSources.md)\<`TOut`\>\>[]\>
670
+
671
+ Defined in: packages/modules/packages/diviner/packages/wrapper/dist/types/DivinerWrapper.d.ts:31
672
+
673
+ #### Parameters
674
+
675
+ ##### payloads?
676
+
677
+ `TIn`[]
678
+
679
+ ##### \_retryConfig?
680
+
681
+ `RetryConfig`
682
+
683
+ #### Returns
684
+
685
+ `Promise`\<[`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<[`WithSources`](../type-aliases/WithSources.md)\<`TOut`\>\>[]\>
686
+
687
+ #### Implementation of
688
+
689
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`divine`](../interfaces/DivinerInstance.md#divine)
690
+
691
+ ***
692
+
693
+ ### divineQuery()
694
+
695
+ > **divineQuery**(`payloads?`, `account?`, `_retryConfig?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<`TOut`\>\>
696
+
697
+ Defined in: packages/modules/packages/diviner/packages/wrapper/dist/types/DivinerWrapper.d.ts:32
698
+
699
+ #### Parameters
700
+
701
+ ##### payloads?
702
+
703
+ `TIn`[]
704
+
705
+ ##### account?
706
+
707
+ `AccountInstance`
708
+
709
+ ##### \_retryConfig?
710
+
711
+ `RetryConfig`
712
+
713
+ #### Returns
714
+
715
+ `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<`TOut`\>\>
716
+
717
+ #### Implementation of
718
+
719
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`divineQuery`](../interfaces/DivinerInstance.md#divinequery)
720
+
721
+ ***
722
+
723
+ ### emit()
724
+
725
+ > **emit**(`eventName`, `eventArgs`): `Promise`\<`void`\>
726
+
727
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:71
728
+
729
+ #### Parameters
730
+
731
+ ##### eventName
732
+
733
+ `Parameters`\<`TWrappedModule`\[`"emit"`\]\>\[`0`\]
734
+
735
+ ##### eventArgs
736
+
737
+ `Parameters`\<`TWrappedModule`\[`"emit"`\]\>\[`1`\]
738
+
739
+ #### Returns
740
+
741
+ `Promise`\<`void`\>
742
+
743
+ #### Implementation of
744
+
745
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`emit`](../interfaces/DivinerInstance.md#emit)
746
+
747
+ #### Inherited from
748
+
749
+ [`ModuleWrapper`](ModuleWrapper.md).[`emit`](ModuleWrapper.md#emit)
750
+
751
+ ***
752
+
753
+ ### emitSerial()
754
+
755
+ > **emitSerial**(`eventName`, `eventArgs`): `Promise`\<`void`\>
756
+
757
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:72
758
+
759
+ #### Parameters
760
+
761
+ ##### eventName
762
+
763
+ `Parameters`\<`TWrappedModule`\[`"emitSerial"`\]\>\[`0`\]
764
+
765
+ ##### eventArgs
766
+
767
+ `Parameters`\<`TWrappedModule`\[`"emitSerial"`\]\>\[`1`\]
768
+
769
+ #### Returns
770
+
771
+ `Promise`\<`void`\>
772
+
773
+ #### Implementation of
774
+
775
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`emitSerial`](../interfaces/DivinerInstance.md#emitserial)
776
+
777
+ #### Inherited from
778
+
779
+ [`ModuleWrapper`](ModuleWrapper.md).[`emitSerial`](ModuleWrapper.md#emitserial)
780
+
781
+ ***
782
+
783
+ ### listenerCount()
784
+
785
+ > **listenerCount**(`eventNames`): `number`
786
+
787
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:73
788
+
789
+ #### Parameters
790
+
791
+ ##### eventNames
792
+
793
+ `Parameters`\<`TWrappedModule`\[`"listenerCount"`\]\>\[`0`\]
794
+
795
+ #### Returns
796
+
797
+ `number`
798
+
799
+ #### Implementation of
800
+
801
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`listenerCount`](../interfaces/DivinerInstance.md#listenercount)
802
+
803
+ #### Inherited from
804
+
805
+ [`ModuleWrapper`](ModuleWrapper.md).[`listenerCount`](ModuleWrapper.md#listenercount)
806
+
807
+ ***
808
+
809
+ ### manifest()
810
+
811
+ > **manifest**(`maxDepth?`): `Promise`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
812
+
813
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:74
814
+
815
+ #### Parameters
816
+
817
+ ##### maxDepth?
818
+
819
+ `number`
820
+
821
+ #### Returns
822
+
823
+ `Promise`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
824
+
825
+ #### Implementation of
826
+
827
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`manifest`](../interfaces/DivinerInstance.md#manifest)
828
+
829
+ #### Inherited from
830
+
831
+ [`ModuleWrapper`](ModuleWrapper.md).[`manifest`](ModuleWrapper.md#manifest)
832
+
833
+ ***
834
+
835
+ ### manifestQuery()
836
+
837
+ > **manifestQuery**(`account`, `maxDepth?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
838
+
839
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:75
840
+
841
+ #### Parameters
842
+
843
+ ##### account
844
+
845
+ `AccountInstance`
846
+
847
+ ##### maxDepth?
848
+
849
+ `number`
850
+
851
+ #### Returns
852
+
853
+ `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
854
+
855
+ #### Implementation of
856
+
857
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`manifestQuery`](../interfaces/DivinerInstance.md#manifestquery)
858
+
859
+ #### Inherited from
860
+
861
+ [`ModuleWrapper`](ModuleWrapper.md).[`manifestQuery`](ModuleWrapper.md#manifestquery)
862
+
863
+ ***
864
+
865
+ ### moduleAddress()
866
+
867
+ > **moduleAddress**(): `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)[]\>
868
+
869
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:76
870
+
871
+ #### Returns
872
+
873
+ `Promise`\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)[]\>
874
+
875
+ #### Implementation of
876
+
877
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`moduleAddress`](../interfaces/DivinerInstance.md#moduleaddress)
878
+
879
+ #### Inherited from
880
+
881
+ [`ModuleWrapper`](ModuleWrapper.md).[`moduleAddress`](ModuleWrapper.md#moduleaddress)
882
+
883
+ ***
884
+
885
+ ### off()
886
+
887
+ > **off**\<`TEventName`\>(`eventNames`, `listener`): `void`
888
+
889
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:77
890
+
891
+ #### Type Parameters
892
+
893
+ ##### TEventName
894
+
895
+ `TEventName` *extends* `string` \| `number` \| `symbol`
896
+
897
+ #### Parameters
898
+
899
+ ##### eventNames
900
+
901
+ `TEventName`
902
+
903
+ ##### listener
904
+
905
+ [`EventListener`](../type-aliases/EventListener.md)\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
906
+
907
+ #### Returns
908
+
909
+ `void`
910
+
911
+ #### Implementation of
912
+
913
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`off`](../interfaces/DivinerInstance.md#off)
914
+
915
+ #### Inherited from
916
+
917
+ [`ModuleWrapper`](ModuleWrapper.md).[`off`](ModuleWrapper.md#off)
918
+
919
+ ***
920
+
921
+ ### offAny()
922
+
923
+ > **offAny**(`listener`): `void`
924
+
925
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:78
926
+
927
+ #### Parameters
928
+
929
+ ##### listener
930
+
931
+ [`EventAnyListener`](../type-aliases/EventAnyListener.md)
932
+
933
+ #### Returns
934
+
935
+ `void`
936
+
937
+ #### Implementation of
938
+
939
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`offAny`](../interfaces/DivinerInstance.md#offany)
940
+
941
+ #### Inherited from
942
+
943
+ [`ModuleWrapper`](ModuleWrapper.md).[`offAny`](ModuleWrapper.md#offany)
944
+
945
+ ***
946
+
947
+ ### on()
948
+
949
+ > **on**\<`TEventName`\>(`eventNames`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
950
+
951
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:79
952
+
953
+ #### Type Parameters
954
+
955
+ ##### TEventName
956
+
957
+ `TEventName` *extends* `string` \| `number` \| `symbol`
958
+
959
+ #### Parameters
960
+
961
+ ##### eventNames
962
+
963
+ `TEventName`
964
+
965
+ ##### listener
966
+
967
+ [`EventListener`](../type-aliases/EventListener.md)\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
968
+
969
+ #### Returns
970
+
971
+ [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
972
+
973
+ #### Implementation of
974
+
975
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`on`](../interfaces/DivinerInstance.md#on)
976
+
977
+ #### Inherited from
978
+
979
+ [`ModuleWrapper`](ModuleWrapper.md).[`on`](ModuleWrapper.md#on)
980
+
981
+ ***
982
+
983
+ ### onAny()
984
+
985
+ > **onAny**(`listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
986
+
987
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:80
988
+
989
+ #### Parameters
990
+
991
+ ##### listener
992
+
993
+ [`EventAnyListener`](../type-aliases/EventAnyListener.md)
994
+
995
+ #### Returns
996
+
997
+ [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
998
+
999
+ #### Implementation of
1000
+
1001
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`onAny`](../interfaces/DivinerInstance.md#onany)
1002
+
1003
+ #### Inherited from
1004
+
1005
+ [`ModuleWrapper`](ModuleWrapper.md).[`onAny`](ModuleWrapper.md#onany)
1006
+
1007
+ ***
1008
+
1009
+ ### once()
1010
+
1011
+ > **once**\<`TEventName`\>(`eventName`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
1012
+
1013
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:81
1014
+
1015
+ #### Type Parameters
1016
+
1017
+ ##### TEventName
1018
+
1019
+ `TEventName` *extends* `string` \| `number` \| `symbol`
1020
+
1021
+ #### Parameters
1022
+
1023
+ ##### eventName
1024
+
1025
+ `TEventName`
1026
+
1027
+ ##### listener
1028
+
1029
+ [`EventListener`](../type-aliases/EventListener.md)\<`TWrappedModule`\[`"eventData"`\]\[`TEventName`\]\>
1030
+
1031
+ #### Returns
1032
+
1033
+ [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
1034
+
1035
+ #### Implementation of
1036
+
1037
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`once`](../interfaces/DivinerInstance.md#once)
1038
+
1039
+ #### Inherited from
1040
+
1041
+ [`ModuleWrapper`](ModuleWrapper.md).[`once`](ModuleWrapper.md#once)
1042
+
1043
+ ***
1044
+
1045
+ ### parents()
1046
+
1047
+ > **parents**(): `Promisable`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1048
+
1049
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:82
1050
+
1051
+ #### Returns
1052
+
1053
+ `Promisable`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1054
+
1055
+ #### Implementation of
1056
+
1057
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`parents`](../interfaces/DivinerInstance.md#parents)
1058
+
1059
+ #### Inherited from
1060
+
1061
+ [`ModuleWrapper`](ModuleWrapper.md).[`parents`](ModuleWrapper.md#parents)
1062
+
1063
+ ***
1064
+
1065
+ ### previousHash()
1066
+
1067
+ > **previousHash**(): `Promise`\<`undefined` \| `string`\>
1068
+
1069
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:83
1070
+
1071
+ #### Returns
1072
+
1073
+ `Promise`\<`undefined` \| `string`\>
1074
+
1075
+ #### Implementation of
1076
+
1077
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`previousHash`](../interfaces/DivinerInstance.md#previoushash)
1078
+
1079
+ #### Inherited from
1080
+
1081
+ [`ModuleWrapper`](ModuleWrapper.md).[`previousHash`](ModuleWrapper.md#previoushash)
1082
+
1083
+ ***
1084
+
1085
+ ### previousHashQuery()
1086
+
1087
+ > **previousHashQuery**(`account?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>\>
1088
+
1089
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:84
1090
+
1091
+ #### Parameters
1092
+
1093
+ ##### account?
1094
+
1095
+ `AccountInstance`
1096
+
1097
+ #### Returns
1098
+
1099
+ `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md)\>\>
1100
+
1101
+ #### Inherited from
1102
+
1103
+ [`ModuleWrapper`](ModuleWrapper.md).[`previousHashQuery`](ModuleWrapper.md#previoushashquery)
1104
+
1105
+ ***
1106
+
1107
+ ### privateChildren()
1108
+
1109
+ > **privateChildren**(): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1110
+
1111
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:85
1112
+
1113
+ #### Returns
1114
+
1115
+ `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1116
+
1117
+ #### Implementation of
1118
+
1119
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`privateChildren`](../interfaces/DivinerInstance.md#privatechildren)
1120
+
1121
+ #### Inherited from
1122
+
1123
+ [`ModuleWrapper`](ModuleWrapper.md).[`privateChildren`](ModuleWrapper.md#privatechildren)
1124
+
1125
+ ***
1126
+
1127
+ ### publicChildren()
1128
+
1129
+ > **publicChildren**(): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1130
+
1131
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:86
1132
+
1133
+ #### Returns
1134
+
1135
+ `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1136
+
1137
+ #### Implementation of
1138
+
1139
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`publicChildren`](../interfaces/DivinerInstance.md#publicchildren)
1140
+
1141
+ #### Inherited from
1142
+
1143
+ [`ModuleWrapper`](ModuleWrapper.md).[`publicChildren`](ModuleWrapper.md#publicchildren)
1144
+
1145
+ ***
1146
+
1147
+ ### query()
1148
+
1149
+ > **query**\<`T`\>(`query`, `payloads?`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
1150
+
1151
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:87
1152
+
1153
+ #### Type Parameters
1154
+
1155
+ ##### T
1156
+
1157
+ `T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
1158
+
1159
+ #### Parameters
1160
+
1161
+ ##### query
1162
+
1163
+ `T`
1164
+
1165
+ ##### payloads?
1166
+
1167
+ [`Payload`](../type-aliases/Payload.md)[]
1168
+
1169
+ #### Returns
1170
+
1171
+ `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
1172
+
1173
+ #### Implementation of
1174
+
1175
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`query`](../interfaces/DivinerInstance.md#query)
1176
+
1177
+ #### Inherited from
1178
+
1179
+ [`ModuleWrapper`](ModuleWrapper.md).[`query`](ModuleWrapper.md#query)
1180
+
1181
+ ***
1182
+
1183
+ ### queryable()
1184
+
1185
+ > **queryable**\<`T`\>(`query`, `payloads?`): `Promisable`\<`boolean`\>
1186
+
1187
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:88
1188
+
1189
+ #### Type Parameters
1190
+
1191
+ ##### T
1192
+
1193
+ `T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
1194
+
1195
+ #### Parameters
1196
+
1197
+ ##### query
1198
+
1199
+ `T`
1200
+
1201
+ ##### payloads?
1202
+
1203
+ [`Payload`](../type-aliases/Payload.md)[]
1204
+
1205
+ #### Returns
1206
+
1207
+ `Promisable`\<`boolean`\>
1208
+
1209
+ #### Implementation of
1210
+
1211
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`queryable`](../interfaces/DivinerInstance.md#queryable)
1212
+
1213
+ #### Inherited from
1214
+
1215
+ [`ModuleWrapper`](ModuleWrapper.md).[`queryable`](ModuleWrapper.md#queryable)
1216
+
1217
+ ***
1218
+
1219
+ ### removeParent()
1220
+
1221
+ > **removeParent**(`address`): `void`
1222
+
1223
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:89
1224
+
1225
+ #### Parameters
1226
+
1227
+ ##### address
1228
+
1229
+ `Lowercase`\<`string`\>
1230
+
1231
+ #### Returns
1232
+
1233
+ `void`
1234
+
1235
+ #### Implementation of
1236
+
1237
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`removeParent`](../interfaces/DivinerInstance.md#removeparent)
1238
+
1239
+ #### Inherited from
1240
+
1241
+ [`ModuleWrapper`](ModuleWrapper.md).[`removeParent`](ModuleWrapper.md#removeparent)
1242
+
1243
+ ***
1244
+
1245
+ ### ~~resolve()~~
1246
+
1247
+ #### Call Signature
1248
+
1249
+ > **resolve**\<`T`\>(): `Promise`\<`T`[]\>
1250
+
1251
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:91
1252
+
1253
+ ##### Type Parameters
1254
+
1255
+ ###### T
1256
+
1257
+ `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1258
+
1259
+ ##### Returns
1260
+
1261
+ `Promise`\<`T`[]\>
1262
+
1263
+ ##### Deprecated
1264
+
1265
+ do not pass undefined. If trying to get all, pass '*'
1266
+
1267
+ ##### Implementation of
1268
+
1269
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`resolve`](../interfaces/DivinerInstance.md#resolve)
1270
+
1271
+ ##### Inherited from
1272
+
1273
+ [`ModuleWrapper`](ModuleWrapper.md).[`resolve`](ModuleWrapper.md#resolve)
1274
+
1275
+ #### Call Signature
1276
+
1277
+ > **resolve**\<`T`\>(`all`, `options?`): `Promise`\<`T`[]\>
1278
+
1279
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:92
1280
+
1281
+ ##### Type Parameters
1282
+
1283
+ ###### T
1284
+
1285
+ `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1286
+
1287
+ ##### Parameters
1288
+
1289
+ ###### all
1290
+
1291
+ `"*"`
1292
+
1293
+ ###### options?
1294
+
1295
+ [`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
1296
+
1297
+ ##### Returns
1298
+
1299
+ `Promise`\<`T`[]\>
1300
+
1301
+ ##### Deprecated
1302
+
1303
+ do not pass undefined. If trying to get all, pass '*'
1304
+
1305
+ ##### Implementation of
1306
+
1307
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`resolve`](../interfaces/DivinerInstance.md#resolve)
1308
+
1309
+ ##### Inherited from
1310
+
1311
+ [`ModuleWrapper`](ModuleWrapper.md).[`resolve`](ModuleWrapper.md#resolve)
1312
+
1313
+ #### Call Signature
1314
+
1315
+ > **resolve**\<`T`\>(`id`, `options?`): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1316
+
1317
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:93
1318
+
1319
+ ##### Type Parameters
1320
+
1321
+ ###### T
1322
+
1323
+ `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1324
+
1325
+ ##### Parameters
1326
+
1327
+ ###### id
1328
+
1329
+ `string`
1330
+
1331
+ ###### options?
1332
+
1333
+ [`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
1334
+
1335
+ ##### Returns
1336
+
1337
+ `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1338
+
1339
+ ##### Deprecated
1340
+
1341
+ do not pass undefined. If trying to get all, pass '*'
1342
+
1343
+ ##### Implementation of
1344
+
1345
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`resolve`](../interfaces/DivinerInstance.md#resolve)
1346
+
1347
+ ##### Inherited from
1348
+
1349
+ [`ModuleWrapper`](ModuleWrapper.md).[`resolve`](ModuleWrapper.md#resolve)
1350
+
1351
+ ***
1352
+
1353
+ ### resolvePrivate()
1354
+
1355
+ #### Call Signature
1356
+
1357
+ > **resolvePrivate**\<`T`\>(`all`, `options?`): `Promise`\<`T`[]\>
1358
+
1359
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:94
1360
+
1361
+ ##### Type Parameters
1362
+
1363
+ ###### T
1364
+
1365
+ `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1366
+
1367
+ ##### Parameters
1368
+
1369
+ ###### all
1370
+
1371
+ `"*"`
1372
+
1373
+ ###### options?
1374
+
1375
+ [`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
1376
+
1377
+ ##### Returns
1378
+
1379
+ `Promise`\<`T`[]\>
1380
+
1381
+ ##### Implementation of
1382
+
1383
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`resolvePrivate`](../interfaces/DivinerInstance.md#resolveprivate)
1384
+
1385
+ ##### Inherited from
1386
+
1387
+ [`ModuleWrapper`](ModuleWrapper.md).[`resolvePrivate`](ModuleWrapper.md#resolveprivate)
1388
+
1389
+ #### Call Signature
1390
+
1391
+ > **resolvePrivate**\<`T`\>(`id`, `options?`): `Promise`\<`undefined` \| `T`\>
1392
+
1393
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:95
1394
+
1395
+ ##### Type Parameters
1396
+
1397
+ ###### T
1398
+
1399
+ `T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1400
+
1401
+ ##### Parameters
1402
+
1403
+ ###### id
1404
+
1405
+ `string`
1406
+
1407
+ ###### options?
1408
+
1409
+ [`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
1410
+
1411
+ ##### Returns
1412
+
1413
+ `Promise`\<`undefined` \| `T`\>
1414
+
1415
+ ##### Implementation of
1416
+
1417
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`resolvePrivate`](../interfaces/DivinerInstance.md#resolveprivate)
1418
+
1419
+ ##### Inherited from
1420
+
1421
+ [`ModuleWrapper`](ModuleWrapper.md).[`resolvePrivate`](ModuleWrapper.md#resolveprivate)
1422
+
1423
+ ***
1424
+
1425
+ ### siblings()
1426
+
1427
+ > **siblings**(): `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1428
+
1429
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:96
1430
+
1431
+ #### Returns
1432
+
1433
+ `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]\>
1434
+
1435
+ #### Implementation of
1436
+
1437
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`siblings`](../interfaces/DivinerInstance.md#siblings)
1438
+
1439
+ #### Inherited from
1440
+
1441
+ [`ModuleWrapper`](ModuleWrapper.md).[`siblings`](ModuleWrapper.md#siblings)
1442
+
1443
+ ***
1444
+
1445
+ ### state()
1446
+
1447
+ > **state**(): `Promise`\<[`Payload`](../type-aliases/Payload.md)[]\>
1448
+
1449
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:97
1450
+
1451
+ #### Returns
1452
+
1453
+ `Promise`\<[`Payload`](../type-aliases/Payload.md)[]\>
1454
+
1455
+ #### Implementation of
1456
+
1457
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`state`](../interfaces/DivinerInstance.md#state)
1458
+
1459
+ #### Inherited from
1460
+
1461
+ [`ModuleWrapper`](ModuleWrapper.md).[`state`](ModuleWrapper.md#state)
1462
+
1463
+ ***
1464
+
1465
+ ### stateQuery()
1466
+
1467
+ > **stateQuery**(`_account`): `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
1468
+
1469
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:98
1470
+
1471
+ #### Parameters
1472
+
1473
+ ##### \_account
1474
+
1475
+ `AccountInstance`
1476
+
1477
+ #### Returns
1478
+
1479
+ `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
1480
+
1481
+ #### Implementation of
1482
+
1483
+ [`DivinerInstance`](../interfaces/DivinerInstance.md).[`stateQuery`](../interfaces/DivinerInstance.md#statequery)
1484
+
1485
+ #### Inherited from
1486
+
1487
+ [`ModuleWrapper`](ModuleWrapper.md).[`stateQuery`](ModuleWrapper.md#statequery)
1488
+
1489
+ ***
1490
+
1491
+ ### canWrap()
1492
+
1493
+ > `static` **canWrap**(`mod?`): mod is Module\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\<void, void\>\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\]; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\] \}, ModuleEventData\<object\>\>
1494
+
1495
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:51
1496
+
1497
+ #### Parameters
1498
+
1499
+ ##### mod?
1500
+
1501
+ [`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1502
+
1503
+ #### Returns
1504
+
1505
+ mod is Module\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\<void, void\>\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\]; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random"; additionalSigners?: AccountInstance\[\]; addToResolvers?: boolean; allowNameResolution?: boolean; config: AnyConfigSchema\<ModuleConfig\>; ephemeralQueryAccountEnabled?: boolean; moduleIdentifierTransformers?: ModuleIdentifierTransformer\[\]; privateChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined; publicChildren?: ModuleInstance\<BaseParamsFields & \{ account?: AccountInstance \| "random" \| undefined; addToResolvers?: boolean \| undefined; additionalSigners?: AccountInstance\[\] \| undefined; ... 5 more ...; publicChildren?: ModuleInstance\<...\>\[\] \| undefined; \}, ModuleEventData\<...\>\>\[\] \| undefined \}, ModuleEventData\<object\>\>\[\] \}, ModuleEventData\<object\>\>
1506
+
1507
+ #### Inherited from
1508
+
1509
+ [`ModuleWrapper`](ModuleWrapper.md).[`canWrap`](ModuleWrapper.md#canwrap)
1510
+
1511
+ ***
1512
+
1513
+ ### gc()
1514
+
1515
+ #### Call Signature
1516
+
1517
+ > `static` **gc**(`force?`): `void`
1518
+
1519
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:29
1520
+
1521
+ ##### Parameters
1522
+
1523
+ ###### force?
1524
+
1525
+ `boolean`
1526
+
1527
+ ##### Returns
1528
+
1529
+ `void`
1530
+
1531
+ ##### Inherited from
1532
+
1533
+ [`ModuleWrapper`](ModuleWrapper.md).[`gc`](ModuleWrapper.md#gc)
1534
+
1535
+ #### Call Signature
1536
+
1537
+ > `static` **gc**(`className`): `void`
1538
+
1539
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:30
1540
+
1541
+ ##### Parameters
1542
+
1543
+ ###### className
1544
+
1545
+ `string`
1546
+
1547
+ ##### Returns
1548
+
1549
+ `void`
1550
+
1551
+ ##### Inherited from
1552
+
1553
+ [`ModuleWrapper`](ModuleWrapper.md).[`gc`](ModuleWrapper.md#gc)
1554
+
1555
+ ***
1556
+
1557
+ ### hasRequiredQueries()
1558
+
1559
+ > `static` **hasRequiredQueries**(`mod`): `boolean`
1560
+
1561
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:62
1562
+
1563
+ #### Parameters
1564
+
1565
+ ##### mod
1566
+
1567
+ [`Module`](../interfaces/Module.md)
1568
+
1569
+ #### Returns
1570
+
1571
+ `boolean`
1572
+
1573
+ #### Inherited from
1574
+
1575
+ [`ModuleWrapper`](ModuleWrapper.md).[`hasRequiredQueries`](ModuleWrapper.md#hasrequiredqueries)
1576
+
1577
+ ***
1578
+
1579
+ ### instanceCount()
1580
+
1581
+ > `static` **instanceCount**(`className`): `number`
1582
+
1583
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:31
1584
+
1585
+ #### Parameters
1586
+
1587
+ ##### className
1588
+
1589
+ `string`
1590
+
1591
+ #### Returns
1592
+
1593
+ `number`
1594
+
1595
+ #### Inherited from
1596
+
1597
+ [`ModuleWrapper`](ModuleWrapper.md).[`instanceCount`](ModuleWrapper.md#instancecount)
1598
+
1599
+ ***
1600
+
1601
+ ### instanceCounts()
1602
+
1603
+ > `static` **instanceCounts**(): `Record`\<`string`, `number`\>
1604
+
1605
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:32
1606
+
1607
+ #### Returns
1608
+
1609
+ `Record`\<`string`, `number`\>
1610
+
1611
+ #### Inherited from
1612
+
1613
+ [`ModuleWrapper`](ModuleWrapper.md).[`instanceCounts`](ModuleWrapper.md#instancecounts)
1614
+
1615
+ ***
1616
+
1617
+ ### is()
1618
+
1619
+ > `static` **is**\<`TModuleWrapper`\>(`this`, `wrapper`): `wrapper is TModuleWrapper`
1620
+
1621
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:63
1622
+
1623
+ #### Type Parameters
1624
+
1625
+ ##### TModuleWrapper
1626
+
1627
+ `TModuleWrapper` *extends* [`ModuleWrapper`](ModuleWrapper.md)\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1628
+
1629
+ #### Parameters
1630
+
1631
+ ##### this
1632
+
1633
+ [`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
1634
+
1635
+ ##### wrapper
1636
+
1637
+ `any`
1638
+
1639
+ #### Returns
1640
+
1641
+ `wrapper is TModuleWrapper`
1642
+
1643
+ #### Inherited from
1644
+
1645
+ [`ModuleWrapper`](ModuleWrapper.md).[`is`](ModuleWrapper.md#is)
1646
+
1647
+ ***
1648
+
1649
+ ### missingRequiredQueries()
1650
+
1651
+ > `static` **missingRequiredQueries**(`mod`): `string`[]
1652
+
1653
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:64
1654
+
1655
+ #### Parameters
1656
+
1657
+ ##### mod
1658
+
1659
+ [`Module`](../interfaces/Module.md)
1660
+
1661
+ #### Returns
1662
+
1663
+ `string`[]
1664
+
1665
+ #### Inherited from
1666
+
1667
+ [`ModuleWrapper`](ModuleWrapper.md).[`missingRequiredQueries`](ModuleWrapper.md#missingrequiredqueries)
1668
+
1669
+ ***
1670
+
1671
+ ### startHistory()
1672
+
1673
+ > `static` **startHistory**(): `void`
1674
+
1675
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:33
1676
+
1677
+ #### Returns
1678
+
1679
+ `void`
1680
+
1681
+ #### Inherited from
1682
+
1683
+ [`ModuleWrapper`](ModuleWrapper.md).[`startHistory`](ModuleWrapper.md#starthistory)
1684
+
1685
+ ***
1686
+
1687
+ ### stopHistory()
1688
+
1689
+ > `static` **stopHistory**(): `void`
1690
+
1691
+ Defined in: node\_modules/.store/@xylabs-base-npm-4.8.9-ca819b09fe/package/dist/types/Base.d.ts:34
1692
+
1693
+ #### Returns
1694
+
1695
+ `void`
1696
+
1697
+ #### Inherited from
1698
+
1699
+ [`ModuleWrapper`](ModuleWrapper.md).[`stopHistory`](ModuleWrapper.md#stophistory)
1700
+
1701
+ ***
1702
+
1703
+ ### tryWrap()
1704
+
1705
+ > `static` **tryWrap**\<`TModuleWrapper`\>(`this`, `mod`, `account`, `checkIdentity?`): `undefined` \| `TModuleWrapper`
1706
+
1707
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:65
1708
+
1709
+ #### Type Parameters
1710
+
1711
+ ##### TModuleWrapper
1712
+
1713
+ `TModuleWrapper` *extends* [`ModuleWrapper`](ModuleWrapper.md)\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1714
+
1715
+ #### Parameters
1716
+
1717
+ ##### this
1718
+
1719
+ [`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
1720
+
1721
+ ##### mod
1722
+
1723
+ `undefined` | [`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1724
+
1725
+ ##### account
1726
+
1727
+ `AccountInstance`
1728
+
1729
+ ##### checkIdentity?
1730
+
1731
+ `boolean`
1732
+
1733
+ #### Returns
1734
+
1735
+ `undefined` \| `TModuleWrapper`
1736
+
1737
+ #### Inherited from
1738
+
1739
+ [`ModuleWrapper`](ModuleWrapper.md).[`tryWrap`](ModuleWrapper.md#trywrap)
1740
+
1741
+ ***
1742
+
1743
+ ### with()
1744
+
1745
+ > `static` **with**\<`TModuleWrapper`, `R`\>(`this`, `mod`, `closure`): `undefined` \| `R`
1746
+
1747
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:66
1748
+
1749
+ #### Type Parameters
1750
+
1751
+ ##### TModuleWrapper
1752
+
1753
+ `TModuleWrapper` *extends* [`ModuleWrapper`](ModuleWrapper.md)\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1754
+
1755
+ ##### R
1756
+
1757
+ `R` *extends* `Promisable`\<`void`\> = `void`
1758
+
1759
+ #### Parameters
1760
+
1761
+ ##### this
1762
+
1763
+ [`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
1764
+
1765
+ ##### mod
1766
+
1767
+ `any`
1768
+
1769
+ ##### closure
1770
+
1771
+ (`mod`) => `R`
1772
+
1773
+ #### Returns
1774
+
1775
+ `undefined` \| `R`
1776
+
1777
+ #### Inherited from
1778
+
1779
+ [`ModuleWrapper`](ModuleWrapper.md).[`with`](ModuleWrapper.md#with)
1780
+
1781
+ ***
1782
+
1783
+ ### wrap()
1784
+
1785
+ > `static` **wrap**\<`TModuleWrapper`\>(`this`, `mod`, `account`, `checkIdentity?`): `TModuleWrapper`
1786
+
1787
+ Defined in: packages/modules/packages/module/packages/wrapper/dist/types/ModuleWrapper.d.ts:67
1788
+
1789
+ #### Type Parameters
1790
+
1791
+ ##### TModuleWrapper
1792
+
1793
+ `TModuleWrapper` *extends* [`ModuleWrapper`](ModuleWrapper.md)\<[`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>\>
1794
+
1795
+ #### Parameters
1796
+
1797
+ ##### this
1798
+
1799
+ [`ConstructableModuleWrapper`](../type-aliases/ConstructableModuleWrapper.md)\<`TModuleWrapper`\>
1800
+
1801
+ ##### mod
1802
+
1803
+ `undefined` | [`Module`](../interfaces/Module.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
1804
+
1805
+ ##### account
1806
+
1807
+ `AccountInstance`
1808
+
1809
+ ##### checkIdentity?
1810
+
1811
+ `boolean`
1812
+
1813
+ #### Returns
1814
+
1815
+ `TModuleWrapper`
1816
+
1817
+ #### Inherited from
1818
+
1819
+ [`ModuleWrapper`](ModuleWrapper.md).[`wrap`](ModuleWrapper.md#wrap)