Variable TypedError

Type declaration

• • <T extends ErrorCode>(
        code: T,
        message: ErrorMessage<T>,
        context: TypedErrorContext<T>,
        options?: { cause?: unknown; traceId?: string },
    ): TypedError<T>

  • Create a typed error with compile-time type safety

    Type Parameters

    • T extends ErrorCode

    Parameters

    • code: T
    • message: ErrorMessage<T>
    • context: TypedErrorContext<T>
    • Optionaloptions: { cause?: unknown; traceId?: string }

    Returns TypedError<T>

• auth: (resource: string, requiredRole?: string) => TypedError<"AUTH_REQUIRED">

  Create an authentication error

  Example

  const error = TypedError.auth("/api/admin", "admin")
  // Type: TypedError<"AUTH_REQUIRED">
  Copy

• badRequest: (reason: string, expected?: string) => TypedError<"BAD_REQUEST">

  Create a bad request error

  Example

  const error = TypedError.badRequest("Invalid JSON", "valid JSON object")
  // Type: TypedError<"BAD_REQUEST">
  Copy

• conflict: (resource: string, conflictingValue: string) => TypedError<"CONFLICT">

  Create a conflict error

  Example

  const error = TypedError.conflict("email", "user@example.com")
  // Type: TypedError<"CONFLICT">
  Copy

• hasCode: <T extends ErrorCode>(
      error: TypedError<ErrorCode>,
      code: T,
  ) => error is TypedError<T>

  Check if a TypedError has a specific code

• internal: (errorId: string) => TypedError<"INTERNAL_ERROR">

  Create an internal error

  Example

  const error = TypedError.internal("ERR-500-ABC123")
  // Type: TypedError<"INTERNAL_ERROR">
  Copy

• isTypedError: (value: unknown) => value is TypedError<ErrorCode>

  Check if a value is a TypedError

• network: (
      url: string,
      method: string,
      statusCode?: number,
  ) => TypedError<"NETWORK_ERROR">

  Create a network error

  Example

  const error = TypedError.network("https://api.example.com", "POST", 500)
  // Type: TypedError<"NETWORK_ERROR">
  Copy

• notFound: (resource: string, id: string | number) => TypedError<"NOT_FOUND">

  Create a not found error

  Example

  const error = TypedError.notFound("user", "123")
  // Type: TypedError<"NOT_FOUND">
  Copy

• permission: (
      action: string,
      resource: string,
      userId?: string,
  ) => TypedError<"PERMISSION_DENIED">

  Create a permission denied error

  Example

  const error = TypedError.permission("delete", "post", "user123")
  // Type: TypedError<"PERMISSION_DENIED">
  Copy

• rateLimit: (
      limit: number,
      window: string,
      retryAfter?: number,
  ) => TypedError<"RATE_LIMITED">

  Create a rate limit error

  Example

  const error = TypedError.rateLimit(100, "1h", 3600)
  // Type: TypedError<"RATE_LIMITED">
  Copy

• timeout: (duration: number, operation: string) => TypedError<"TIMEOUT">

  Create a timeout error

  Example

  const error = TypedError.timeout(30000, "database query")
  // Type: TypedError<"TIMEOUT">
  Copy

• validation: (field: string, value: unknown, rule: string) => TypedError<"VALIDATION_FAILED">

  Create a validation error

  Example

  const error = TypedError.validation("email", "test@", "must be valid email")
  // Type: TypedError<"VALIDATION_FAILED">
  // Message must match: "Validation failed: ..."
  Copy