← All procedures

pnpm.store.path

Get pnpm store path for snapshot/restore

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

Use it

In TypeScript

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

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

From the command line

$ mark pnpm store path

As data, in a program

{ "$proc": ["pnpm", "store", "path"], "input": {} }

Input

FieldTypeRequiredDefaultDescription
cwdstringnoWorking directory (affects store path on some configurations)

Output

FieldTypeRequiredDefaultDescription
pathstringyesThe absolute path of the pnpm store
existsbooleanyesTrue when the store folder exists
platformstringyesThe platform (win32, darwin, linux)
JSON Schemas
{
  "input": {
    "type": "object",
    "properties": {
      "cwd": {
        "description": "Working directory (affects store path on some configurations)",
        "type": "string"
      }
    }
  },
  "output": {
    "type": "object",
    "properties": {
      "path": {
        "type": "string",
        "description": "The absolute path of the pnpm store"
      },
      "exists": {
        "type": "boolean",
        "description": "True when the store folder exists"
      },
      "platform": {
        "type": "string",
        "description": "The platform (win32, darwin, linux)"
      }
    },
    "required": [
      "path",
      "exists",
      "platform"
    ],
    "additionalProperties": {}
  }
}