Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Improvement] Add generic error types to useQuery of @powersync/react

Aperta
  • Qualcosa non va?
#472 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
react, typescript
Ambito
frontend

Direzione di ricerca

Start with the QueryResult type and useQuery signature in packages/react/src/hooks/useQuery.ts, then the CompilableQuery interface in packages/common/src/types/types.ts. The proposal adds an error type parameter E that defaults to Error, but the issue does not say where runtime errors are thrown or how E would reach them, so settle that design first. Done means useQuery and QueryResult accept an optional E without breaking existing callers, and the TypeScript types check. The thread has been idle for about 590 days and has no maintainer decision, so confirm the approach with maintainers before writing code.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Problem

Currently, the PowerSync query system uses a generic Error type for error handling in QueryResult https://github.com/powersync-ja/powersync-js/blob/main/packages/react/src/hooks/useQuery.ts#L9 and https://github.com/powersync-ja/powersync-js/blob/main/packages/common/src/types/types.ts.

This makes it difficult to handle specific types of errors in a type-safe manner when using TypeScript, forcing developers to use type assertions or broadly catch all errors without type discrimination.

Proposed Solution

Add generic error type support to the query system, allowing developers to specify and handle specific error types with full TypeScript support.

Type Changes
// In packages/common/src/types/types.ts
export interface CompilableQuery<T, E = Error> {
  execute(): Promise<T[]>;
  compile(): CompiledQuery;
}

// In packages/react/src/hooks/useQuery.ts
export type QueryResult<T, E = Error> = {
  data: T[];
  isLoading: boolean;
  isFetching: boolean;
  error: E | undefined;
  refresh?: () => Promise<void>;
};

export const useQuery = <T = any, E = Error>(
  query: string | CompilableQuery<T, E>,
  parameters?: any[],
  options?: AdditionalOptions
): QueryResult<T, E> => {
  // Implementation remains largely the same
  // Just needs to properly type the error handling
};

Usage Example

// Define your error types
interface PowerSyncError {
  type: string;
  message: string;
}

interface SQLError extends PowerSyncError {
  type: 'SQLError';
  code: number;
}

interface ValidationError extends PowerSyncError {
  type: 'ValidationError';
  fields: string[];
}

type AppError = SQLError | ValidationError;

// In your React component
function MyComponent() {
  const { data, error } = useQuery<User, AppError>('SELECT * FROM users');

  if (error) {
    if (error.type === 'SQLError') {
      // TypeScript knows this is SQLError
      console.error(`Database error ${error.code}: ${error.message}`);
    } else if (error.type === 'ValidationError') {
      // TypeScript knows this is ValidationError
      console.error(`Invalid fields: ${error.fields.join(', ')}`);
    }
  }

  return // ...
}

Benefits

  1. Type-safe error handling
  2. Better developer experience with IDE support
  3. Clearer error handling patterns
  4. No breaking changes for existing code (defaults to current Error type)
  5. Enables custom error types for different use cases

Implementation Notes

  1. This change is backward compatible as it defaults to the current Error type
  2. Minimal changes required to existing codebase
Lingua principale
TypeScript
Stelle
729
Fork
96
Merge medio
2g 1h
PR unite (30g)
26

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di powersync-ja/powersync-js

Tutte le issue di powersync-ja/powersync-js

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.