prorm API Reference
    Preparing search index...

    Variable default

    default: {
        PrormError: typeof PrormError;
        ConnectionError: typeof ConnectionError;
        DatabaseError: typeof DatabaseError;
        ValidationError: typeof ValidationError;
        UniqueConstraintError: typeof UniqueConstraintError;
        ForeignKeyConstraintError: typeof ForeignKeyConstraintError;
        ExclusionConstraintError: typeof ExclusionConstraintError;
        TimeoutError: typeof TimeoutError;
        ResourceLockedError: typeof ResourceLockedError;
        BulkRecordError: typeof BulkRecordError;
        AssociationError: typeof AssociationError;
        EmptyResultError: typeof EmptyResultError;
        ErrorCodes: {
            CONNECTION_ERROR: "CONNECTION_ERROR";
            CONNECTION_REFUSED: "CONNECTION_REFUSED";
            CONNECTION_TIMED_OUT: "CONNECTION_TIMED_OUT";
            HOST_NOT_REACHABLE: "HOST_NOT_REACHABLE";
            INVALID_CONNECTION: "INVALID_CONNECTION";
            DATABASE_ERROR: "DATABASE_ERROR";
            QUERY_ERROR: "QUERY_ERROR";
            UNKNOWN: "UNKNOWN";
            VALIDATION_ERROR: "VALIDATION_ERROR";
            VALIDATION_FAILED: "VALIDATION_FAILED";
            UNIQUE_CONSTRAINT_ERROR: "UNIQUE_CONSTRAINT_ERROR";
            FOREIGN_KEY_CONSTRAINT_ERROR: "FOREIGN_KEY_CONSTRAINT_ERROR";
            EXCLUSION_CONSTRAINT_ERROR: "EXCLUSION_CONSTRAINT_ERROR";
            CHECK_CONSTRAINT_ERROR: "CHECK_CONSTRAINT_ERROR";
            NOT_NULL_CONSTRAINT_ERROR: "NOT_NULL_CONSTRAINT_ERROR";
            TIMEOUT_ERROR: "TIMEOUT_ERROR";
            RESOURCE_LOCKED_ERROR: "RESOURCE_LOCKED_ERROR";
            DEADLOCK_ERROR: "DEADLOCK_ERROR";
            BULK_RECORD_ERROR: "BULK_RECORD_ERROR";
            ASSOCIATION_ERROR: "ASSOCIATION_ERROR";
            EAGER_LOAD_ERROR: "EAGER_LOAD_ERROR";
        };
        isPrormError: (error: unknown) => error is PrormError;
        isValidationError: (error: unknown) => error is ValidationError;
        isConnectionError: (error: unknown) => error is ConnectionError;
        isConstraintError: (
            error: unknown,
        ) => error is
            | UniqueConstraintError
            | ForeignKeyConstraintError
            | ExclusionConstraintError;
        isEmptyResultError: (error: unknown) => error is EmptyResultError;
    }

    Export all error classes

    Type Declaration

    • PrormError: typeof PrormError
    • ConnectionError: typeof ConnectionError
    • DatabaseError: typeof DatabaseError
    • ValidationError: typeof ValidationError
    • UniqueConstraintError: typeof UniqueConstraintError
    • ForeignKeyConstraintError: typeof ForeignKeyConstraintError
    • ExclusionConstraintError: typeof ExclusionConstraintError
    • TimeoutError: typeof TimeoutError
    • ResourceLockedError: typeof ResourceLockedError
    • BulkRecordError: typeof BulkRecordError
    • AssociationError: typeof AssociationError
    • EmptyResultError: typeof EmptyResultError
    • ErrorCodes: {
          CONNECTION_ERROR: "CONNECTION_ERROR";
          CONNECTION_REFUSED: "CONNECTION_REFUSED";
          CONNECTION_TIMED_OUT: "CONNECTION_TIMED_OUT";
          HOST_NOT_REACHABLE: "HOST_NOT_REACHABLE";
          INVALID_CONNECTION: "INVALID_CONNECTION";
          DATABASE_ERROR: "DATABASE_ERROR";
          QUERY_ERROR: "QUERY_ERROR";
          UNKNOWN: "UNKNOWN";
          VALIDATION_ERROR: "VALIDATION_ERROR";
          VALIDATION_FAILED: "VALIDATION_FAILED";
          UNIQUE_CONSTRAINT_ERROR: "UNIQUE_CONSTRAINT_ERROR";
          FOREIGN_KEY_CONSTRAINT_ERROR: "FOREIGN_KEY_CONSTRAINT_ERROR";
          EXCLUSION_CONSTRAINT_ERROR: "EXCLUSION_CONSTRAINT_ERROR";
          CHECK_CONSTRAINT_ERROR: "CHECK_CONSTRAINT_ERROR";
          NOT_NULL_CONSTRAINT_ERROR: "NOT_NULL_CONSTRAINT_ERROR";
          TIMEOUT_ERROR: "TIMEOUT_ERROR";
          RESOURCE_LOCKED_ERROR: "RESOURCE_LOCKED_ERROR";
          DEADLOCK_ERROR: "DEADLOCK_ERROR";
          BULK_RECORD_ERROR: "BULK_RECORD_ERROR";
          ASSOCIATION_ERROR: "ASSOCIATION_ERROR";
          EAGER_LOAD_ERROR: "EAGER_LOAD_ERROR";
      }

      Error classes for the ORM Provides structured error handling with error codes for programmatic handling

    • isPrormError: (error: unknown) => error is PrormError
    • isValidationError: (error: unknown) => error is ValidationError
    • isConnectionError: (error: unknown) => error is ConnectionError
    • isConstraintError: (
          error: unknown,
      ) => error is
          | UniqueConstraintError
          | ForeignKeyConstraintError
          | ExclusionConstraintError
    • isEmptyResultError: (error: unknown) => error is EmptyResultError