@xyo-network/sdk-js 3.1.0 → 3.1.2

package/packages/node/packages/core/packages/modules-memory/dist/docs.json

@@ -0,0 +1,908 @@
+{
+	"id": 0,
+	"name": "@xyo-network/node-core-modules-memory",
+	"kind": 1,
+	"kindString": "Project",
+	"flags": {},
+	"originalName": "",
+	"children": [
+		{
+			"id": 1,
+			"name": "InMemoryQueue",
+			"kind": 128,
+			"kindString": "Class",
+			"flags": {},
+			"children": [
+				{
+					"id": 2,
+					"name": "constructor",
+					"kind": 512,
+					"kindString": "Constructor",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "modules-memory/src/Queue/InMemoryQueue.ts",
+							"line": 6,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/561a1435a/packages/node/packages/core/packages/modules-memory/src/Queue/InMemoryQueue.ts#L6"
+						}
+					],
+					"signatures": [
+						{
+							"id": 3,
+							"name": "new InMemoryQueue",
+							"kind": 16384,
+							"kindString": "Constructor signature",
+							"flags": {},
+							"typeParameter": [
+								{
+									"id": 4,
+									"name": "T",
+									"kind": 131072,
+									"kindString": "Type parameter",
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"name": "Identifiable"
+									}
+								}
+							],
+							"parameters": [
+								{
+									"id": 5,
+									"name": "transport",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "reference",
+												"id": 4,
+												"name": "T"
+											}
+										],
+										"name": "Transport"
+									},
+									"defaultValue": "..."
+								}
+							],
+							"type": {
+								"type": "reference",
+								"id": 1,
+								"typeArguments": [
+									{
+										"type": "reference",
+										"id": 4,
+										"name": "T"
+									}
+								],
+								"name": "InMemoryQueue"
+							},
+							"overwrites": {
+								"type": "reference",
+								"name": "Queue<T>.constructor"
+							}
+						}
+					],
+					"overwrites": {
+						"type": "reference",
+						"name": "Queue<T>.constructor"
+					}
+				},
+				{
+					"id": 15,
+					"name": "enqueue",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isReadonly": true
+					},
+					"sources": [
+						{
+							"fileName": "model/dist/types/Queue/Queue.d.ts",
+							"line": 7,
+							"character": 13
+						}
+					],
+					"type": {
+						"type": "reflection",
+						"declaration": {
+							"id": 16,
+							"name": "__type",
+							"kind": 65536,
+							"kindString": "Type literal",
+							"flags": {},
+							"sources": [
+								{
+									"fileName": "model/dist/types/Queue/Queue.d.ts",
+									"line": 7,
+									"character": 22
+								}
+							],
+							"signatures": [
+								{
+									"id": 17,
+									"name": "__type",
+									"kind": 4096,
+									"kindString": "Call signature",
+									"flags": {},
+									"parameters": [
+										{
+											"id": 18,
+											"name": "item",
+											"kind": 32768,
+											"kindString": "Parameter",
+											"flags": {},
+											"type": {
+												"type": "reference",
+												"id": 4,
+												"name": "T"
+											}
+										}
+									],
+									"type": {
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "intrinsic",
+												"name": "string"
+											}
+										],
+										"name": "Promise",
+										"qualifiedName": "Promise",
+										"package": "typescript"
+									}
+								}
+							]
+						}
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "Queue.enqueue"
+					}
+				},
+				{
+					"id": 19,
+					"name": "get",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isReadonly": true
+					},
+					"sources": [
+						{
+							"fileName": "model/dist/types/Queue/Queue.d.ts",
+							"line": 14,
+							"character": 13
+						}
+					],
+					"type": {
+						"type": "reflection",
+						"declaration": {
+							"id": 20,
+							"name": "__type",
+							"kind": 65536,
+							"kindString": "Type literal",
+							"flags": {},
+							"sources": [
+								{
+									"fileName": "model/dist/types/Queue/Queue.d.ts",
+									"line": 14,
+									"character": 18
+								}
+							],
+							"signatures": [
+								{
+									"id": 21,
+									"name": "__type",
+									"kind": 4096,
+									"kindString": "Call signature",
+									"flags": {},
+									"comment": {
+										"summary": [
+											{
+												"kind": "text",
+												"text": "Tries to get a query"
+											}
+										],
+										"blockTags": [
+											{
+												"tag": "@returns",
+												"content": [
+													{
+														"kind": "text",
+														"text": "The query if it exists, null if it's\nalready been dequeue, undefined if it doesn't exist"
+													}
+												]
+											}
+										]
+									},
+									"parameters": [
+										{
+											"id": 22,
+											"name": "id",
+											"kind": 32768,
+											"kindString": "Parameter",
+											"flags": {},
+											"comment": {
+												"summary": [
+													{
+														"kind": "text",
+														"text": "The id of the query to get"
+													}
+												]
+											},
+											"type": {
+												"type": "intrinsic",
+												"name": "string"
+											}
+										}
+									],
+									"type": {
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "union",
+												"types": [
+													{
+														"type": "intrinsic",
+														"name": "undefined"
+													},
+													{
+														"type": "literal",
+														"value": null
+													},
+													{
+														"type": "reference",
+														"id": 4,
+														"name": "T"
+													}
+												]
+											}
+										],
+										"name": "Promise",
+										"qualifiedName": "Promise",
+										"package": "typescript"
+									}
+								}
+							]
+						}
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "Queue.get"
+					}
+				},
+				{
+					"id": 7,
+					"name": "onDequeued",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "model/dist/types/Queue/Queue.d.ts",
+							"line": 4,
+							"character": 4
+						}
+					],
+					"type": {
+						"type": "reflection",
+						"declaration": {
+							"id": 8,
+							"name": "__type",
+							"kind": 65536,
+							"kindString": "Type literal",
+							"flags": {},
+							"sources": [
+								{
+									"fileName": "model/dist/types/Queue/Queue.d.ts",
+									"line": 4,
+									"character": 17
+								}
+							],
+							"signatures": [
+								{
+									"id": 9,
+									"name": "__type",
+									"kind": 4096,
+									"kindString": "Call signature",
+									"flags": {},
+									"parameters": [
+										{
+											"id": 10,
+											"name": "id",
+											"kind": 32768,
+											"kindString": "Parameter",
+											"flags": {},
+											"type": {
+												"type": "intrinsic",
+												"name": "string"
+											}
+										}
+									],
+									"type": {
+										"type": "intrinsic",
+										"name": "void"
+									}
+								}
+							]
+						}
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "Queue.onDequeued"
+					}
+				},
+				{
+					"id": 11,
+					"name": "onQueued",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "model/dist/types/Queue/Queue.d.ts",
+							"line": 5,
+							"character": 4
+						}
+					],
+					"type": {
+						"type": "reflection",
+						"declaration": {
+							"id": 12,
+							"name": "__type",
+							"kind": 65536,
+							"kindString": "Type literal",
+							"flags": {},
+							"sources": [
+								{
+									"fileName": "model/dist/types/Queue/Queue.d.ts",
+									"line": 5,
+									"character": 15
+								}
+							],
+							"signatures": [
+								{
+									"id": 13,
+									"name": "__type",
+									"kind": 4096,
+									"kindString": "Call signature",
+									"flags": {},
+									"parameters": [
+										{
+											"id": 14,
+											"name": "id",
+											"kind": 32768,
+											"kindString": "Parameter",
+											"flags": {},
+											"type": {
+												"type": "intrinsic",
+												"name": "string"
+											}
+										}
+									],
+									"type": {
+										"type": "intrinsic",
+										"name": "void"
+									}
+								}
+							]
+						}
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "Queue.onQueued"
+					}
+				},
+				{
+					"id": 6,
+					"name": "transport",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isProtected": true
+					},
+					"sources": [
+						{
+							"fileName": "modules-memory/src/Queue/InMemoryQueue.ts",
+							"line": 6,
+							"character": 24,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/561a1435a/packages/node/packages/core/packages/modules-memory/src/Queue/InMemoryQueue.ts#L6"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"typeArguments": [
+							{
+								"type": "reference",
+								"id": 4,
+								"name": "T"
+							}
+						],
+						"name": "Transport"
+					},
+					"defaultValue": "...",
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "Queue.transport"
+					}
+				},
+				{
+					"id": 23,
+					"name": "tryDequeue",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isReadonly": true
+					},
+					"sources": [
+						{
+							"fileName": "model/dist/types/Queue/Queue.d.ts",
+							"line": 21,
+							"character": 13
+						}
+					],
+					"type": {
+						"type": "reflection",
+						"declaration": {
+							"id": 24,
+							"name": "__type",
+							"kind": 65536,
+							"kindString": "Type literal",
+							"flags": {},
+							"sources": [
+								{
+									"fileName": "model/dist/types/Queue/Queue.d.ts",
+									"line": 21,
+									"character": 25
+								}
+							],
+							"signatures": [
+								{
+									"id": 25,
+									"name": "__type",
+									"kind": 4096,
+									"kindString": "Call signature",
+									"flags": {},
+									"comment": {
+										"summary": [
+											{
+												"kind": "text",
+												"text": "Tries to dequeue an item"
+											}
+										],
+										"blockTags": [
+											{
+												"tag": "@returns",
+												"content": [
+													{
+														"kind": "text",
+														"text": "The query if it exists, null if it's\nalready been dequeue, undefined if it doesn't exist"
+													}
+												]
+											}
+										]
+									},
+									"parameters": [
+										{
+											"id": 26,
+											"name": "id",
+											"kind": 32768,
+											"kindString": "Parameter",
+											"flags": {},
+											"comment": {
+												"summary": [
+													{
+														"kind": "text",
+														"text": "The id of the query to dequeue"
+													}
+												]
+											},
+											"type": {
+												"type": "intrinsic",
+												"name": "string"
+											}
+										}
+									],
+									"type": {
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "union",
+												"types": [
+													{
+														"type": "intrinsic",
+														"name": "undefined"
+													},
+													{
+														"type": "literal",
+														"value": null
+													},
+													{
+														"type": "reference",
+														"id": 4,
+														"name": "T"
+													}
+												]
+											}
+										],
+										"name": "Promise",
+										"qualifiedName": "Promise",
+										"package": "typescript"
+									}
+								}
+							]
+						}
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "Queue.tryDequeue"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Constructors",
+					"children": [
+						2
+					]
+				},
+				{
+					"title": "Properties",
+					"children": [
+						15,
+						19,
+						7,
+						11,
+						6,
+						23
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "modules-memory/src/Queue/InMemoryQueue.ts",
+					"line": 5,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/561a1435a/packages/node/packages/core/packages/modules-memory/src/Queue/InMemoryQueue.ts#L5"
+				}
+			],
+			"typeParameters": [
+				{
+					"id": 27,
+					"name": "T",
+					"kind": 131072,
+					"kindString": "Type parameter",
+					"flags": {},
+					"type": {
+						"type": "reference",
+						"name": "Identifiable"
+					}
+				}
+			],
+			"extendedTypes": [
+				{
+					"type": "reference",
+					"typeArguments": [
+						{
+							"type": "reference",
+							"id": 4,
+							"name": "T"
+						}
+					],
+					"name": "Queue"
+				}
+			]
+		},
+		{
+			"id": 28,
+			"name": "InMemoryTransport",
+			"kind": 128,
+			"kindString": "Class",
+			"flags": {},
+			"children": [
+				{
+					"id": 29,
+					"name": "constructor",
+					"kind": 512,
+					"kindString": "Constructor",
+					"flags": {},
+					"signatures": [
+						{
+							"id": 30,
+							"name": "new InMemoryTransport",
+							"kind": 16384,
+							"kindString": "Constructor signature",
+							"flags": {},
+							"typeParameter": [
+								{
+									"id": 31,
+									"name": "T",
+									"kind": 131072,
+									"kindString": "Type parameter",
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"name": "Identifiable"
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"id": 28,
+								"typeArguments": [
+									{
+										"type": "reference",
+										"id": 31,
+										"name": "T"
+									}
+								],
+								"name": "InMemoryTransport"
+							}
+						}
+					]
+				},
+				{
+					"id": 32,
+					"name": "queue",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isProtected": true
+					},
+					"sources": [
+						{
+							"fileName": "modules-memory/src/Transport/InMemoryTransport.ts",
+							"line": 5,
+							"character": 12,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/561a1435a/packages/node/packages/core/packages/modules-memory/src/Transport/InMemoryTransport.ts#L5"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"typeArguments": [
+							{
+								"type": "intrinsic",
+								"name": "string"
+							},
+							{
+								"type": "union",
+								"types": [
+									{
+										"type": "intrinsic",
+										"name": "undefined"
+									},
+									{
+										"type": "literal",
+										"value": null
+									},
+									{
+										"type": "reference",
+										"id": 31,
+										"name": "T"
+									}
+								]
+							}
+						],
+						"name": "Record",
+						"qualifiedName": "Record",
+						"package": "typescript"
+					},
+					"defaultValue": "{}"
+				},
+				{
+					"id": 33,
+					"name": "enqueue",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {
+						"isPublic": true
+					},
+					"sources": [
+						{
+							"fileName": "modules-memory/src/Transport/InMemoryTransport.ts",
+							"line": 7,
+							"character": 9,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/561a1435a/packages/node/packages/core/packages/modules-memory/src/Transport/InMemoryTransport.ts#L7"
+						}
+					],
+					"signatures": [
+						{
+							"id": 34,
+							"name": "enqueue",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"parameters": [
+								{
+									"id": 35,
+									"name": "item",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"id": 31,
+										"name": "T"
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "intrinsic",
+										"name": "string"
+									}
+								],
+								"name": "Promise",
+								"qualifiedName": "Promise",
+								"package": "typescript"
+							},
+							"implementationOf": {
+								"type": "reference",
+								"name": "Transport.enqueue"
+							}
+						}
+					],
+					"implementationOf": {
+						"type": "reference",
+						"name": "Transport.enqueue"
+					}
+				},
+				{
+					"id": 36,
+					"name": "get",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {
+						"isPublic": true
+					},
+					"sources": [
+						{
+							"fileName": "modules-memory/src/Transport/InMemoryTransport.ts",
+							"line": 13,
+							"character": 9,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/561a1435a/packages/node/packages/core/packages/modules-memory/src/Transport/InMemoryTransport.ts#L13"
+						}
+					],
+					"signatures": [
+						{
+							"id": 37,
+							"name": "get",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"parameters": [
+								{
+									"id": 38,
+									"name": "id",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "intrinsic",
+										"name": "string"
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "union",
+										"types": [
+											{
+												"type": "intrinsic",
+												"name": "undefined"
+											},
+											{
+												"type": "literal",
+												"value": null
+											},
+											{
+												"type": "reference",
+												"id": 31,
+												"name": "T"
+											}
+										]
+									}
+								],
+								"name": "Promise",
+								"qualifiedName": "Promise",
+								"package": "typescript"
+							},
+							"implementationOf": {
+								"type": "reference",
+								"name": "Transport.get"
+							}
+						}
+					],
+					"implementationOf": {
+						"type": "reference",
+						"name": "Transport.get"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Constructors",
+					"children": [
+						29
+					]
+				},
+				{
+					"title": "Properties",
+					"children": [
+						32
+					]
+				},
+				{
+					"title": "Methods",
+					"children": [
+						33,
+						36
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "modules-memory/src/Transport/InMemoryTransport.ts",
+					"line": 4,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/561a1435a/packages/node/packages/core/packages/modules-memory/src/Transport/InMemoryTransport.ts#L4"
+				}
+			],
+			"typeParameters": [
+				{
+					"id": 39,
+					"name": "T",
+					"kind": 131072,
+					"kindString": "Type parameter",
+					"flags": {},
+					"type": {
+						"type": "reference",
+						"name": "Identifiable"
+					}
+				}
+			],
+			"implementedTypes": [
+				{
+					"type": "reference",
+					"typeArguments": [
+						{
+							"type": "reference",
+							"id": 31,
+							"name": "T"
+						}
+					],
+					"name": "Transport"
+				}
+			]
+		}
+	],
+	"groups": [
+		{
+			"title": "Classes",
+			"children": [
+				1,
+				28
+			]
+		}
+	],
+	"sources": [
+		{
+			"fileName": "modules-memory/src/index.ts",
+			"line": 1,
+			"character": 0,
+			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/561a1435a/packages/node/packages/core/packages/modules-memory/src/index.ts#L1"
+		}
+	]
+}