`vitest.stop`

Stop a vitest watch process (all of them without an id)

CLI

Package: @procedures/vitest · README
Path: ["vitest","stop"]
CLI: mark vitest stop
As data: {"$proc":["vitest","stop"],"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","stop"], {});
console.log(JSON.stringify(result));

From the command line

$ mark vitest stop

As data, in a program

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

Input

Field	Type	Required	Default	Description
`id`	`string`	no		The id that vitest.watch gave. Without it, every vitest watch process stops.

Output

Field	Type	Required	Default	Description
`success`	`boolean`	yes		False when an id was given and no running watch process has it
`stopped`	`string[]`	yes		The ids of the processes that stopped

JSON Schemas

{
  "input": {
    "type": "object",
    "properties": {
      "id": {
        "description": "The id that vitest.watch gave. Without it, every vitest watch process stops.",
        "type": "string"
      }
    }
  },
  "output": {
    "type": "object",
    "properties": {
      "success": {
        "type": "boolean",
        "description": "False when an id was given and no running watch process has it"
      },
      "stopped": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The ids of the processes that stopped"
      }
    },
    "required": [
      "success",
      "stopped"
    ],
    "additionalProperties": {}
  }
}