fix(firestore): type definitions #8378
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| @@ -701,7 +722,7 @@ export function loadBundle( | |||
| * @param name - The name of the query. | |||
| * @returns A named Query. | |||
| */ | |||
| export function namedQuery(firestore: Firestore, name: string): Query<DocumentData>; | |||
| export function namedQuery(firestore: Firestore, name: string): Promise<Query | null>; | |||
There was a problem hiding this comment.
Just double checking, @mikehardy, in the firebase-js-sdk documentation, it returns a Promise<Query | null>. But we currently return a Query. Should we match the firebase-js-sdk in this instance? (I assume yes!).
| @@ -173,7 +176,7 @@ export type OrderByDirection = 'desc' | 'asc'; | |||
| */ | |||
| export function orderBy( | |||
| fieldPath: string | FieldPath, | |||
| directionStr: OrderByDirection = 'asc', | |||
| directionStr?: OrderByDirection, | |||
There was a problem hiding this comment.
keep this as it was before, no harm in the additional default information I think
| */ | ||
| export function endAt(value: number | string | boolean | null, key?: string): QueryConstraint; | ||
| export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint; |
There was a problem hiding this comment.
Also need to add the other way of calling endAt:
export function endAt<AppModelType, DbModelType extends DocumentData>(
snapshot: DocumentSnapshot<AppModelType, DbModelType>
): QueryEndAtConstraint;
| export function endAt(fieldValues) { | ||
| throw new Error('endAt is not implemented'); | ||
| } |
There was a problem hiding this comment.
This needs to be revised to match the firebase-js-sdk:
I think it should literally be:
endAt(...fieldValues) {
return new QueryConstraint('endAt', ...fieldValues);
}| return new QueryConstraint('endBefore', value, key); | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| export function endBefore(fieldValues) { | ||
| throw new Error('endBefore is not implemented'); |
| * @param firestore | ||
| * @param observer | ||
| */ | ||
| export declare function onSnapshotsInSync( |
There was a problem hiding this comment.
onSnapshotsInSync needs to be implemented in a separate PR. We don't have this functionality at the moment for some reason
Release Summary
Checklist
AndroidiOSOther(macOS, web)e2etests added or updated inpackages/\*\*/e2ejesttests added or updated inpackages/\*\*/__tests__Test Plan
Think
react-native-firebaseis great? Please consider supporting the project with any of the below:React Native FirebaseandInvertaseon Twitter