Merge pull request #11 from MaksymStoianov/max/next

Max/next

Author: MaksymStoianov

README.md

@@ -1,13 +1,15 @@
 import { hashCode } from "../base";
 
 /**
+ * ## Class
+ *
  * Abstract base class providing fundamental functionality for subclasses.
  * Intended to be extended by other classes.
  *
  * @abstract
  * @class    Class
- * @since    0.1.0
- * @version  0.1.0
+ * @since    1.0.0
+ * @version  1.0.0
  */
 export abstract class Class {
   /**
@@ -44,6 +46,7 @@ export abstract class Class {
    *  - `true` if the objects are equivalent,
    *  - `false` otherwise.
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   equals(input: any): boolean {
     if (this === input) {
       return true;
@@ -76,10 +79,12 @@ export abstract class Class {
    */
   valueOf(): object {
     const result: {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       [key: string]: any;
     } = {};
 
     for (const key of Object.keys(this)) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       result[key] = (this as any)[key];
     }
 

src/abstract/Class.ts

@@ -1,10 +1,14 @@
 import { requireValidEmail } from "../base";
 
 /**
+ * ## checkMultipleAccount
+ *
  * If the user is logged into multiple accounts in the same browser session, `google.script.run` might execute under a different account than the one that initiated the UI display.
  *
  * @param       email - The email address of the account that initiated the display of the user interface.
  * @returns     `true` if the initiating account's email does not match the effective user's email, indicating a multi-account conflict; `false` otherwise.
+ * @since       1.0.0
+ * @version     1.0.0
  * @environment `Google Apps Script`
  */
 export function checkMultipleAccount(email: string): boolean {

src/appsscript/checkMultipleAccount.ts

@@ -1,10 +1,14 @@
 import { requireString } from "../base";
 
 /**
+ * ## getByteSize
+ *
  * Returns the length of a string in `UTF-8` encoding, measured in bytes.
  *
  * @param       value - The string whose length will be calculated in bytes.
  * @returns     The length of the input string in bytes.
+ * @since       1.0.0
+ * @version     1.0.0
  * @environment `Google Apps Script`
  */
 export function getByteSize(value: string): number {

src/appsscript/getByteSize.ts

@@ -3,10 +3,15 @@ import { isFunction, isObject } from "../base";
 type HtmlOutput = GoogleAppsScript.HTML.HtmlOutput;
 
 /**
+ * ## isHtmlOutput
+ *
  * Checks if the given value is a Google Apps Script [`HtmlOutput`](https://developers.google.com/apps-script/reference/html/html-output) object.
  *
  * @param       value - The value to check.
  * @returns     `true` if the value is an {@link GoogleAppsScript.HTML.HtmlOutput|HtmlOutput} object, `false` otherwise.
+ * @see         [Class HtmlOutput](https://developers.google.com/apps-script/reference/html/html-output)
+ * @since       1.0.0
+ * @version     1.0.0
  * @environment `Google Apps Script`
  */
 export function isHtmlOutput(value: unknown): value is HtmlOutput {

src/appsscript/isHtmlOutput.ts

@@ -3,10 +3,15 @@ import { isFunction, isObject } from "../base";
 type TextOutput = GoogleAppsScript.Content.TextOutput;
 
 /**
+ * ## isTextOutput
+ *
  * Checks if the given value is a Google Apps Script [`TextOutput`](https://developers.google.com/apps-script/reference/content/text-output) object.
  *
  * @param       value - The value to check.
  * @returns     `true` if the value is an {@link GoogleAppsScript.Content.TextOutput|TextOutput} object, `false` otherwise.
+ * @see         [Class TextOutput](https://developers.google.com/apps-script/reference/content/text-output)
+ * @since       1.0.0
+ * @version     1.0.0
  * @environment `Google Apps Script`
  */
 export function isTextOutput(value: unknown): value is TextOutput {

src/appsscript/isTextOutput.ts

@@ -1,10 +1,15 @@
 import { isObject } from "../base";
 
 /**
+ * ## isUi
+ *
  * Checks if the given value is a Google Apps Script [`Ui`](https://developers.google.com/apps-script/reference/base/ui.html) object.
  *
  * @param       value - The value to check.
  * @returns     `true` if the value is an {@link GoogleAppsScript.Base.Ui|Ui} object, `false` otherwise.
+ * @see         [Class Ui](https://developers.google.com/apps-script/reference/base/ui.html)
+ * @since       1.0.0
+ * @version     1.0.0
  * @environment `Google Apps Script`
  */
 export function isUi(value: unknown): value is GoogleAppsScript.Base.Ui {

src/appsscript/isUi.ts

@@ -1,14 +1,19 @@
 import { appendColumns, Options } from "./appendColumns";
 
 /**
+ * ## appendColumn
+ *
  * Appends a single column to the right of the current data area on a [`sheet`](https://developers.google.com/apps-script/reference/spreadsheet/sheet).
  * If a cell's content starts with `=`, it is interpreted as a formula.
  *
  * @param       sheet - The Google Apps Script {@link GoogleAppsScript.Spreadsheet.Sheet|Sheet} object to which the column will be appended.
  * @param       values - A 1D array containing the data for the single column.
  * @param       [options] - Additional parameters to customize the method's behavior.
  * @returns     The {@link GoogleAppsScript.Spreadsheet.Sheet|Sheet} object.
- * @since       0.1.0
+ * @see         appendColumns
+ * @see         [Class Range](https://developers.google.com/apps-script/reference/spreadsheet/range)
+ * @see         [Class Sheet](https://developers.google.com/apps-script/reference/spreadsheet/sheet)
+ * @since       1.0.0
  * @version     1.4.0
  * @environment `Google Apps Script`
  * @author      Maksym Stoianov <stoianov.maksym@gmail.com>

src/appsscript/sheets/appendColumn.ts

@@ -10,10 +10,12 @@ export interface Options {
 }
 
 /**
+ * ## appendColumns
+ *
  * Appends columns to the right of the current data area on a [`sheet`](https://developers.google.com/apps-script/reference/spreadsheet/sheet).
  * If a cell's content starts with `=`, it will be interpreted as a formula.
  *
- * #### Example
+ * @example
  * ```javascript
  * const ss = SpreadsheetApp.getActiveSpreadsheet();
  * const sheet = ss.getSheetByName('Sheet Name');
@@ -29,7 +31,10 @@ export interface Options {
  * @param       values - A 2D array containing the data to append.
  * @param       [options] - Additional parameters to customize the method's behavior.
  * @returns     The {@link GoogleAppsScript.Spreadsheet.Sheet|Sheet} object.
- * @since       0.1.0
+ * @see         appendColumn
+ * @see         [Class Range](https://developers.google.com/apps-script/reference/spreadsheet/range)
+ * @see         [Class Sheet](https://developers.google.com/apps-script/reference/spreadsheet/sheet)
+ * @since       1.0.0
  * @version     1.4.0
  * @environment `Google Apps Script`
  * @author      Maksym Stoianov <stoianov.maksym@gmail.com>

src/appsscript/sheets/appendColumns.ts

@@ -1,14 +1,20 @@
 import { appendRows, Options } from "./appendRows";
 
 /**
+ * ## appendRow
+ *
  * Appends a single row to the bottom of the current data area on a [`sheet`](https://developers.google.com/apps-script/reference/spreadsheet/sheet).
  * If a cell's content starts with `=`, it is interpreted as a formula.
  *
  * @param       sheet - The Google Apps Script {@link GoogleAppsScript.Spreadsheet.Sheet|Sheet} object to which the row will be appended.
  * @param       values - A 1D array containing the data for the single row.
  * @param       [options] - Additional parameters to customize the method's behavior.
  * @returns     The {@link GoogleAppsScript.Spreadsheet.Sheet|Sheet} object.
- * @since       0.1.0
+ * @see         prependRow
+ * @see         appendRows
+ * @see         [Class Range](https://developers.google.com/apps-script/reference/spreadsheet/range)
+ * @see         [Class Sheet](https://developers.google.com/apps-script/reference/spreadsheet/sheet)
+ * @since       1.0.0
  * @version     1.4.0
  * @environment `Google Apps Script`
  * @author      Maksym Stoianov <stoianov.maksym@gmail.com>