Type Alias: NeuroimErrorCode

type NeuroimErrorCode = 
  | "INVALID_ARGUMENT"
  | "OUT_OF_RANGE"
  | "GEOMETRY_MISMATCH"
  | "UNSUPPORTED_FORMAT"
  | "UNSUPPORTED_DATATYPE"
  | "CORRUPT_FILE"
  | "NOT_IMPLEMENTED"
  | "IO_ERROR";

Defined in: src/errors.ts:30

Stable error codes carried by NeuroimError.

• INVALID_ARGUMENT: an argument has the wrong shape, type or value (e.g. a non-finite spacing, an unknown axis name, a singular affine).
• OUT_OF_RANGE: an index or coordinate lies outside the valid range (e.g. a volume index past the end of a 4D file).
• GEOMETRY_MISMATCH: two spaces, volumes or axis sets that must agree do not (e.g. combining volumes on different voxel grids).
• UNSUPPORTED_FORMAT: the file format, or a valid feature of it, is not supported (unknown extension, writing a non-NIfTI format, a 5D NIfTI).
• UNSUPPORTED_DATATYPE: the voxel data type is not supported.
• CORRUPT_FILE: the bytes do not decode as the expected format (bad magic, unreadable header, invalid dimensions, truncated image data).
• NOT_IMPLEMENTED: the operation exists in the API but has no implementation for this input.
• IO_ERROR: reading from or writing to storage failed.