added more tests and documentation

Author: jcguarinpenaranda

src/ParseOffline.ts

@@ -134,6 +134,8 @@ export class ParseOffline {
 
   /**
    * Tests if results are still valid
+   * @param cachedResults A CachedResults object
+   * @param maxAge The maximum age of the results in milliseconds
    */
   static areCachedResultsValid(
     cachedResults: CachedResults, maxAge: number,
@@ -144,13 +146,14 @@ export class ParseOffline {
 
   /**
    * Saves an image with the given url
-   * @param imgUrl 
+   * @param imgUrl The url of the image to save
+   * @param worker A previously created service worker in your app
    */
-  static saveImageToCache(imgUrl: string, worker: Worker): Promise<any> {
+  /* static saveImageToCache(imgUrl: string, worker: Worker): Promise<any> {
     return new Promise((resolve, reject) => {
       worker.postMessage(imgUrl);
       worker.onmessage = resolve;
       worker.onerror = reject;
     });
-  }
+  } */
 }

test/ParseOffline.test.ts

@@ -1,6 +1,7 @@
 import * as Parse from 'parse/node';
 import { ParseOffline } from '../src/ParseOffline';
 import { CachedResults } from '../src/CachedResults';
+import * as moment from 'moment';
 
 const obj = new Parse.Object('Test');
 obj.set('testKey', 1);
@@ -84,3 +85,16 @@ describe('#getResultsFromTheLocalStorage', () => {
          expect(results.results).toEqual([]);
        });
 });
+
+describe('#areCachedResultsValid', () => {
+  test('should say results are not valid', () => {
+    const results = new CachedResults([], moment().subtract(3, 'day').toDate());
+    expect(ParseOffline.areCachedResultsValid(results, 3000)).toBe(false);
+  });
+
+  test('should say results are valid', () => {
+    const ONE_WEEK = 1000 * 60 * 60 * 24 * 7;
+    const results = new CachedResults([], moment().toDate());
+    expect(ParseOffline.areCachedResultsValid(results, ONE_WEEK)).toBe(true);
+  });
+});