API Documentation / vuefire / _RefDatabase
Interface: _RefDatabase<T>
vuefire._RefDatabase
Type parameters
Name |
---|
T |
Hierarchy
_RefWithState
<T
,Error
>↳
_RefDatabase
Properties
[RefSymbol]
• [RefSymbol]: true
Type differentiator only. We need this to be in public d.ts but don't want it to show up in IDE autocomplete, so we use a private Symbol instead.
Inherited from
_RefWithState.[RefSymbol]
stop
• stop: (reset?
: ResetOption
) => void
Type declaration
▸ (reset?
): void
Stops listening to the data changes and stops the Vue watcher.
Parameters
Name | Type |
---|---|
reset? | ResetOption |
Returns
void
Inherited from
_RefWithState.stop
value
• value: T
Inherited from
_RefWithState.value
Accessors
data
• get
data(): Ref
<T
>
Realtime data wrapped in a Vue ref
Returns
Ref
<T
>
Inherited from
_RefWithState.data
error
• get
error(): Ref
<undefined
| E
>
Reactive Error if the firebase operation fails
Returns
Ref
<undefined
| E
>
Inherited from
_RefWithState.error
pending
• get
pending(): Ref
<boolean
>
Reactive loading state
Returns
Ref
<boolean
>
Inherited from
_RefWithState.pending
promise
• get
promise(): ShallowRef
<Promise
<T
>>
Reactive promise that resolves when the data is loaded or rejects if there is an error
Returns
ShallowRef
<Promise
<T
>>
Inherited from
_RefWithState.promise