refactor: global options names

Author: posva

src/database/index.ts

@@ -2,7 +2,7 @@ import { Ref, ref, getCurrentScope, onScopeDispose } from 'vue-demi'
 import type { DatabaseReference, Query } from 'firebase/database'
 import { OperationsType, walkSet, _RefWithState } from '../shared'
 import { rtdbUnbinds } from './optionsApi'
-import { bindAsArray, bindAsObject, RTDBOptions } from './subscribe'
+import { bindAsArray, bindAsObject, _DatabaseRefOptions } from './subscribe'
 
 export { databasePlugin } from './optionsApi'
 
@@ -14,7 +14,7 @@ const ops: OperationsType = {
   remove: (array, index) => array.splice(index, 1),
 }
 
-export interface _UseDatabaseRefOptions extends RTDBOptions {
+export interface _UseDatabaseRefOptions extends _DatabaseRefOptions {
   target?: Ref<unknown>
 }
 
@@ -89,7 +89,7 @@ export function _useDatabaseRef(
 export function internalUnbind(
   key: string,
   unbinds: Record<string, UnbindType> | undefined,
-  reset?: RTDBOptions['reset']
+  reset?: _DatabaseRefOptions['reset']
 ) {
   if (unbinds && unbinds[key]) {
     unbinds[key](reset)
@@ -108,7 +108,7 @@ export function internalUnbind(
  */
 export function useList<T = unknown>(
   reference: DatabaseReference | Query,
-  options?: RTDBOptions
+  options?: _DatabaseRefOptions
 ): _RefDatabase<T[]> {
   const unbinds = {}
   const data = ref<T[]>([]) as Ref<T[]>
@@ -120,7 +120,7 @@ export function useList<T = unknown>(
 
 export function useObject<T = unknown>(
   reference: DatabaseReference,
-  options?: RTDBOptions
+  options?: _DatabaseRefOptions
 ): _RefDatabase<T | undefined> {
   const data = ref<T>() as Ref<T | undefined>
   return _useDatabaseRef(reference, {
@@ -129,7 +129,7 @@ export function useObject<T = unknown>(
   }) as _RefDatabase<T | undefined>
 }
 
-export const unbind = (target: Ref, reset?: RTDBOptions['reset']) =>
+export const unbind = (target: Ref, reset?: _DatabaseRefOptions['reset']) =>
   internalUnbind('', rtdbUnbinds.get(target), reset)
 
 export interface _RefDatabase<T> extends _RefWithState<T, Error> {}

src/database/optionsApi.ts

@@ -6,7 +6,7 @@ import {
   bindAsArray,
   bindAsObject,
   rtdbOptions,
-  RTDBOptions,
+  _DatabaseRefOptions,
 } from './subscribe'
 
 /**
@@ -24,9 +24,9 @@ function getRef(refOrQuery: DatabaseReference | Query): DatabaseReference {
 export interface DatabasePluginOptions {
   bindName?: string
   unbindName?: string
-  serialize?: RTDBOptions['serialize']
-  reset?: RTDBOptions['reset']
-  wait?: RTDBOptions['wait']
+  serialize?: _DatabaseRefOptions['serialize']
+  reset?: _DatabaseRefOptions['reset']
+  wait?: _DatabaseRefOptions['wait']
 }
 
 const databasePluginDefaults: Readonly<Required<DatabasePluginOptions>> = {
@@ -49,13 +49,13 @@ declare module '@vue/runtime-core' {
     $rtdbBind(
       name: string,
       reference: DatabaseReference | Query,
-      options?: RTDBOptions
+      options?: _DatabaseRefOptions
     ): Promise<DataSnapshot>
 
     /**
      * Unbinds a bound reference
      */
-    $rtdbUnbind: (name: string, reset?: RTDBOptions['reset']) => void
+    $rtdbUnbind: (name: string, reset?: _DatabaseRefOptions['reset']) => void
 
     /**
      * Bound database references
@@ -112,7 +112,7 @@ export function databasePlugin(
 
   GlobalTarget[unbindName] = function rtdbUnbind(
     key: string,
-    reset?: RTDBOptions['reset']
+    reset?: _DatabaseRefOptions['reset']
   ) {
     internalUnbind(key, rtdbUnbinds.get(this), reset)
     delete this.$firebaseRefs[key]
@@ -123,7 +123,7 @@ export function databasePlugin(
     this: ComponentPublicInstance,
     key: string,
     source: DatabaseReference | Query,
-    userOptions?: RTDBOptions
+    userOptions?: _DatabaseRefOptions
   ) {
     const options = Object.assign({}, globalOptions, userOptions)
     const target = toRef(this.$data as any, key)

src/database/subscribe.ts

@@ -1,7 +1,7 @@
 import {
-  createRecordFromRTDBSnapshot,
+  createRecordFromDatabaseSnapshot,
   indexForKey,
-  RTDBSerializer,
+  DatabaseSnapshotSerializer,
 } from './utils'
 import { OperationsType, ResetOption } from '../shared'
 import { ref, Ref, unref } from 'vue-demi'
@@ -16,23 +16,23 @@ import {
 } from 'firebase/database'
 
 // TODO: rename to match where it's used
-export interface RTDBOptions {
+export interface _DatabaseRefOptions {
   reset?: ResetOption
-  serialize?: RTDBSerializer
+  serialize?: DatabaseSnapshotSerializer
   wait?: boolean
 
   initialValue?: unknown
 }
 
-export interface _GlobalRTDBOptions extends RTDBOptions {
+export interface _GlobalDatabaseRefOptions extends _DatabaseRefOptions {
   reset: ResetOption
-  serialize: RTDBSerializer
+  serialize: DatabaseSnapshotSerializer
   wait: boolean
 }
 
-const DEFAULT_OPTIONS: _GlobalRTDBOptions = {
+const DEFAULT_OPTIONS: _GlobalDatabaseRefOptions = {
   reset: true,
-  serialize: createRecordFromRTDBSnapshot,
+  serialize: createRecordFromDatabaseSnapshot,
   wait: false,
 }
 
@@ -53,14 +53,14 @@ interface BindAsObjectParameter extends CommonBindOptionsParameter {
 }
 
 /**
- * Binds a RTDB reference as an object
+ * Binds a Firebase Database reference as an object
  * @param param0
  * @param options
- * @returns a function to be called to stop listeninng for changes
+ * @returns a function to be called to stop listening for changes
  */
 export function bindAsObject(
   { target, document, resolve, reject, ops }: BindAsObjectParameter,
-  extraOptions: RTDBOptions = DEFAULT_OPTIONS
+  extraOptions: _DatabaseRefOptions = DEFAULT_OPTIONS
 ) {
   const key = 'value'
   const options = Object.assign({}, DEFAULT_OPTIONS, extraOptions)
@@ -102,7 +102,7 @@ interface BindAsArrayParameter extends CommonBindOptionsParameter {
  */
 export function bindAsArray(
   { target, collection, resolve, reject, ops }: BindAsArrayParameter,
-  extraOptions: RTDBOptions = DEFAULT_OPTIONS
+  extraOptions: _DatabaseRefOptions = DEFAULT_OPTIONS
 ) {
   const options = Object.assign({}, DEFAULT_OPTIONS, extraOptions)
   const key = 'value'

src/database/utils.ts

@@ -2,12 +2,12 @@ import type { DataSnapshot } from 'firebase/database'
 import { isObject } from '../shared'
 
 /**
- * Convert firebase RTDB snapshot into a bindable data record.
+ * Convert firebase Database snapshot into a bindable data record.
  *
  * @param snapshot
  * @return
  */
-export function createRecordFromRTDBSnapshot(snapshot: DataSnapshot): any {
+export function createRecordFromDatabaseSnapshot(snapshot: DataSnapshot): any {
   const value = snapshot.val()
   const res = isObject(value)
     ? value
@@ -23,7 +23,7 @@ export function createRecordFromRTDBSnapshot(snapshot: DataSnapshot): any {
   return res
 }
 
-export type RTDBSerializer = typeof createRecordFromRTDBSnapshot
+export type DatabaseSnapshotSerializer = typeof createRecordFromDatabaseSnapshot
 
 /**
  * Find the index for an object with given key.