Merge pull request #11 from davideast/getKey

fix(key): Change key() to getKey()

src/querybase.ts

@@ -201,12 +201,12 @@ class Querybase {
 
   // read only properties
 
-  // Returns a read-only Firebase reference
+  // Returns a read-only Database reference
   ref: () => Firebase;
   // Returns a read-only set of indexes
   indexOn: () => string[];
-  // the key of the Firebase ref
-  key: () => string;
+  // the key of the Database ref
+  getKey: () => string;
   // the set of indexOn keys base64 encoded
   private encodedKeys: () => string[];
 
@@ -223,7 +223,7 @@ class Querybase {
     this.ref = () => ref;
     this.indexOn = () => indexOn;
     /* istanbul ignore next */
-    this.key = () => this.ref().key();
+    this.getKey = () => this.ref().getKey();
     this.encodedKeys = () => this.encodeKeys(this.indexOn());
   }
 

tests/unit/querybase.spec.js

@@ -57,6 +57,16 @@ describe('Querybase', () => {
 
   });
 
+  describe('getKey', () => {
+
+    it('should throw if no indexes are provided', () => {
+      const querybaseRef = querybase.ref(ref, ['name', 'age']);
+      const key = querybaseRef.getKey();
+      assert.equal(key, 'items');
+    });    
+
+  });
+
   describe('set', () => {
 
     it('should call the Firebase set function', () => {

typings/firebase/firebase.d.ts

@@ -47,7 +47,7 @@ interface FirebaseDataSnapshot {
 	/**
 	 * Gets the key name of the location that generated this DataSnapshot.
 	 */
-	key(): string;
+	getKey(): string;
 	/**
 	 * @deprecated Use key() instead.
 	 * Gets the key name of the location that generated this DataSnapshot.
@@ -238,7 +238,7 @@ interface Firebase extends FirebaseQuery {
 	/**
 	 * Returns the last token in a Firebase location.
 	 */
-	key(): string;
+	getKey(): string;
 	/**
 	 * @deprecated Use key() instead.
 	 * Returns the last token in a Firebase location.