digidem / multi-core-indexer / 31517730058

100%

push

github

feat: custom error classes with stable codes (#55)

* feat: custom error classes with stable codes

All errors created by this module are now custom classes built with
custom-error-creator, each with a stable machine-readable code
(INDEXER_CLOSED, INDEXER_NOT_CLOSED, MISSING_CORE_KEY,
MISSING_DISCOVERY_KEY) documented in a new Errors section in the readme.
Messages are unchanged; consumers should match on error.code.

* feat: identify error sources and export error classes

Errors delivered via the 'error' event are now wrapped in a coded class
identifying their source - BATCH_ERROR (the batch function threw or
rejected), HYPERCORE_ERROR (a core failed to open or a block read failed),
or STORAGE_ERROR (reading or writing index state storage failed, also used
for unlink() failures) - with the underlying error unchanged as cause.

The error classes are exported from multi-core-indexer/error.js so
consumers can match with instanceof as well as by code.

MISSING_CORE_KEY and MISSING_DISCOVERY_KEY are back to plain Errors: those
are impossible states thrown only to satisfy type narrowing, not part of
the error API.

291 of 291 branches covered (100.0%)

Branch coverage included in aggregate %.

78 of 78 new or added lines in 3 files covered. (100.0%)

1215 of 1215 relevant lines covered (100.0%)

31358.49 hits per line