← All procedures

vitest.list

List the vitest watch processes of this host

CLI
Package
@procedures/vitest · README
Path
["vitest","list"]
CLI
mark vitest list
As data
{"$proc":["vitest","list"],"input":{}}

Use it

In TypeScript

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

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

From the command line

$ mark vitest list

As data, in a program

{ "$proc": ["vitest", "list"], "input": {} }

Input

FieldTypeRequiredDefaultDescription
outputbooleannoAlso give the end of the output of each process (the last 64 KiB)

Output

FieldTypeRequiredDefaultDescription
processesobject[]yesThe vitest watch processes of this host
JSON Schemas
{
  "input": {
    "type": "object",
    "properties": {
      "output": {
        "description": "Also give the end of the output of each process (the last 64 KiB)",
        "type": "boolean"
      }
    }
  },
  "output": {
    "type": "object",
    "properties": {
      "processes": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "The id that vitest.stop takes"
            },
            "pid": {
              "type": "number",
              "description": "The process id"
            },
            "cwd": {
              "description": "The folder of the project",
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "running",
                "exited",
                "error"
              ],
              "description": "The state of the process"
            },
            "startedAt": {
              "type": "string",
              "description": "The start time (ISO 8601)"
            },
            "exitedAt": {
              "description": "The end time (ISO 8601), when the process ended",
              "type": "string"
            },
            "exitCode": {
              "description": "The exit code, when the process ended",
              "type": "number"
            },
            "output": {
              "description": "With output: true, the last 64 KiB of the output",
              "type": "string"
            }
          },
          "required": [
            "id",
            "pid",
            "status",
            "startedAt"
          ],
          "additionalProperties": {}
        },
        "description": "The vitest watch processes of this host"
      }
    },
    "required": [
      "processes"
    ],
    "additionalProperties": {}
  }
}