react-native-firebase/lib/modules/database/DataSnapshot.js

151 lines
4.4 KiB
JavaScript
Raw Normal View History

2017-03-02 11:40:08 +00:00
/**
* @flow
* DataSnapshot representation wrapper
2017-03-02 11:40:08 +00:00
*/
import { isObject, deepGet, deepExists } from './../../utils';
import type Reference from './Reference';
2017-03-02 11:40:08 +00:00
/**
* @class DataSnapshot
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot
*/
export default class DataSnapshot {
ref: Reference;
2017-03-02 11:40:08 +00:00
key: string;
_value: any;
_priority: any;
_childKeys: Array<string>;
2017-03-02 11:40:08 +00:00
constructor(ref: Reference, snapshot: Object) {
this.key = snapshot.key;
if (ref.key !== snapshot.key) {
this.ref = ref.child(snapshot.key);
} else {
this.ref = ref;
}
// internal use only
this._value = snapshot.value;
this._priority = snapshot.priority === undefined ? null : snapshot.priority;
this._childKeys = snapshot.childKeys || [];
2017-03-02 11:40:08 +00:00
}
/**
* Extracts a JavaScript value from a DataSnapshot.
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot#val
* @returns {any}
*/
val(): any {
// clone via JSON stringify/parse - prevent modification of this._value
2018-01-25 18:25:39 +00:00
if (isObject(this._value) || Array.isArray(this._value))
return JSON.parse(JSON.stringify(this._value));
return this._value;
2017-03-02 11:40:08 +00:00
}
/**
* Gets another DataSnapshot for the location at the specified relative path.
* @param path
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot#forEach
* @returns {Snapshot}
*/
child(path: string): DataSnapshot {
// TODO validate path is a string
let value = deepGet(this._value, path);
if (value === undefined) value = null;
2017-03-02 11:40:08 +00:00
const childRef = this.ref.child(path);
return new DataSnapshot(childRef, {
2017-03-02 11:40:08 +00:00
value,
key: childRef.key,
exists: value !== null,
// TODO this is wrong - child keys needs to be the ordered keys, from FB
// TODO potential solution is build up a tree/map of a snapshot and its children
// TODO natively and send that back to JS to be use in this class.
2018-04-16 09:11:18 +00:00
// null check to keep flow happy even though isObject already does this
childKeys: isObject(value) && value !== null ? Object.keys(value) : [],
2017-03-02 11:40:08 +00:00
});
}
/**
* Returns true if this DataSnapshot contains any data.
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot#exists
* @returns {boolean}
*/
2017-04-04 16:58:20 +00:00
exists(): boolean {
return this._value !== null;
2017-03-02 11:40:08 +00:00
}
/**
* Enumerates the top-level children in the DataSnapshot.
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot#forEach
* @param action
*/
2017-04-04 16:58:20 +00:00
forEach(action: (key: any) => any): boolean {
if (!this._childKeys.length) return false;
let cancelled = false;
for (let i = 0, len = this._childKeys.length; i < len; i++) {
const key = this._childKeys[i];
const childSnapshot = this.child(key);
const returnValue = action(childSnapshot);
if (returnValue === true) {
cancelled = true;
break;
}
}
return cancelled;
2017-03-02 11:40:08 +00:00
}
/**
* Gets the priority value of the data in this DataSnapshot.
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot#getPriority
* @returns {String|Number|null}
*/
2017-04-04 16:58:20 +00:00
getPriority(): string | number | null {
return this._priority;
2017-03-02 11:40:08 +00:00
}
/**
* Returns true if the specified child path has (non-null) data.
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot#hasChild
* @param path
* @returns {Boolean}
*/
2017-04-04 16:58:20 +00:00
hasChild(path: string): boolean {
return deepExists(this._value, path);
2017-03-02 11:40:08 +00:00
}
/**
* Returns whether or not the DataSnapshot has any non-null child properties.
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot#hasChildren
* @returns {boolean}
*/
2017-04-04 16:58:20 +00:00
hasChildren(): boolean {
2017-03-02 11:40:08 +00:00
return this.numChildren() > 0;
}
/**
* Returns the number of child properties of this DataSnapshot.
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot#numChildren
* @returns {Number}
*/
2017-04-04 16:58:20 +00:00
numChildren(): number {
if (!isObject(this._value)) return 0;
return Object.keys(this._value).length;
2017-03-02 11:40:08 +00:00
}
/**
* Returns a JSON-serializable representation of this object.
* @link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot#toJSON
* @returns {any}
2017-03-02 11:40:08 +00:00
*/
toJSON(): Object {
return this.val();
2017-03-02 11:40:08 +00:00
}
}