Errors
Every error class the packages throw and every code it can carry, read from the installed packages.
How errors work
Every failure is a typed error with a machine-readable code, and where it helps, the part name
or the token that caused it. Each package throws one class of its own; census throws only an
OpcError, when the archive will not open, and records everything else as a problem in its
answer. Where a package exports an is<X>Error guard, use it; otherwise check instanceof.
Nothing is swallowed and nothing returns a plausible default in place of an answer: a missing
face throws TEXT_FACE_METRICS, an unknown preset throws PRESET_UNKNOWN, and a file the writer
would have broken throws ERR_VALIDATION_FAILED with the report attached.
The codes below are read from the dist/index.d.ts of the packages this site installed, so
they are the codes of the versions in the footer.
opc
Throws OpcError, whose code is one of:
- ERR_NOT_A_ZIP
- ERR_ENCRYPTED_PACKAGE
- ERR_TRUNCATED
- ERR_ARCHIVE_TOO_LARGE
- ERR_TOO_MANY_ENTRIES
- ERR_BUDGET_EXCEEDED
- ERR_ENTRY_TOO_LARGE
- ERR_RATIO_EXCEEDED
- ERR_UNSUPPORTED_COMPRESSION
- ERR_ENTRY_ENCRYPTED
- ERR_HEADER_MISMATCH
- ERR_OVERLAPPING_ENTRY
- ERR_CRC_MISMATCH
- ERR_INFLATE_FAILED
- ERR_ZIP64_UNSUPPORTED
- ERR_DUPLICATE_ENTRY
- ERR_INVALID_PART_NAME
- ERR_TARGET_ESCAPES_PACKAGE
- ERR_MALFORMED_XML
- ERR_DOCTYPE_FORBIDDEN
- ERR_MISSING_PACKAGE_PART
- ERR_MISSING_CONTENT_TYPE
- ERR_CONTENT_TYPE_CONFLICT
- ERR_INVALID_CONTENT_TYPE
- ERR_INVALID_RELATIONSHIP_ID
- ERR_DUPLICATE_RELATIONSHIP_ID
- ERR_DANGLING_RELATIONSHIP
- ERR_INVALID_RELATIONSHIP_TARGET
- ERR_PART_NOT_FOUND
- ERR_PART_EXISTS
- ERR_ZIP32_OVERFLOW
xml
Throws XmlError, whose code is one of:
- ERR_DOCTYPE_FORBIDDEN
- ERR_MALFORMED_XML
- ERR_MISMATCHED_TAG
- ERR_UNCLOSED_TAG
- ERR_ROOT_ELEMENT
- ERR_DUPLICATE_ATTRIBUTE
- ERR_UNKNOWN_ENTITY
- ERR_INVALID_CHARACTER
- ERR_UNSUPPORTED_ENCODING
- ERR_LIMIT_EXCEEDED
- ERR_INVALID_MCE
- ERR_SCHEMA_ORDER
- ERR_INVALID_EDIT
geometry
Throws GeometryError, whose code is one of:
- PRESET_DECODE
- PRESET_UNKNOWN
- FMLA_OPERATOR
- FMLA_ARITY
- FMLA_OPERAND
paint
Throws PaintError, whose code is one of:
- COLOR_HEX
- COLOR_NUMBER
- COLOR_SCHEME_NAME
- COLOR_NO_SCHEME
- COLOR_NO_PHCLR
- COLOR_SCHEME_CYCLE
- COLOR_SYS_UNKNOWN
- COLOR_PRST_UNKNOWN
- COLOR_TRANSFORM
- FILL_NO_STOPS
- FILL_PATTERN_UNKNOWN
- LINE_DASH_UNKNOWN
- LINE_COMPOUND_UNKNOWN
- LINE_END_UNKNOWN
- LINE_END_SIZE
- LINE_DEVICE_SCALE
- EFFECT_NEGATIVE_RADIUS
- FILL_BLIP_RESOLUTION
- FILL_BLIP_CROP
- FILL_BLIP_SIZE
- FILL_BLIP_SCALE
text
Throws TextError, whose code is one of:
- TEXT_SIZE
- TEXT_LINE_SPACING
- TEXT_LINE_COUNT
- TEXT_FONT_FAMILY
- TEXT_BREAK_WIDTH
- TEXT_AUTOFIT_SCALE
- TEXT_AUTOFIT_HEIGHT
- TEXT_FACE_METRICS
- TEXT_DECORATION
- TEXT_AUTONUMBER_SCHEME
- TEXT_AUTONUMBER_UNMEASURED
- TEXT_AUTONUMBER_VALUE
- TEXT_BULLET
- TEXT_FIELD_LOCALE
- TEXT_FIELD
- TEXT_SCRIPT_RUN
- TEXT_FRAME
- TEXT_NO_CANVAS
model
Throws ModelError, whose code is one of:
- MODEL_PART_MISSING
- MODEL_PART_KIND
- MODEL_NO_PRESENTATION
- MODEL_NO_PARENT
- MODEL_NO_THEME
- MODEL_CLRMAP_INCOMPLETE
- MODEL_CLRMAP_SLOT
- MODEL_PLACEHOLDER_IDX
- MODEL_XFRM_NUMBER
- MODEL_GEOMETRY
- MODEL_STYLE_IDX
- MODEL_FONT_COLLECTION
- MODEL_NO_STYLE_MATRIX
- MODEL_STYLE_LIST_EMPTY
- MODEL_SHEET_CYCLE
- MODEL_FOREIGN_SHEET
- MODEL_TEXT_ATTR
- MODEL_TEXT_FIELD
- MODEL_TEXT_LEVEL
- MODEL_TEXT_BULLET
- MODEL_TEXT_TYPEFACE
- MODEL_TABLE_ATTR
- MODEL_TABLE_STYLE
- MODEL_TABLE_POSITION
- BLIP_NO_EMBED
- BLIP_DUOTONE
- BLIP_CLR_CHANGE
- BLIP_TILE_ALIGN
- BLIP_TILE_FLIP
render-svg
Throws RenderError, whose code is one of:
- RENDER_UNKNOWN_PRESET
- RENDER_GROUP_DEPTH
- RENDER_NO_HOST
- RENDER_TEXT_FRAME
- RENDER_TEXT_UNSUPPORTED
- RENDER_IMAGE_FORMAT
- RENDER_DEVICE_PIXEL_RATIO
render-dom
Throws RenderDomError, whose code is one of:
- RENDER_DOM_NO_HOST
- RENDER_DOM_NO_DOCUMENT
validate
Throws ValidateError, whose code is one of:
- ERR_VALIDATION_FAILED
- ERR_UNVALIDATABLE
- ERR_UNKNOWN_RULE
writer
Throws WriterError, whose code is one of:
- ERR_PREPARE_FAILED
- ERR_COLLECTION_UNSAFE
- ERR_PRESERVATION_BROKEN
cli
Throws RenderError, whose code is one of:
- CLI_FONT_UNREADABLE
- CLI_FONT_DIR
- CLI_NO_FACE
- CLI_FONT_SIZE
- CLI_NO_SLIDE
- CLI_WIDTH
- CLI_OUTPUT_PATH