#qjs-modules — API Reference

This directory contains comprehensive API documentation for qjs-modules.

#Structure

The documentation is organized into three categories:

• native/ — Native C modules (quickjs-*.c). These are the primary implementations for modules that have native bindings.
• js/ — Pure JavaScript modules (lib/*.js). These are either polyfills for standard APIs or wrappers around native modules.
• Root files — General documentation (README, grammar, buffer, readline, api-compatibility)

#Module Classification

1. Native modules (in native/): Direct C implementations exposed to JavaScript

   • Examples: blob, stream, dom, fs, process, child-process, sockets

2. JavaScript polyfills (in js/): Standalone JS implementations of standard APIs

   • Examples: events, url, timers, console (WHATWG/W3C/HTML5 standards)
   • Some polyfills also have native counterparts (deep, misc, pointer, predicate, xml) — documented in native/

3. JavaScript wrappers (in js/): JS code that wraps native modules to provide higher-level APIs

   • Examples: assert, fsPromises, util, dom (wraps native modules with JS convenience)

4. Prototype extensions (in js/): Extend built-in JavaScript prototypes

   • Examples: extendArray, extendString, extendObject, etc.

#Documentation Index

#Native Modules (native/)

See native/README.md for the complete list of native C modules.

Key modules:

• blob — WHATWG Blob API
• stream — WHATWG Streams API
• dom — W3C DOM API
• child-process — Node.js child_process
• sockets — BSD sockets
• deep — Deep object comparison and cloning
• inspect — Object inspection and formatting

#JavaScript Modules (js/)

See js/README.md for the complete list of JavaScript modules.

Key modules:

• events — Node.js EventEmitter
• url — WHATWG URL API
• timers — HTML5 Timers API
• console — WHATWG Console API
• assert — Node.js assert module
• fs — Node.js fs module
• fsPromises — Promise-based fs API

#API Compatibility

See api-compatibility.md for:

• Classification of all modules by standard compliance
• Standards compatibility tracking (WHATWG, W3C, Node.js, etc.)
• Roadmap for improving standards compliance

#General Documentation

• grammar.md — JavaScript grammar specification
• buffer.md — Buffer handling
• readline.md — Readline utilities