← All procedures

vite.stop

Stop a running Vite server

CLI
Package
@procedures/vite · README
Path
["vite","stop"]
CLI
mark vite stop --serverId <string>
As data
{"$proc":["vite","stop"],"input":{}}

Use it

In TypeScript

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

const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
const result = await client.exec(["vite","stop"], { serverId: "<serverId>" });
console.log(JSON.stringify(result));

From the command line

$ mark vite stop --serverId <string>

As data, in a program

{ "$proc": ["vite", "stop"], "input": { "serverId": "<serverId>" } }

Input

FieldTypeRequiredDefaultDescription
serverIdstringyesServer ID to stop

Output

FieldTypeRequiredDefaultDescription
successbooleanyesTrue when the server stopped
JSON Schemas
{
  "input": {
    "type": "object",
    "properties": {
      "serverId": {
        "type": "string",
        "description": "Server ID to stop"
      }
    },
    "required": [
      "serverId"
    ]
  },
  "output": {
    "type": "object",
    "properties": {
      "success": {
        "type": "boolean",
        "description": "True when the server stopped"
      }
    },
    "required": [
      "success"
    ],
    "additionalProperties": {}
  }
}