@xyo-network/react-node 2.33.1

package/dist/docs.json

@@ -0,0 +1,803 @@
+{
+	"id": 0,
+	"name": "@xyo-network/react-node",
+	"kind": 1,
+	"kindString": "Project",
+	"flags": {},
+	"originalName": "",
+	"children": [
+		{
+			"id": 11,
+			"name": "XyoNodeContextState",
+			"kind": 256,
+			"kindString": "Interface",
+			"flags": {},
+			"children": [
+				{
+					"id": 12,
+					"name": "node",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/node/src/contexts/State.ts",
+							"line": 6,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/State.ts#L6"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"typeArguments": [
+							{
+								"type": "reference",
+								"id": 14,
+								"name": "T"
+							}
+						],
+						"name": "XyoNode",
+						"qualifiedName": "XyoNode",
+						"package": "@xyo-network/node"
+					}
+				},
+				{
+					"id": 13,
+					"name": "setNode",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/node/src/contexts/State.ts",
+							"line": 7,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/State.ts#L7"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"typeArguments": [
+							{
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"id": 14,
+										"name": "T"
+									}
+								],
+								"name": "XyoNode",
+								"qualifiedName": "XyoNode",
+								"package": "@xyo-network/node"
+							}
+						],
+						"name": "Dispatch",
+						"qualifiedName": "React.Dispatch",
+						"package": "@types/react"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Properties",
+					"children": [
+						12,
+						13
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/node/src/contexts/State.ts",
+					"line": 5,
+					"character": 17,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/State.ts#L5"
+				}
+			],
+			"typeParameters": [
+				{
+					"id": 14,
+					"name": "T",
+					"kind": 131072,
+					"kindString": "Type parameter",
+					"flags": {},
+					"type": {
+						"type": "reference",
+						"name": "XyoModule",
+						"qualifiedName": "XyoModule",
+						"package": "@xyo-network/module"
+					},
+					"default": {
+						"type": "reference",
+						"name": "XyoModule",
+						"qualifiedName": "XyoModule",
+						"package": "@xyo-network/module"
+					}
+				}
+			]
+		},
+		{
+			"id": 3,
+			"name": "XyoNodeProviderProps",
+			"kind": 256,
+			"kindString": "Interface",
+			"flags": {},
+			"children": [
+				{
+					"id": 5,
+					"name": "node",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/node/src/contexts/Provider.tsx",
+							"line": 9,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/Provider.tsx#L9"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"typeArguments": [
+							{
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "reflection",
+												"declaration": {
+													"id": 6,
+													"name": "__type",
+													"kind": 65536,
+													"kindString": "Type literal",
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "node_modules/@xyo-network/payload/dist/esm/models/Base.d.ts",
+															"line": 7,
+															"character": 107
+														}
+													]
+												}
+											}
+										],
+										"name": "XyoModuleConfig",
+										"qualifiedName": "XyoModuleConfig",
+										"package": "@xyo-network/module"
+									}
+								],
+								"name": "XyoModule",
+								"qualifiedName": "XyoModule",
+								"package": "@xyo-network/module"
+							}
+						],
+						"name": "XyoNode",
+						"qualifiedName": "XyoNode",
+						"package": "@xyo-network/node"
+					}
+				},
+				{
+					"id": 4,
+					"name": "required",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/node/src/contexts/Provider.tsx",
+							"line": 8,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/Provider.tsx#L8"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "boolean"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Properties",
+					"children": [
+						5,
+						4
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/node/src/contexts/Provider.tsx",
+					"line": 7,
+					"character": 17,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/Provider.tsx#L7"
+				}
+			]
+		},
+		{
+			"id": 1,
+			"name": "XyoNodeContext",
+			"kind": 32,
+			"kindString": "Variable",
+			"flags": {
+				"isConst": true
+			},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/node/src/contexts/Context.ts",
+					"line": 5,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/Context.ts#L5"
+				}
+			],
+			"type": {
+				"type": "reference",
+				"typeArguments": [
+					{
+						"type": "intersection",
+						"types": [
+							{
+								"type": "reference",
+								"id": 11,
+								"typeArguments": [
+									{
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "reference",
+												"typeArguments": [
+													{
+														"type": "reflection",
+														"declaration": {
+															"id": 2,
+															"name": "__type",
+															"kind": 65536,
+															"kindString": "Type literal",
+															"flags": {},
+															"sources": [
+																{
+																	"fileName": "node_modules/@xyo-network/payload/dist/esm/models/Base.d.ts",
+																	"line": 7,
+																	"character": 107
+																}
+															]
+														}
+													}
+												],
+												"name": "XyoModuleConfig",
+												"qualifiedName": "XyoModuleConfig",
+												"package": "@xyo-network/module"
+											}
+										],
+										"name": "XyoModule",
+										"qualifiedName": "XyoModule",
+										"package": "@xyo-network/module"
+									}
+								],
+								"name": "XyoNodeContextState"
+							},
+							{
+								"type": "reference",
+								"name": "ContextExState"
+							}
+						]
+					}
+				],
+				"name": "Context",
+				"qualifiedName": "React.Context",
+				"package": "@types/react"
+			},
+			"defaultValue": "..."
+		},
+		{
+			"id": 7,
+			"name": "XyoNodeProvider",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/node/src/contexts/Provider.tsx",
+					"line": 12,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/Provider.tsx#L12"
+				}
+			],
+			"signatures": [
+				{
+					"id": 8,
+					"name": "XyoNodeProvider",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 9,
+							"name": "props",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"id": 3,
+										"name": "XyoNodeProviderProps"
+									}
+								],
+								"name": "WithChildren",
+								"qualifiedName": "WithChildren",
+								"package": "@xylabs/react-shared"
+							}
+						},
+						{
+							"id": 10,
+							"name": "context",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "any"
+							}
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "literal",
+								"value": null
+							},
+							{
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "intrinsic",
+										"name": "any"
+									},
+									{
+										"type": "intrinsic",
+										"name": "any"
+									}
+								],
+								"name": "ReactElement",
+								"qualifiedName": "React.ReactElement",
+								"package": "@types/react"
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 15,
+			"name": "useArchivistModule",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/node/src/contexts/useArchivistModule.ts",
+					"line": 5,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/useArchivistModule.ts#L5"
+				}
+			],
+			"signatures": [
+				{
+					"id": 16,
+					"name": "useArchivistModule",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 17,
+							"name": "address",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "intrinsic",
+								"name": "undefined"
+							},
+							{
+								"type": "reference",
+								"name": "XyoArchivistWrapper",
+								"qualifiedName": "XyoArchivistWrapper",
+								"package": "@xyo-network/archivist"
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 18,
+			"name": "useDivinerModule",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/node/src/contexts/useDivinerModule.ts",
+					"line": 5,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/useDivinerModule.ts#L5"
+				}
+			],
+			"signatures": [
+				{
+					"id": 19,
+					"name": "useDivinerModule",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 20,
+							"name": "address",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "intrinsic",
+								"name": "undefined"
+							},
+							{
+								"type": "reference",
+								"name": "XyoDivinerWrapper",
+								"qualifiedName": "XyoDivinerWrapper",
+								"package": "@xyo-network/diviner"
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 21,
+			"name": "useModule",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/node/src/contexts/useModule.ts",
+					"line": 3,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/useModule.ts#L3"
+				}
+			],
+			"signatures": [
+				{
+					"id": 22,
+					"name": "useModule",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 23,
+							"name": "address",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "intrinsic",
+								"name": "undefined"
+							},
+							{
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "reflection",
+												"declaration": {
+													"id": 24,
+													"name": "__type",
+													"kind": 65536,
+													"kindString": "Type literal",
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "node_modules/@xyo-network/payload/dist/esm/models/Base.d.ts",
+															"line": 7,
+															"character": 107
+														}
+													]
+												}
+											}
+										],
+										"name": "XyoModuleConfig",
+										"qualifiedName": "XyoModuleConfig",
+										"package": "@xyo-network/module"
+									}
+								],
+								"name": "XyoModule",
+								"qualifiedName": "XyoModule",
+								"package": "@xyo-network/module"
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 25,
+			"name": "useNode",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/node/src/contexts/useNode.ts",
+					"line": 7,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/useNode.ts#L7"
+				}
+			],
+			"signatures": [
+				{
+					"id": 26,
+					"name": "useNode",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"type": {
+						"type": "tuple",
+						"elements": [
+							{
+								"type": "union",
+								"types": [
+									{
+										"type": "intrinsic",
+										"name": "undefined"
+									},
+									{
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "reference",
+												"typeArguments": [
+													{
+														"type": "reference",
+														"typeArguments": [
+															{
+																"type": "reflection",
+																"declaration": {
+																	"id": 27,
+																	"name": "__type",
+																	"kind": 65536,
+																	"kindString": "Type literal",
+																	"flags": {},
+																	"sources": [
+																		{
+																			"fileName": "node_modules/@xyo-network/payload/dist/esm/models/Base.d.ts",
+																			"line": 7,
+																			"character": 107
+																		}
+																	]
+																}
+															}
+														],
+														"name": "XyoModuleConfig",
+														"qualifiedName": "XyoModuleConfig",
+														"package": "@xyo-network/module"
+													}
+												],
+												"name": "XyoModule",
+												"qualifiedName": "XyoModule",
+												"package": "@xyo-network/module"
+											}
+										],
+										"name": "XyoNode",
+										"qualifiedName": "XyoNode",
+										"package": "@xyo-network/node"
+									}
+								]
+							},
+							{
+								"type": "union",
+								"types": [
+									{
+										"type": "intrinsic",
+										"name": "undefined"
+									},
+									{
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "reference",
+												"typeArguments": [
+													{
+														"type": "reference",
+														"typeArguments": [
+															{
+																"type": "reference",
+																"typeArguments": [
+																	{
+																		"type": "reflection",
+																		"declaration": {
+																			"id": 28,
+																			"name": "__type",
+																			"kind": 65536,
+																			"kindString": "Type literal",
+																			"flags": {},
+																			"sources": [
+																				{
+																					"fileName": "node_modules/@xyo-network/payload/dist/esm/models/Base.d.ts",
+																					"line": 7,
+																					"character": 107
+																				}
+																			]
+																		}
+																	}
+																],
+																"name": "XyoModuleConfig",
+																"qualifiedName": "XyoModuleConfig",
+																"package": "@xyo-network/module"
+															}
+														],
+														"name": "XyoModule",
+														"qualifiedName": "XyoModule",
+														"package": "@xyo-network/module"
+													}
+												],
+												"name": "XyoNode",
+												"qualifiedName": "XyoNode",
+												"package": "@xyo-network/node"
+											}
+										],
+										"name": "Dispatch",
+										"qualifiedName": "React.Dispatch",
+										"package": "@types/react"
+									}
+								]
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 29,
+			"name": "useWitnessModule",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/node/src/contexts/useWitnessModule.ts",
+					"line": 5,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/contexts/useWitnessModule.ts#L5"
+				}
+			],
+			"signatures": [
+				{
+					"id": 30,
+					"name": "useWitnessModule",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 31,
+							"name": "address",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "intrinsic",
+								"name": "undefined"
+							},
+							{
+								"type": "reference",
+								"name": "XyoWitnessWrapper",
+								"qualifiedName": "XyoWitnessWrapper",
+								"package": "@xyo-network/witness"
+							}
+						]
+					}
+				}
+			]
+		}
+	],
+	"groups": [
+		{
+			"title": "Interfaces",
+			"children": [
+				11,
+				3
+			]
+		},
+		{
+			"title": "Variables",
+			"children": [
+				1
+			]
+		},
+		{
+			"title": "Functions",
+			"children": [
+				7,
+				15,
+				18,
+				21,
+				25,
+				29
+			]
+		}
+	],
+	"sources": [
+		{
+			"fileName": "packages/sdk/packages/node/src/index.ts",
+			"line": 1,
+			"character": 0,
+			"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/343afa3f/packages/sdk/packages/node/src/index.ts#L1"
+		}
+	]
+}