isRefirebaseError
Type guard to check if a value is a RefirebaseError result.
Usage
Instead of throwing exceptions, Refirebase methods return a { data, error } object. Use isRefirebaseError to safely check if an operation failed.
Type Guard
import { isRefirebaseError } from 'refirebase';
import { db } from './firebase';
async function fetchUser(id: string) {
const result = await db.firestore.get('users', id);
if (isRefirebaseError(result)) {
console.error("Failed to fetch user:", result.error.message);
return null;
}
return result.data;
}Parameters
| Param | Type | Description |
|---|---|---|
result* | unknown | The result object returned from a Refirebase operation. |
Return value
Returns
booleanReturns true if the object contains a RefirebaseError under the 'error' key.