api-index.md

API Index

Every subpath exported by @socketsecurity/lib, grouped by namespace. Each entry links to the source module and shows the first sentence of its @fileoverview.

Regenerate with node scripts/fix/generate-api-index.mts after adding or removing exports. Do not edit this file by hand.

Jump to: Top-level · ai/ · argv/ · bin/ · checks/ · constants/ · cover/ · dlx/ · eco/ · effects/ · env/ · fs/ · git/ · github/ · http-request/ · json/ · logger/ · node/ · packages/ · paths/ · releases/ · schema/ · sea/ · smol/ · spinner/ · stdio/ · themes/

Top-level

Subpath	Description
@socketsecurity/lib/abort	Abort signal utilities.
@socketsecurity/lib/ansi	ANSI escape code utilities.
@socketsecurity/lib/archives	Generic archive extraction utilities.
@socketsecurity/lib/arrays	Array utility functions for formatting lists and collections.
@socketsecurity/lib/cacache	Cacache utilities for Socket ecosystem shared content-addressable cache.
@socketsecurity/lib/cache-with-ttl	Generic TTL-based caching utility using cacache.
@socketsecurity/lib/colors	Color utilities for RGB color conversion and manipulation.
@socketsecurity/lib/compression	Async compression / decompression helpers (brotli + gzip).
@socketsecurity/lib/crypto	Crypto helpers that prefer Node builtins where available.
@socketsecurity/lib/debug	Debug logging utilities with lazy loading and environment-based control.
@socketsecurity/lib/env	Environment variable parsing and conversion utilities.
@socketsecurity/lib/errors	Error utilities with cause chain support.
@socketsecurity/lib/globs	Glob pattern matching utilities with default ignore patterns.
@socketsecurity/lib/ipc	Secure inter-process communication utilities for Socket CLI.
@socketsecurity/lib/ipc-cli	Socket CLI child-process IPC object getter.
@socketsecurity/lib/links	Themed hyperlink utilities for terminal output.
@socketsecurity/lib/memoization	Memoization utilities for caching function results.
@socketsecurity/lib/objects	Object manipulation and reflection utilities.
@socketsecurity/lib/package-extensions	Package extensions for compatibility adjustments.
@socketsecurity/lib/packages	Package registry management with Socket.dev specific utilities.
@socketsecurity/lib/performance	Performance monitoring utilities for profiling and optimization.
@socketsecurity/lib/primordials	Safe references to built-in functions and constructors.
@socketsecurity/lib/process-lock	Process locking utilities with stale detection and exit cleanup.
@socketsecurity/lib/promise-queue	Bounded concurrency promise queue.
@socketsecurity/lib/promises	Promise utilities including chunked iteration and timers.
@socketsecurity/lib/regexps	Regular expression utilities including a spec-compliant RegExp.escape fallback.
@socketsecurity/lib/shadow	Shadow binary installation utilities for Socket ecosystem.
@socketsecurity/lib/signal-exit	Process signal handling utilities.
@socketsecurity/lib/sorts	Sorting comparison functions including locale-aware and natural sorting.
@socketsecurity/lib/spawn	Child process spawning utilities with cross-platform support.
@socketsecurity/lib/ssri	SSRI (Subresource Integrity) hash format utilities.
@socketsecurity/lib/streams	Stream processing utilities with streaming-iterables integration.
@socketsecurity/lib/strings	String manipulation utilities including ANSI code handling.
@socketsecurity/lib/suppress-warnings	Utilities to suppress specific process warnings.
@socketsecurity/lib/tables	Table formatting utilities for CLI applications.
@socketsecurity/lib/temporary-executor	Temporary package executor detection utilities for Socket ecosystem.
@socketsecurity/lib/types	Type definitions for Socket Registry.
@socketsecurity/lib/url	URL parsing and validation utilities.
@socketsecurity/lib/versions	Version comparison and validation utilities for Socket ecosystem.
@socketsecurity/lib/words	Word manipulation utilities for capitalization and formatting.

ai/

Subpath	Description
@socketsecurity/lib/ai/discover	(no description)
@socketsecurity/lib/ai/profiles	(no description)
@socketsecurity/lib/ai/spawn	(no description)
@socketsecurity/lib/ai/types	(no description)
@socketsecurity/lib/ai/worktree	(no description)

argv/

Subpath	Description
@socketsecurity/lib/argv/flags	Common flag utilities for Socket CLI applications.
@socketsecurity/lib/argv/parse	Argument parsing utilities for CLI applications.

bin/

Subpath	Description
@socketsecurity/lib/bin/check	socket-lib check <name> subcommand group.
@socketsecurity/lib/bin/check-primordials	socket-lib check primordials handler.
@socketsecurity/lib/bin/exec	execBin — spawn a binary with PATH resolution, wrapper-script unwrapping, and Windows shell handling.
@socketsecurity/lib/bin/find	Find specific package-manager binaries with platform- aware fallbacks.
@socketsecurity/lib/bin/resolve	Resolve a binary path to the underlying script file.
@socketsecurity/lib/bin/shadow	Shadow-bin detection.
@socketsecurity/lib/bin/socket-lib	socket-lib CLI entry point — top-level dispatcher.
@socketsecurity/lib/bin/types	Public type surface for bin/* modules — the WhichOptions interface that callers pass to which, whichSync, whichReal, and whichRealSync.
@socketsecurity/lib/bin/which	Look up binaries on PATH.

checks/

Subpath	Description
@socketsecurity/lib/checks/primordials	Primordials drift check — generic core.

constants/

Subpath	Description
@socketsecurity/lib/constants/agents	Package manager agent constants.
@socketsecurity/lib/constants/core	Core primitives and fundamental constants.
@socketsecurity/lib/constants/encoding	Character encoding and character code constants.
@socketsecurity/lib/constants/github	GitHub API and cache constants.
@socketsecurity/lib/constants/licenses	License identifier constants.
@socketsecurity/lib/constants/lifecycle-script-names	NPM lifecycle script names.
@socketsecurity/lib/constants/maintained-node-versions	Maintained Node.js versions without external dependencies.
@socketsecurity/lib/constants/node	Node.js runtime version and capability helpers.
@socketsecurity/lib/constants/package-default-node-range	Default Node.js version range for packages.
@socketsecurity/lib/constants/package-default-socket-categories	Default Socket security categories for packages.
@socketsecurity/lib/constants/packages	Package metadata, defaults, extensions, and lifecycle helpers.
@socketsecurity/lib/constants/platform	Platform detection and OS-specific constants.
@socketsecurity/lib/constants/process	Process control helpers.
@socketsecurity/lib/constants/socket	Socket.dev branding and identifier constants.
@socketsecurity/lib/constants/testing	Testing framework and CI-related string constants.
@socketsecurity/lib/constants/time	Time-related numeric constants.
@socketsecurity/lib/constants/typescript	TypeScript availability detection.

cover/

Subpath	Description
@socketsecurity/lib/cover/code	Code coverage utilities for parsing v8 coverage data.
@socketsecurity/lib/cover/formatters	Coverage output formatters.
@socketsecurity/lib/cover/type	TypeScript type coverage utilities.
@socketsecurity/lib/cover/types	Type definitions for coverage utilities.

dlx/

Subpath	Description
@socketsecurity/lib/dlx/arborist	Safe Arborist wrapper for dlx installs and lockfile-only resolution.
@socketsecurity/lib/dlx/binary	DLX binary execution utilities for Socket ecosystem.
@socketsecurity/lib/dlx/cache	Cache key generation utilities for DLX package installations.
@socketsecurity/lib/dlx/detect	Executable type detection for DLX and local filesystem paths.
@socketsecurity/lib/dlx/dir	Directory management utilities for DLX installations.
@socketsecurity/lib/dlx/integrity	Integrity specification helpers for dlx downloads.
@socketsecurity/lib/dlx/lockfile	Package pin generation for dlx installs.
@socketsecurity/lib/dlx/manifest	DLX manifest storage utilities.
@socketsecurity/lib/dlx/package	DLX package execution - Install and execute npm packages.
@socketsecurity/lib/dlx/packages	Package management utilities for DLX installations.
@socketsecurity/lib/dlx/paths	Path utilities for DLX package installations.

eco/

Subpath	Description
@socketsecurity/lib/eco/npm	npm-ecosystem package manager surface.
@socketsecurity/lib/eco/npm/bun	Bun tool surface.
@socketsecurity/lib/eco/npm/npm	(no description)
@socketsecurity/lib/eco/npm/npm/exec	Execute npm commands with optimized flags and security defaults.
@socketsecurity/lib/eco/npm/npm/flags	npm CLI flag predicates.
@socketsecurity/lib/eco/npm/pnpm	(no description)
@socketsecurity/lib/eco/npm/pnpm/exec	Execute pnpm commands with optimized flags and security defaults.
@socketsecurity/lib/eco/npm/pnpm/flags	pnpm CLI flag predicates.
@socketsecurity/lib/eco/npm/script	Cross-tool script runner — picks the right package manager by detecting the nearest lockfile and dispatches to its exec function.
@socketsecurity/lib/eco/npm/vlt	vlt tool surface.
@socketsecurity/lib/eco/npm/yarnpkg	Yarn family barrel — Classic + Berry + ZPM.
@socketsecurity/lib/eco/npm/yarnpkg/berry	Yarn Berry (v2-v5) tool surface.
@socketsecurity/lib/eco/npm/yarnpkg/yarn	(no description)
@socketsecurity/lib/eco/npm/yarnpkg/yarn/exec	Execute Yarn Classic (v1.x) commands with optimized flags and security defaults.
@socketsecurity/lib/eco/npm/yarnpkg/zpm	ZPM (Yarn 6+, Rust rewrite at yarnpkg/zpm) tool surface.

effects/

Subpath	Description
@socketsecurity/lib/effects/pulse-frames	Socket pulse animation frames generator.
@socketsecurity/lib/effects/shimmer	Shimmer animation engine — pure functions, zero deps.
@socketsecurity/lib/effects/shimmer-keyframes	SVG keyframe batcher for the shimmer engine.
@socketsecurity/lib/effects/shimmer-terminal	Terminal renderer for the shimmer engine.

env/

Subpath	Description
@socketsecurity/lib/env/ci	CI environment variable getter.
@socketsecurity/lib/env/debug	DEBUG environment variable getter.
@socketsecurity/lib/env/github	GitHub Actions environment variable getters.
@socketsecurity/lib/env/helpers	Environment variable type conversion helpers.
@socketsecurity/lib/env/home	HOME environment variable getter with Windows fallback.
@socketsecurity/lib/env/locale	Locale and language environment variable getters.
@socketsecurity/lib/env/node-auth-token	NODE_AUTH_TOKEN environment variable getter.
@socketsecurity/lib/env/node-env	NODE_ENV environment variable getter.
@socketsecurity/lib/env/npm	NPM environment variable getters.
@socketsecurity/lib/env/package-manager	Package manager environment detection.
@socketsecurity/lib/env/path	PATH environment variable getter.
@socketsecurity/lib/env/pre-commit	PRE_COMMIT environment variable getter.
@socketsecurity/lib/env/rewire	Environment variable rewiring utilities for testing.
@socketsecurity/lib/env/shell	SHELL environment variable getter.
@socketsecurity/lib/env/socket	Socket Security environment variable getters.
@socketsecurity/lib/env/socket-cli	Socket CLI environment variables.
@socketsecurity/lib/env/temp-dir	Temporary directory environment variable getters.
@socketsecurity/lib/env/term	TERM environment variable getter.
@socketsecurity/lib/env/test	Test environment variable getters and detection.
@socketsecurity/lib/env/windows	Windows environment variable getters.
@socketsecurity/lib/env/xdg	XDG Base Directory Specification environment variable getters.

fs/

Subpath	Description
@socketsecurity/lib/fs/encoding	Encoding-name normalization.
@socketsecurity/lib/fs/find-up	Walk parent directories to locate a file or directory by name.
@socketsecurity/lib/fs/inspect	Filesystem inspection helpers — stat / lstat wrappers that return undefined instead of throwing, and the directory / symlink / emptiness predicates layered on top.
@socketsecurity/lib/fs/path-cache	Cache-invalidation entry point for the allowed-directories list used by safeDelete / safeDeleteSync.
@socketsecurity/lib/fs/read-dir	Async/sync directory listing — returns directory names only (filtering out files), with optional emptiness suppression and natural-order sorting.
@socketsecurity/lib/fs/read-file	File-content readers — UTF-8 / binary / safe variants (sync + async).
@socketsecurity/lib/fs/read-json	Read-and-parse helpers for JSON files.
@socketsecurity/lib/fs/safe	Safe deletion + idempotent directory creation.
@socketsecurity/lib/fs/types	Public type surface for fs/* modules — option shapes, encoding union, and result records.
@socketsecurity/lib/fs/unique	Generate a unique filepath by appending -1, -2, … before the extension until the path is free.
@socketsecurity/lib/fs/validate	Pre-flight readability check for file lists.
@socketsecurity/lib/fs/write-json	JSON writers that match the wire-format conventions a tool ecosystem expects: configurable indentation, configurable EOL, trailing newline by default.

git/

Subpath	Description
@socketsecurity/lib/git/changed	"Anything different from HEAD" helpers — the broad-strokes git status --porcelain view that lumps staged, unstaged, and untracked paths together.
@socketsecurity/lib/git/repo	Git repository discovery + foundational lazy fs/path/cwd helpers shared across git/* leaves.
@socketsecurity/lib/git/staged	"Ready for the next commit" helpers — git diff --cached over only the index.
@socketsecurity/lib/git/types	Public type surface for git/* modules — interfaces only.
@socketsecurity/lib/git/unstaged	"Edited but not yet staged" helpers — git diff over the working tree only.

github/

Subpath	Description
@socketsecurity/lib/github/fetch	Authenticated GitHub REST fetch.
@socketsecurity/lib/github/ghsa	GitHub Security Advisory (GHSA) lookups.
@socketsecurity/lib/github/refs	Resolve GitHub git refs (tag / branch / commit) to full commit SHAs.
@socketsecurity/lib/github/token	GitHub token resolution.
@socketsecurity/lib/github/types	Public type surface for github/* modules — interfaces, named errors, and the API base-URL constants.

http-request/

Subpath	Description
@socketsecurity/lib/http-request/checksums	Checksum file fetching + parsing for download verification.
@socketsecurity/lib/http-request/convenience	Thin convenience wrappers over httpRequest — httpJson and httpText.
@socketsecurity/lib/http-request/download	Streaming file downloads with retries, progress callbacks, and SHA-256 verification.
@socketsecurity/lib/http-request/errors	Error-message enrichment for HTTP/HTTPS requests.
@socketsecurity/lib/http-request/headers	Header utilities for HTTP/HTTPS requests.
@socketsecurity/lib/http-request/request	Core HTTP/HTTPS request loop.
@socketsecurity/lib/http-request/types	Public type surface for http-request/* modules — interfaces, type aliases, and the HttpResponseError class.

json/

Subpath	Description
@socketsecurity/lib/json/edit	Editable JSON file manipulation with formatting preservation.
@socketsecurity/lib/json/format	Shared utilities for JSON formatting preservation and manipulation.
@socketsecurity/lib/json/parse	JSON parsing utilities with Buffer detection and BOM stripping.
@socketsecurity/lib/json/types	JSON type definitions and interfaces.

logger/

Subpath	Description
@socketsecurity/lib/logger/colors	Color application helpers for logger/* modules.
@socketsecurity/lib/logger/console-init	Lazy Console construction + dynamic prototype mirroring for Logger.
@socketsecurity/lib/logger/core	The Logger class — the public class surface for logger/*.
@socketsecurity/lib/logger/default	Module-singleton owner for the shared default Logger instance.
@socketsecurity/lib/logger/symbols	Symbol exports + the LOG_SYMBOLS proxy.
@socketsecurity/lib/logger/types	Public type surface for logger/* modules — the LogSymbols shape, the LoggerMethods mapped type that mirrors console, and the Task interface returned by Logger.createTask.

node/

Subpath	Description
@socketsecurity/lib/node/async-hooks	Lazy-loader for node:async_hooks.
@socketsecurity/lib/node/child-process	Lazy-loader for node:child_process.
@socketsecurity/lib/node/crypto	Lazy-loader for node:crypto.
@socketsecurity/lib/node/events	Lazy-loader for node:events.
@socketsecurity/lib/node/fs	Lazy-loader for node:fs.
@socketsecurity/lib/node/fs-promises	Lazy-loader for node:fs/promises.
@socketsecurity/lib/node/http	Lazy-loader for node:http.
@socketsecurity/lib/node/https	Lazy-loader for node:https.
@socketsecurity/lib/node/os	Lazy-loader for node:os.
@socketsecurity/lib/node/path	Lazy-loader for node:path.
@socketsecurity/lib/node/timers-promises	Lazy-loader for node:timers/promises.
@socketsecurity/lib/node/url	Lazy-loader for node:url.
@socketsecurity/lib/node/util	Lazy-loader for node:util.

packages/

Subpath	Description
@socketsecurity/lib/packages/edit	Editable package.json manipulation utilities.
@socketsecurity/lib/packages/exports	Package exports field utilities.
@socketsecurity/lib/packages/isolation	Package isolation utilities for testing.
@socketsecurity/lib/packages/licenses	SPDX license parsing and analysis utilities.
@socketsecurity/lib/packages/manifest	Package manifest and packument fetching utilities.
@socketsecurity/lib/packages/normalize	Package.json normalization utilities.
@socketsecurity/lib/packages/operations	Package operations including extraction, packing, and I/O.
@socketsecurity/lib/packages/provenance	Package provenance and attestation verification utilities.
@socketsecurity/lib/packages/specs	Package spec parsing and GitHub URL utilities.
@socketsecurity/lib/packages/validation	Package name validation utilities.

paths/

Subpath	Description
@socketsecurity/lib/paths/dirnames	Directory name and path pattern constants.
@socketsecurity/lib/paths/exts	File extension constants.
@socketsecurity/lib/paths/filenames	File name constants.
@socketsecurity/lib/paths/globs	Glob pattern constants.
@socketsecurity/lib/paths/normalize	Path manipulation utilities with cross-platform support.
@socketsecurity/lib/paths/packages	Package.json path resolution utilities.
@socketsecurity/lib/paths/rewire	Path rewiring utilities for testing.
@socketsecurity/lib/paths/socket	Path utilities for Socket ecosystem directories.

releases/

Subpath	Description
@socketsecurity/lib/releases/github-api	GitHub release listing + asset-URL discovery.
@socketsecurity/lib/releases/github-archives	GitHub release archive download + extraction.
@socketsecurity/lib/releases/github-assets	Asset matching helpers for GitHub releases.
@socketsecurity/lib/releases/github-auth	GitHub API authentication header helpers.
@socketsecurity/lib/releases/github-downloads	GitHub release asset downloads.
@socketsecurity/lib/releases/github-types	Public types for GitHub release download utilities.
@socketsecurity/lib/releases/socket-btm	Socket-btm release download utilities.

schema/

Subpath	Description
@socketsecurity/lib/schema/parse	Throwing twin of validateSchema.
@socketsecurity/lib/schema/types	Shared types for schema validation.
@socketsecurity/lib/schema/validate	Universal schema validator — non-throwing.

sea/

Subpath	Description
@socketsecurity/lib/sea/util	SEA (Single Executable Application) binary detection + path accessor.

smol/

Subpath	Description
@socketsecurity/lib/smol/primordial	Lazy-loader for socket-btm's node:smol-primordial binding.
@socketsecurity/lib/smol/util	Smol detection + lazy-loader for node:smol-util.
@socketsecurity/lib/smol/versions	Lazy-loader for socket-btm's node:smol-versions.

spinner/

Subpath	Description
@socketsecurity/lib/spinner/core	Spinner factory — builds the lazy-init Spinner class that wraps yocto-spinner with Socket-specific behaviors (custom RGB color pipeline, shimmer, progress bar, indented step messages, status methods that don't aut...
@socketsecurity/lib/spinner/registry	Spinner-style registry — exposes the union of the standard cli-spinners collection and Socket's custom socket pulse animation, plus a lazy default-spinner singleton.
@socketsecurity/lib/spinner/types	Public type surface for spinner/* modules — the Spinner instance shape, configuration option records, progress and shimmer state types, plus the withSpinner* option records.
@socketsecurity/lib/spinner/utils	Stateless helpers shared by spinner/* modules — the ciSpinner constant for non-interactive output, the COLOR_INHERIT sentinel for shimmer color references, plus pure formatters (desc, formatProgress, `normal...
@socketsecurity/lib/spinner/with	Lifecycle wrappers around Spinner — withSpinner (async, push-pop options + auto-stop), withSpinnerRestore (conditionally restart a previously-spinning instance), and withSpinnerSync (sync sibling of `withSpinn...

stdio/

Subpath	Description
@socketsecurity/lib/stdio/clear	Terminal clearing and cursor utilities.
@socketsecurity/lib/stdio/divider	Console divider and separator utilities.
@socketsecurity/lib/stdio/footer	Console footer/summary formatting utilities.
@socketsecurity/lib/stdio/header	Console header/banner formatting utilities.
@socketsecurity/lib/stdio/progress	Progress bar utilities for CLI applications.
@socketsecurity/lib/stdio/prompts	User prompt utilities for interactive scripts.
@socketsecurity/lib/stdio/stderr	Standard error stream utilities.
@socketsecurity/lib/stdio/stdout	Standard output stream utilities.

themes/

Subpath	Description
@socketsecurity/lib/themes/context	Elegant theme context management.
@socketsecurity/lib/themes/themes	Elegant theme definitions for Socket libraries.
@socketsecurity/lib/themes/types	Elegant theme type system.
@socketsecurity/lib/themes/utils	Theme utilities — color resolution and composition.