← All procedures

procedure.remote

The status of the program store of the registry

CLI
Package
@procedures/store · README
Path
["procedure","remote"]
CLI
mark procedure remote --action <"status" | "connect" | "disconnect">
As data
{"$proc":["procedure","remote"],"input":{}}
Tags
procedure, registry, storage

Use it

In TypeScript

import { Client, LocalTransport, PROCEDURE_REGISTRY } from "@procedures/client";
import "@procedures/store"; // registers its procedures

const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
const result = await client.exec(["procedure","remote"], { action: "status" });
console.log(JSON.stringify(result));

From the command line

$ mark procedure remote --action <"status" | "connect" | "disconnect">

As data, in a program

{ "$proc": ["procedure", "remote"], "input": { "action": "status" } }

Input

FieldTypeRequiredDefaultDescription
action"status" | "connect" | "disconnect"yesstatus: the store of the registry. connect and disconnect: not implemented (the host makes the store)

Output

The schema does not list fields (object).

JSON Schemas
{
  "input": {
    "type": "object",
    "properties": {
      "action": {
        "type": "string",
        "enum": [
          "status",
          "connect",
          "disconnect"
        ],
        "description": "status: the store of the registry. connect and disconnect: not implemented (the host makes the store)"
      }
    },
    "required": [
      "action"
    ]
  },
  "output": {
    "type": "object"
  }
}