API Reference

The interfaces and classes of every Nanook module, grouped the way the packages are.

The five rows marked 3.x are the current reference, generated from the repository's docs/api. The groups below them describe Nanook 1.x (JavaScript): Processor is now TestcaseProcessor, TDGServiceRegistry is DataGeneratorRegistry.

Processor 3.x

TestcaseProcessor, the writer interface, filters, and the factory functions for a quick setup.

Model 3.x

Table and test case interfaces, the directive types, metadata.

Data generator 3.x

Generator interface, DataGeneratorBase, DataGeneratorRegistry, GeneratorFaker.

File processor 3.x

Importers, parsers for decision, matrix and specification tables, the specification converter.

Logger 3.x

LoggerInterface and the in-memory LoggerMemory.

model

The base contracts — TableInterface, TestcaseDefinitionInterface — and the four Todo classes.

model-decision

Decision tables: TableDecision, TestcaseDefinitionDecision, the section types, and the validate functions.

model-matrix

Matrix tables: TableMatrix and TestcaseDefinitionMatrix.

dataGenerator

Data generation: DataGeneratorInterface, DataGeneratorBase, GeneratorFaker, and the TDGServiceRegistry (DataGeneratorRegistry in 3.x).

processor

Test case processing: InterfaceProcessor, InterfaceWriter, Processor (TestcaseProcessor in 3.x), the data classes (Node, Reference, TestcaseData), and the write and filter helpers.

file-processor

File handling: FileProcessor, ImporterInterface, ParserInterface, and the decision, matrix, and specification parsers.

importerXlsx

The Excel importer: ImporterXlsx.

logger

Logging: LoggerInterface and LoggerMemory.

Provider	nanook.xhub.io (First Party)
Cookies	`nanook-theme` — Stores your theme preference (light/dark)
Duration	Persistent (localStorage)
Purpose	Remember your display preferences across visits

Provider	Google LLC (Google Analytics 4)
Cookies	`_ga`, `_ga_PMNJR2G9ZH` — Distinguish unique visitors and sessions
Duration	`_ga`: 2 years, `_ga_*`: 2 years
Purpose	Measure site usage, page views, and traffic sources to improve the site. IP addresses are anonymized.
Privacy	Google Privacy Policy