API Reference

Name Description
Linereader Pausable linereader for node.
LinereaderTransform Transform stream implementation for a pausable linereader for node.
Locator Class wrapping a stack of entity reference names and related external system identifiers (file names currently processed, if applicable).
Markupdefinitions Container holding document prolog metadata and associated parsing/maintenance routines.
PlatformBaseEntitymanager Entitymanager for node-js.
PlatformEntitymanager Entitymanager handling SPARQL multi-templates (calling PlatformEntitymanager, in turn) and otherwise just delegating to PlatformEntitymanager.
PlatformErrorhandler Errorhandler for node command line app or middleware.
Platformsaxeventmanager Saxeventmanager implementation to pause/resume SAX event delivery.
PlatformStringRecordmanager Class wrapping a string constant to act as input stream/recordmanager.
Sgmldecl Container and parsing/manipulation routines for properties representing SGML/WebSGML declaration options.
StringStream Implementation of a stream-over-string class (a Readable with a string as input source) that can be used with Platformrecordmanager.
SystemSpecificEntityResolver Resolver for system-specific and external subset entities.
Tokenizer Central SGML parsing module receiving input record events (from a RecordManager) and emitting SAX events to the registerered DocumentHandler, DTDHandler, and LexicalHandler implementations.

Name Description
Completioncallback Interface containing a single `done()` function.
DocumentHandler Callback interface for receiving general markup events according to the SAX 1.
DTDHandler Callback interfaces for notation and entity declarations.
Entitymanager Interface used by Ouputhandlers to append content of data entities to a configured output stream or DOM.
Errorhandler Interface for an errorhandler the SGML library user must implement and supply to processing components.
LexicalHandler Extension callback interfaces for SGML lexical events.
Prologhandler Callback interface for SGML prolog completion/content start events.
Recordhandler Interface for record callbacks.
Recordmanager Interface used by Tokenizer and other code to start, stop, and resume receiving input records (input lines).
Saxeventmanager Interface containing a pair of functions that an outputhandler is supposed to call before and after materializing a data entity/template to stop SAX events from being submitted to it meanwhile. SGML port for node.js

Contains implementations for core SGML classes/interfaces providing fully asynchronous SGML processing on node.js.

See web section and SAX for web and command line usage examples.

Be sure to understand requirements/limitations as discussed in eg. the Chainmanager source code and on with respect to HTTP request isolation features such as exception domains, as well as clustering/high-availability and other features for supporting robust, long-running web server processes on node.js.