Skip to content

refactor(database): classes for typescript database implementation #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 17, 2017
Merged

refactor(database): classes for typescript database implementation #55

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0a7540
refactor(database): classes for typescript database implementation
jsayol Jun 16, 2017
8287d24
refactor(database): requested changes & other improvements
jsayol Jun 16, 2017
c5ebc31
refactor(database): merge upstream
jsayol Jun 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions src/database/api/DataSnapshot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ import { ChildrenNode } from '../core/snap/ChildrenNode';
*/
export class DataSnapshot {
/**
* @param {!fb.core.snap.Node} node_ A SnapshotNode to wrap.
* @param {!Node} node_ A SnapshotNode to wrap.
* @param {!Reference} ref_ The ref of the location this snapshot came from.
* @param {!fb.core.snap.Index} index_ The iteration order for this snapshot
* @param {!Index} index_ The iteration order for this snapshot
*/
constructor(private readonly node_: Node,
private readonly ref_: Reference,
Expand All @@ -29,7 +29,7 @@ export class DataSnapshot {
* @return {*} JSON representation of the DataSnapshot contents, or null if empty.
*/
val(): any {
validateArgCount('firebase.database.DataSnapshot.val', 0, 0, arguments.length);
validateArgCount('DataSnapshot.val', 0, 0, arguments.length);
return this.node_.val();
}

Expand All @@ -39,15 +39,15 @@ export class DataSnapshot {
* @return {*} JSON representation of the DataSnapshot contents, or null if empty.
*/
exportVal(): any {
validateArgCount('firebase.database.DataSnapshot.exportVal', 0, 0, arguments.length);
validateArgCount('DataSnapshot.exportVal', 0, 0, arguments.length);
return this.node_.val(true);
}

// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users
toJSON(): any {
// Optional spacer argument is unnecessary because we're depending on recursion rather than stringifying the content
validateArgCount('firebase.database.DataSnapshot.toJSON', 0, 1, arguments.length);
validateArgCount('DataSnapshot.toJSON', 0, 1, arguments.length);
return this.exportVal();
}

Expand All @@ -57,7 +57,7 @@ export class DataSnapshot {
* @return {boolean} Whether the snapshot contains a non-null value, or is empty.
*/
exists(): boolean {
validateArgCount('firebase.database.DataSnapshot.exists', 0, 0, arguments.length);
validateArgCount('DataSnapshot.exists', 0, 0, arguments.length);
return !this.node_.isEmpty();
}

Expand All @@ -68,10 +68,10 @@ export class DataSnapshot {
* @return {!DataSnapshot} DataSnapshot for child node.
*/
child(childPathString: string): DataSnapshot {
validateArgCount('firebase.database.DataSnapshot.child', 0, 1, arguments.length);
validateArgCount('DataSnapshot.child', 0, 1, arguments.length);
// Ensure the childPath is a string (can be a number)
childPathString = String(childPathString);
validatePathString('firebase.database.DataSnapshot.child', 1, childPathString, false);
validatePathString('DataSnapshot.child', 1, childPathString, false);

const childPath = new Path(childPathString);
const childRef = this.ref_.child(childPath);
Expand All @@ -85,8 +85,8 @@ export class DataSnapshot {
* @return {boolean} Whether the child exists.
*/
hasChild(childPathString: string): boolean {
validateArgCount('firebase.database.DataSnapshot.hasChild', 1, 1, arguments.length);
validatePathString('firebase.database.DataSnapshot.hasChild', 1, childPathString, false);
validateArgCount('DataSnapshot.hasChild', 1, 1, arguments.length);
validatePathString('DataSnapshot.hasChild', 1, childPathString, false);

const childPath = new Path(childPathString);
return !this.node_.getChild(childPath).isEmpty();
Expand All @@ -98,7 +98,7 @@ export class DataSnapshot {
* @return {string|number|null} The priority.
*/
getPriority(): string | number | null {
validateArgCount('firebase.database.DataSnapshot.getPriority', 0, 0, arguments.length);
validateArgCount('DataSnapshot.getPriority', 0, 0, arguments.length);

// typecast here because we never return deferred values or internal priorities (MAX_PRIORITY)
return /**@type {string|number|null} */ <string | number | null>(this.node_.getPriority().val());
Expand All @@ -113,8 +113,8 @@ export class DataSnapshot {
* one of the child nodes.
*/
forEach(action: (d: DataSnapshot) => any): boolean {
validateArgCount('firebase.database.DataSnapshot.forEach', 1, 1, arguments.length);
validateCallback('firebase.database.DataSnapshot.forEach', 1, action, false);
validateArgCount('DataSnapshot.forEach', 1, 1, arguments.length);
validateCallback('DataSnapshot.forEach', 1, action, false);

if (this.node_.isLeafNode())
return false;
Expand All @@ -131,7 +131,7 @@ export class DataSnapshot {
* @return {boolean} True if the DataSnapshot contains 1 or more child nodes.
*/
hasChildren(): boolean {
validateArgCount('firebase.database.DataSnapshot.hasChildren', 0, 0, arguments.length);
validateArgCount('DataSnapshot.hasChildren', 0, 0, arguments.length);

if (this.node_.isLeafNode())
return false;
Expand All @@ -143,7 +143,7 @@ export class DataSnapshot {
* @return {?string} The key of the location this snapshot's data came from.
*/
getKey(): string | null {
validateArgCount('firebase.database.DataSnapshot.key', 0, 0, arguments.length);
validateArgCount('DataSnapshot.key', 0, 0, arguments.length);

return this.ref_.getKey();
}
Expand All @@ -157,7 +157,7 @@ export class DataSnapshot {
* @return {number} The number of children that this DataSnapshot contains.
*/
numChildren(): number {
validateArgCount('firebase.database.DataSnapshot.numChildren', 0, 0, arguments.length);
validateArgCount('DataSnapshot.numChildren', 0, 0, arguments.length);

return this.node_.numChildren();
}
Expand All @@ -166,7 +166,7 @@ export class DataSnapshot {
* @return {Reference} The Firebase reference for the location this snapshot's data came from.
*/
getRef(): Reference {
validateArgCount('firebase.database.DataSnapshot.ref', 0, 0, arguments.length);
validateArgCount('DataSnapshot.ref', 0, 0, arguments.length);

return this.ref_;
}
Expand Down
Loading