address
address: Lowercase<string>
Optional
modName
modName?: string
previousHash
previousHash: () => Promisable<undefined | string>
query
query: < T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness, TConf extends DeepRestrictToStringKeys< { allowedQueries?: string[]; archiving?: { archivists?: string[]; queries?: string[] }; archivist?: string; consoleLogger?: LogLevel; labels?: { [key: string]: undefined | string }; name?: string; paging?: { [key: string]: { size?: number } }; retry?: { backoff?: number; interval?: number; retries?: number }; schema: "network.xyo.module.config"; security?: { allowAnonymous?: boolean; allowed?: { [key: string]: (
Lowercase<string> | Lowercase<(...)
>[])
[] }; disallowed?: { [key: string]: Lowercase<string>[] }; }; sign?: boolean; storeQueries?: boolean; timestamp?: boolean; }, > = DeepRestrictToStringKeys< { allowedQueries?: string[]; archiving?: { archivists?: string[]; queries?: string[] }; archivist?: string; consoleLogger?: LogLevel; labels?: { [key: string]: undefined | string }; name?: string; paging?: { [key: string]: { size?: number } }; retry?: { backoff?: number; interval?: number; retries?: number }; schema: "network.xyo.module.config"; security?: { allowAnonymous?: boolean; allowed?: { [key: string]: (
Lowercase<string> | Lowercase<(...)
>[])
[] }; disallowed?: { [key: string]: Lowercase<string>[] }; }; sign?: boolean; storeQueries?: boolean; timestamp?: boolean; }, >,>( query: T, payloads?: DeepRestrictToStringKeys<{ schema: string }>[], queryConfig?: TConf,) => Promisable<ModuleQueryResult> queryable
queryable: < T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness, TConf extends DeepRestrictToStringKeys< { allowedQueries?: string[]; archiving?: { archivists?: string[]; queries?: string[] }; archivist?: string; consoleLogger?: LogLevel; labels?: { [key: string]: undefined | string }; name?: string; paging?: { [key: string]: { size?: number } }; retry?: { backoff?: number; interval?: number; retries?: number }; schema: "network.xyo.module.config"; security?: { allowAnonymous?: boolean; allowed?: { [key: string]: (
Lowercase<string> | Lowercase<(...)
>[])
[] }; disallowed?: { [key: string]: Lowercase<string>[] }; }; sign?: boolean; storeQueries?: boolean; timestamp?: boolean; }, > = DeepRestrictToStringKeys< { allowedQueries?: string[]; archiving?: { archivists?: string[]; queries?: string[] }; archivist?: string; consoleLogger?: LogLevel; labels?: { [key: string]: undefined | string }; name?: string; paging?: { [key: string]: { size?: number } }; retry?: { backoff?: number; interval?: number; retries?: number }; schema: "network.xyo.module.config"; security?: { allowAnonymous?: boolean; allowed?: { [key: string]: (
Lowercase<string> | Lowercase<(...)
>[])
[] }; disallowed?: { [key: string]: Lowercase<string>[] }; }; sign?: boolean; storeQueries?: boolean; timestamp?: boolean; }, >,>( query: T, payloads?: DeepRestrictToStringKeys<{ schema: string }>[], queryConfig?: TConf,) => Promisable<boolean> Optional
start
start?: () => Promisable<boolean>
Optional
stop
stop?: () => Promisable<boolean>
The name (if specified) or address of the module