rename doc.getInfo to loadInfo

theoephraim · Feb 3, 2020 · 87812c3 · 87812c3
1 parent 1e63a36
commit 87812c3
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 19 deletions.
diff --git a/docs/classes/google-spreadsheet.md b/docs/classes/google-spreadsheet.md
@@ -77,6 +77,11 @@ Param|Type|Required|Description
 
 ### Basic info
 
+#### `loadInfo()` (async) :id=fn-loadInfo
+> Load basic document props and child sheets
+
+- :sparkles: **Side Effects -** props are populated, sheets are populated
+
 #### `updateProperties(props)` (async) :id=fn-updateProperties
 > Update basic document properties
 
@@ -92,7 +97,7 @@ See [basic document properties](#basic-document-properties) above for props docu
 #### `resetLocalCache()` :id=fn-resetLocalCache
 > Clear local cache of properties and sheets
 
-You must call `getInfo()` again to re-load the properties and sheets
+You must call `loadInfo()` again to re-load the properties and sheets
 
 - :sparkles: **Side Effects -** basic props and sheets are gone
 

diff --git a/lib/GoogleSpreadsheet.js b/lib/GoogleSpreadsheet.js
@@ -141,7 +141,7 @@ class GoogleSpreadsheet {
   }
 
   _ensureInfoLoaded() {
-    if (!this._rawProperties) throw new Error('You must call `sheet.getInfo()` before accessing this property');
+    if (!this._rawProperties) throw new Error('You must call `sheet.loadInfo()` before accessing this property');
   }
 
   _updateRawProperties(newProperties) { this._rawProperties = newProperties; }
@@ -200,7 +200,7 @@ class GoogleSpreadsheet {
   }
 
   // BASIC INFO ////////////////////////////////////////////////////////////////////////////////////
-  async getInfo(includeCells) {
+  async loadInfo(includeCells) {
     const response = await this.axios.get('/', {
       params: {
         ...includeCells && { includeGridData: true },
@@ -209,6 +209,7 @@ class GoogleSpreadsheet {
     this._rawProperties = response.data.properties;
     _.each(response.data.sheets, (s) => this._updateOrCreateSheet(s));
   }
+  async getInfo() { return this.loadInfo(); } // alias to mimic old version
 
   resetLocalCache() {
     this._rawProperties = null;
@@ -248,8 +249,7 @@ class GoogleSpreadsheet {
 
     return newSheet;
   }
-  // just an alias to mimic old version of this module
-  async addWorksheet(properties) { return this.addSheet(properties); }
+  async addWorksheet(properties) { return this.addSheet(properties); } // alias to mimic old version
 
   async deleteSheet(sheetId) {
     // Request type = `deleteSheet`

diff --git a/lib/GoogleSpreadsheetWorksheet.js b/lib/GoogleSpreadsheetWorksheet.js
@@ -33,7 +33,7 @@ class GoogleSpreadsheetWorksheet {
 
   _ensureInfoLoaded() {
     if (!this._rawProperties) {
-      throw new Error('You must call `doc.getInfo()` again before accessing this property');
+      throw new Error('You must call `doc.loadInfo()` again before accessing this property');
     }
   }
 

diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "author": "Theo Ephraim <[email protected]> (https://theoephraim.com)",
   "name": "google-spreadsheet",
   "description": "Google Sheets API (v4) -- simple interface to read/write data and manage sheets",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "license": "Unlicense",
   "keywords": [
     "google spreadsheets",

diff --git a/test/auth.test.js b/test/auth.test.js
@@ -11,7 +11,7 @@ function checkDocAccess(docType, spec) {
   describe(`Doc type = ${docType}`, () => {
     if (spec.canRead) {
       it('reading info should succeed', async () => {
-        await doc.getInfo();
+        await doc.loadInfo();
         expect(doc.title).toBeTruthy();
         sheet = doc.sheetsByIndex[0];
       });
@@ -21,7 +21,7 @@ function checkDocAccess(docType, spec) {
       });
     } else {
       it('reading info should fail', async () => {
-        await expect(doc.getInfo()).rejects.toThrow(spec.readError);
+        await expect(doc.loadInfo()).rejects.toThrow(spec.readError);
       });
     }
 
@@ -41,8 +41,8 @@ function checkDocAccess(docType, spec) {
 
 describe('Authentication', () => {
   describe('without setting auth', () => {
-    it('getInfo should fail on any doc', async () => {
-      await expect(docs.public.getInfo()).rejects.toThrow(
+    it('loadInfo should fail on any doc', async () => {
+      await expect(docs.public.loadInfo()).rejects.toThrow(
         'initialize some kind of auth',
       );
     });

diff --git a/test/manage.test.js b/test/manage.test.js
@@ -16,7 +16,7 @@ describe('Managing doc info and sheets', () => {
     });
 
     it('can load the doc info', async () => {
-      await doc.getInfo();
+      await doc.loadInfo();
     });
 
     it('should include the document title', async () => {
@@ -44,7 +44,7 @@ describe('Managing doc info and sheets', () => {
 
       // make sure the update actually stuck
       doc.resetLocalCache();
-      await doc.getInfo();
+      await doc.loadInfo();
       expect(doc.title).toBe(newTitle);
 
       // set the title back
@@ -77,7 +77,7 @@ describe('Managing doc info and sheets', () => {
 
     it('check the sheet is actually there', async () => {
       doc.resetLocalCache();
-      await doc.getInfo(); // re-fetch
+      await doc.loadInfo(); // re-fetch
       const newSheet = doc.sheetsByIndex.pop();
       expect(newSheet.title).toBe(sheet.title);
       expect(newSheet.rowCount).toBe(sheet.rowCount);
@@ -118,7 +118,7 @@ describe('Managing doc info and sheets', () => {
 
       // make sure the update actually stuck
       sheet.resetLocalCache();
-      await doc.getInfo();
+      await doc.loadInfo();
       expect(sheet.title).toBe(newTitle);
     });
 
@@ -128,7 +128,7 @@ describe('Managing doc info and sheets', () => {
       await sheet.resize({ rowCount: 77, columnCount: 44 });
       expect(sheet.rowCount).toBe(77);
       sheet.resetLocalCache();
-      await doc.getInfo();
+      await doc.loadInfo();
       expect(sheet.rowCount).toBe(77);
     });
 
@@ -147,7 +147,7 @@ describe('Managing doc info and sheets', () => {
     let numSheets;
 
     it('can remove a sheet', async () => {
-      await doc.getInfo();
+      await doc.loadInfo();
       numSheets = doc.sheetsByIndex.length;
 
       sheet = await doc.addWorksheet({
@@ -161,7 +161,7 @@ describe('Managing doc info and sheets', () => {
 
     it('check the sheet is really gone', async () => {
       doc.resetLocalCache();
-      await doc.getInfo();
+      await doc.loadInfo();
       expect(doc.sheetsByIndex.length).toBe(numSheets);
     });
   });
@@ -188,7 +188,7 @@ describe('Managing doc info and sheets', () => {
       await sheet.copyToSpreadsheet(docs.public.spreadsheetId);
 
       await docs.public.useServiceAccountAuth(creds);
-      await docs.public.getInfo();
+      await docs.public.loadInfo();
 
       // check title and content (header row)
       const copiedSheet = docs.public.sheetsByIndex.splice(-1)[0];