refactor: unbind type

Author: posva

src/database/index.ts

@@ -14,6 +14,7 @@ import {
   noop,
   OperationsType,
   ResetOption,
+  UnbindWithReset,
   walkSet,
   _MaybeRef,
   _RefWithState,
@@ -46,14 +47,12 @@ export interface UseDatabaseRefOptions extends _DatabaseRefOptions {
   target?: Ref<unknown>
 }
 
-type UnbindType = ReturnType<typeof bindAsArray | typeof bindAsObject>
-
 export function _useDatabaseRef(
   reference: _MaybeRef<DatabaseReference | Query>,
   localOptions: UseDatabaseRefOptions = {}
 ) {
   const options = Object.assign({}, rtdbOptions, localOptions)
-  let _unbind!: UnbindType
+  let _unbind!: UnbindWithReset
 
   const data = options.target || ref<unknown | null>(options.initialValue)
   const error = ref<Error>()
@@ -112,7 +111,7 @@ export function _useDatabaseRef(
     // should take an option like once: true to not setting up any listener
   }
 
-  let stopWatcher: ReturnType<typeof watch> = noop
+  let stopWatcher = noop
   if (isRef(reference)) {
     stopWatcher = watch(reference, bindDatabaseRef, { immediate: true })
   } else {
@@ -142,7 +141,7 @@ export function _useDatabaseRef(
 
 export function internalUnbind(
   key: string,
-  unbinds: Record<string, UnbindType> | undefined,
+  unbinds: Record<string, UnbindWithReset> | undefined,
   reset?: ResetOption
 ) {
   if (unbinds && unbinds[key]) {
@@ -185,5 +184,5 @@ export function useObject<T = unknown>(
   }) as _RefDatabase<VueDatabaseDocumentData<T> | undefined>
 }
 
-export const unbind = (target: Ref, reset?: _DatabaseRefOptions['reset']) =>
+export const unbind = (target: Ref, reset?: ResetOption) =>
   internalUnbind('', rtdbUnbinds.get(target), reset)

src/database/optionsApi.ts

@@ -1,6 +1,7 @@
 import { DatabaseReference, DataSnapshot, Query } from 'firebase/database'
 import { App, ComponentPublicInstance, toRef } from 'vue'
 import { isVue3 } from 'vue-demi'
+import { ResetOption, UnbindWithReset } from '../shared'
 import { internalUnbind, _useDatabaseRef } from './index'
 import {
   bindAsArray,
@@ -44,7 +45,7 @@ declare module '@vue/runtime-core' {
     /**
      * Unbinds a bound reference
      */
-    $rtdbUnbind: (name: string, reset?: _DatabaseRefOptions['reset']) => void
+    $rtdbUnbind: (name: string, reset?: ResetOption) => void
 
     /**
      * Bound database references
@@ -58,7 +59,7 @@ declare module '@vue/runtime-core' {
      * @internal
      */
     // _firebaseUnbinds: Readonly<
-    //   Record<string, ReturnType<typeof bindAsArray | typeof bindAsObject>>
+    //   Record<string, UnbindWithReset>
     // >
   }
   export interface ComponentCustomOptions {
@@ -74,7 +75,7 @@ export type FirebaseOption = VueFirebaseObject | (() => VueFirebaseObject)
 
 export const rtdbUnbinds = new WeakMap<
   object,
-  Record<string, ReturnType<typeof bindAsArray | typeof bindAsObject>>
+  Record<string, UnbindWithReset>
 >()
 
 /**
@@ -101,7 +102,7 @@ export function databasePlugin(
 
   GlobalTarget[unbindName] = function rtdbUnbind(
     key: string,
-    reset?: _DatabaseRefOptions['reset']
+    reset?: ResetOption
   ) {
     internalUnbind(key, rtdbUnbinds.get(this), reset)
     delete this.$firebaseRefs[key]

src/firestore/index.ts

@@ -22,6 +22,7 @@ import {
   noop,
   OperationsType,
   ResetOption,
+  UnbindWithReset,
   walkSet,
   _MaybeRef,
   _Nullable,
@@ -42,8 +43,6 @@ export const ops: OperationsType = {
   remove: (array, index) => array.splice(index, 1),
 }
 
-type UnbindType = ReturnType<typeof bindCollection | typeof bindDocument>
-
 export interface _UseFirestoreRefOptions extends FirestoreRefOptions {
   /**
    * Use the `target` ref instead of creating one.
@@ -64,7 +63,7 @@ export function _useFirestoreRef(
   >,
   localOptions?: _UseFirestoreRefOptions
 ) {
-  let _unbind: UnbindType = noop
+  let _unbind: UnbindWithReset = noop
   const options = Object.assign({}, firestoreOptions, localOptions)
 
   // TODO: allow passing pending and error refs as option for when this is called using the options api
@@ -124,7 +123,7 @@ export function _useFirestoreRef(
     })
   }
 
-  let stopWatcher: ReturnType<typeof watch> = noop
+  let stopWatcher = noop
   if (isRef(docOrCollectionRef)) {
     stopWatcher = watch(docOrCollectionRef, bindFirestoreRef, {
       immediate: true,
@@ -264,9 +263,7 @@ export function useDocument<T>(
 
 export function internalUnbind(
   key: string,
-  unbinds:
-    | Record<string, ReturnType<typeof bindCollection | typeof bindDocument>>
-    | undefined,
+  unbinds: Record<string, UnbindWithReset> | undefined,
   reset?: FirestoreRefOptions['reset']
 ) {
   if (unbinds && unbinds[key]) {

src/firestore/optionsApi.ts

@@ -14,7 +14,7 @@ import {
   _GlobalFirestoreRefOptions,
 } from './subscribe'
 import { internalUnbind, _useFirestoreRef } from '.'
-import { ResetOption } from '../shared'
+import { ResetOption, UnbindWithReset } from '../shared'
 
 export type FirestoreOption = VueFirestoreObject | (() => VueFirestoreObject)
 
@@ -27,7 +27,7 @@ export type VueFirestoreObject = Record<
 
 export const firestoreUnbinds = new WeakMap<
   object,
-  Record<string, ReturnType<typeof bindCollection | typeof bindDocument>>
+  Record<string, UnbindWithReset>
 >()
 
 /**
@@ -192,7 +192,7 @@ declare module '@vue/runtime-core' {
      * @internal
      */
     // _firestoreUnbinds: Readonly<
-    //   Record<string, ReturnType<typeof bindCollection | typeof bindDocument>>
+    //   Record<string, UnbindWithReset>
     // >
   }
 

src/shared.ts

@@ -30,6 +30,11 @@ export interface OperationsType {
  */
 export type ResetOption = boolean | (() => unknown)
 
+/**
+ * Return type of `$rtdbBind()` and `$firestoreBind()`
+ */
+export type UnbindWithReset = (reset?: ResetOption) => void
+
 /**
  * @internal
  */