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 · argv/ · constants/ · cover/ · dlx/ · effects/ · env/ · json/ · packages/ · paths/ · releases/ · stdio/ · themes/ · validation/

Top-level

Subpath	Description
@socketsecurity/lib/abort	Abort signal utilities.
@socketsecurity/lib/agent	Package manager agent for executing npm, pnpm, and yarn commands.
@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/bin	Binary path resolution and execution utilities for package managers.
@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/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/fs	File system utilities with cross-platform path handling.
@socketsecurity/lib/git	Git helpers built on top of spawn.
@socketsecurity/lib/github	GitHub utilities for Socket projects.
@socketsecurity/lib/globs	Glob pattern matching utilities with default ignore patterns.
@socketsecurity/lib/http-request	HTTP/HTTPS request utilities using Node.js built-in modules with retry logic, redirects, and download support.
@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/logger	Console logging utilities with line prefix support.
@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/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 escape-string-regexp implementation.
@socketsecurity/lib/sea	SEA (Single Executable Application) detection utilities for Socket ecosystem.
@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/spinner	CLI spinner utilities for long-running operations.
@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/themes	Elegant theming system for Socket libraries.
@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.
@socketsecurity/lib/zod	Zod schema validation library wrapper for type-safe runtime validation.

argv/

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

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.

effects/

Subpath	Description
@socketsecurity/lib/effects/pulse-frames	Socket pulse animation frames generator.
@socketsecurity/lib/effects/text-shimmer	Text shimmer animation utilities.
@socketsecurity/lib/effects/types	Shared types for effects (shimmer, pulse, ultra, etc.).
@socketsecurity/lib/effects/ultra	Ultrathink rainbow gradient effect.

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/socket-cli-shadow	Socket CLI shadow mode 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.

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.

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	GitHub release download utilities.
@socketsecurity/lib/releases/socket-btm	Socket-btm release download utilities.

stdio/

Subpath	Description
@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/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.

validation/

Subpath	Description
@socketsecurity/lib/validation/json-parser	Safe JSON parsing with validation and security controls.
@socketsecurity/lib/validation/types	Validation type definitions.