voluptasmollitia/packages/rxfire/firestore/fromRef.ts

Monorepo for the Firebase JavaScript SDK

/**
 * @license
 * Copyright 2018 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import firebase from 'firebase/app';
import { Observable } from 'rxjs';

type DocumentReference = firebase.firestore.DocumentReference;
type SnapshotListenOptions = firebase.firestore.SnapshotListenOptions;
type Query = firebase.firestore.Query;
type DocumentSnapshot = firebase.firestore.DocumentSnapshot;
type QuerySnapshot = firebase.firestore.QuerySnapshot;

/* eslint-disable @typescript-eslint/no-explicit-any */
function _fromRef(
  ref: any,
  options: SnapshotListenOptions | undefined
): Observable<any> {
  /* eslint-enable @typescript-eslint/no-explicit-any */
  return new Observable(subscriber => {
    const unsubscribe = ref.onSnapshot(options || {}, subscriber);
    return { unsubscribe };
  });
}

export function fromRef(
  ref: DocumentReference | Query,
  options?: SnapshotListenOptions
): Observable<{}> {
  return _fromRef(ref, options);
}

export function fromDocRef(
  ref: DocumentReference,
  options?: SnapshotListenOptions
): Observable<DocumentSnapshot> {
  return fromRef(ref, options) as Observable<DocumentSnapshot>;
}

export function fromCollectionRef(
  ref: Query,
  options?: SnapshotListenOptions
): Observable<QuerySnapshot> {
  return fromRef(ref, options) as Observable<QuerySnapshot>;
}