@types/google-spreadsheet - npm Package Compare versions

Comparing version 3.2.3 to 3.3.0

google-spreadsheet/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for google-spreadsheet 3.2
+// Type definitions for google-spreadsheet 3.3
 // Project: https://github.com/theoephraim/node-google-spreadsheet
@@ -19,3 +19,12 @@ // Definitions by: the-vampiire <https://github.com/the-vampiire>
 
-export type CellErrorType = 'ERROR' | 'NULL_VALUE' | 'DIVIDE_BY_ZERO' | 'VALUE' | 'REF' | 'NAME' | 'NUM' | 'N_A' | 'LOADING';
+export type CellErrorType =
+    | 'ERROR'
+    | 'NULL_VALUE'
+    | 'DIVIDE_BY_ZERO'
+    | 'VALUE'
+    | 'REF'
+    | 'NAME'
+    | 'NUM'
+    | 'N_A'
+    | 'LOADING';
 
@@ -295,3 +304,3 @@ export type HorizontalAlign = 'LEFT' | 'CENTER' | 'RIGHT';
 export interface OAuth2Client {
-    getAccessToken: () => Promise<GetAccessTokenResponse> ;
+    getAccessToken: () => Promise<GetAccessTokenResponse>;
 }
@@ -303,3 +312,3 @@
 export class GoogleSpreadsheetCell implements CellFormat {
-    constructor(parentSheet: GoogleSpreadsheetWorksheet, rowIndex: number, columnIndex: number, cellData: any)
+    constructor(parentSheet: GoogleSpreadsheetWorksheet, rowIndex: number, columnIndex: number, cellData: any);
 
@@ -512,3 +521,3 @@ // #region IMPLEMENTED PROPERTIES
 export class GoogleSpreadsheetRow {
-    constructor(parentSheet: GoogleSpreadsheetWorksheet, rowNumber: number, data: any)
+    constructor(parentSheet: GoogleSpreadsheetWorksheet, rowNumber: number, data: any);
 
@@ -519,3 +528,3 @@ /**
      */
-    [x: string]: any
+    [x: string]: any;
 
@@ -627,3 +636,6 @@ /**
 export class GoogleSpreadsheetWorksheet implements WorksheetBasicProperties {
-    constructor(parentSpreadsheet: GoogleSpreadsheetWorksheet, { properties, data }: { properties: WorksheetBasicProperties, data?: any })
+    constructor(
+        parentSpreadsheet: GoogleSpreadsheetWorksheet,
+        { properties, data }: { properties: WorksheetBasicProperties; data?: any },
+    );
 
@@ -819,4 +831,4 @@ // #region BASIC PROPERTIES
             | {
-                [header: string]: string | number | boolean;
-            }
+                  [header: string]: string | number | boolean;
+              }
             | Array<string | number | boolean>,
@@ -840,8 +852,8 @@ options?: { raw: boolean; insert: boolean },
     addRows(
-        rowValues: Array<(
+        rowValues: Array<
             | {
-                [header: string]: string | number | boolean;
-            }
+                  [header: string]: string | number | boolean;
+              }
             | Array<string | number | boolean>
-        )>,
+        >,
         options?: { raw: boolean; insert: boolean },
@@ -899,12 +911,28 @@ ): Promise<GoogleSpreadsheetRow[]>;
      */
-    insertDimension(columnsOrRows: WorksheetDimension, bounds: WorksheetDimensionBounds, inheritFromBefore?: boolean): Promise<void>;
+    insertDimension(
+        columnsOrRows: WorksheetDimension,
+        bounds: WorksheetDimensionBounds,
+        inheritFromBefore?: boolean,
+    ): Promise<void>;
 
     /**
      * @description
-     * clear all data/cells in the worksheet
+     * defaults to clearing the entire sheet, or pass in a specific a1 range
+     *
+     * @param a1Range optional specific range within the sheet to clear
      */
-    clear(): Promise<void>;
+    clear(a1Range?: string): Promise<void>;
 
     /**
      * @description
+     * clear data/cells in a range of rows, defaulting to all rows after the header row(s)
+     *
+     * @param options options to control which rows to clear:
+     * - start: A1 style row number of first row to clear, defaults to first non-header row
+     * - end: A1 style row number of last row to clear, defaults to last row
+     */
+    clearRows(options?: { start: number; end: number }): Promise<void>;
+
+    /**
+     * @description
      * delete the worksheet
@@ -911,0 +939,0 @@ */

google-spreadsheet/package.json

 {
     "name": "@types/google-spreadsheet",
-    "version": "3.2.3",
+    "version": "3.3.0",
     "description": "TypeScript definitions for google-spreadsheet",
@@ -28,4 +28,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/google-spreadsheet",
     "dependencies": {},
-    "typesPublisherContentHash": "24c3478ed991f07e0cf1a4298baa95b1e95652cba479e5dd572233ad1b91b0c2",
+    "typesPublisherContentHash": "1b139ad98a9232065097d8893ba500d38f98ad6bc52f96d45aa2b946d2fc9b0e",
     "typeScriptVersion": "4.0"
 }

google-spreadsheet/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Sat, 25 Jun 2022 20:01:37 GMT
+ * Last updated: Wed, 06 Jul 2022 22:02:20 GMT
  * Dependencies: none
@@ -14,0 +14,0 @@ * Global values: none

No alert changes

Improved metrics

Total package byte prevSize

33799

increased by2.01%

Lines of code

1055

increased by2.63%

No dependency changes