createNodeListStore()
createNodeListStore<T>(realtimeDb, ref, options)
creates a store based on a
node reference. The store will update when the node list changes.
Parameters
rtdb: Database
- The realtime database instance. If you put the component at the root of your app, or higher than where you're using this store, you can usenull
orundefined
as the parameter and the store will retrieve the database instance from the context.ref: string | DatabaseReference
- The database node list reference to create the store from. Can be a string, just likeposts/123
or aDatabaseReference
object, using theref
database function.options?: NodeStoreOptions<T>
- Options for the store.
Properties
subscribe: ((val: T) => void)) => void;
- Subscribe method for the Svelte store. Allows for the `$store` syntax.ref: DatabaseReference
- The node list reference used to create the store.key: string
- The node list keyloading: boolean
- If the node list is loading (undefined)error: Error | null
- Error if any
Types
interface NodeStoreOptions<T> {
log?: boolean;
once?: boolean;
startValue?: T;
}