Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API Reference

Complete API documentation is auto-generated from the source code using Deno's documentation tool.

📚 View Full API Documentation

The API documentation includes:

  • All exported functions - Complete signatures and descriptions
  • All classes and interfaces - Full type information
  • All methods and properties - Detailed documentation
  • Type definitions - Complete TypeScript types
  • Examples - Code examples from JSDoc

Core Functions

  • run(){:target="_blank"} - Run a child process
  • enumerate(){:target="_blank"} - Wrap an iterable
  • read(){:target="_blank"} - Read a file

Classes

  • Enumerable{:target="_blank"} - Array-like methods for async iterables
  • ProcessEnumerable{:target="_blank"} - Process-specific enumerable
  • Process{:target="_blank"} - Process management

Error Types

Utilities

  • range(){:target="_blank"} - Generate number ranges
  • zip(){:target="_blank"} - Combine iterables
  • concat(){:target="_blank"} - Concatenate byte arrays
  • cache(){:target="_blank"} - Cache iterable results

Using the API Docs

The generated documentation includes:

Use the search box to find any function, class, or type.

Type Information

Click on any type to see its definition and usage.

Examples

Most functions include working code examples.

Click "Source" to view the implementation.

Integration with This Guide

This user guide provides:

  • Conceptual explanations - Why and when to use features
  • Tutorials - Step-by-step learning
  • Recipes - Real-world solutions
  • Best practices - How to use effectively

The API reference provides:

  • Complete signatures - Exact function parameters
  • Type definitions - TypeScript types
  • Technical details - Implementation specifics
  • All exports - Everything available

Use both together for complete understanding!

Keeping Docs Updated

The API documentation is regenerated every time the site is built, so it's always in sync with the code.

To regenerate manually:

deno doc --html --name="proc" --output=./site/src/api-docs ./mod.ts

Next Steps