chore: Update helpers with cleaner comments and less dependencies.

templates/helpers/animationInterval.ts

@@ -1,11 +1,9 @@
 /**
  * Corss-browser, time perfect, animation interval.
- * @function
  *
  * @param  {number}      ms when to ship animation; interval
  * @param  {AbortSignal} signal performant abort of interval
  * @param  {function}    callback get time for next frame
- * @return {void}
  */
 export const animationInterval = (
   ms: number,

templates/helpers/arithmeticProgression.ts

@@ -1,10 +1,5 @@
 /**
  * Creates an array of numbers in the arithmetic progression, starting with the given positive integer and up to the specified limit.
- * @function
- *
- * @param {number} number
- * @param {number} limit
- * @returns {number[]}
  */
 export const arithmeticProgression = (
   number: number,

templates/helpers/arrayContainsObject.ts

@@ -2,12 +2,6 @@ import { deepCheck } from './objectsEqual';
 
 /**
  * Determine if object is found in given array.
- * @function
- *
- * @param   {array}   arr array to lookup against
- * @param   {object}  obj object to search for
- *
- * @returns {boolean} is obj in array
  */
 export const arrayContainsObject = <A, O>(arr: A[], obj: O): boolean =>
   arr.some((elem) => deepCheck(elem, obj));

templates/helpers/arrayDiff.ts

@@ -1,12 +1,5 @@
 /**
  * Diff two arrays of objects by key.
- * @function
- *
- * @param   {array}  arr1 first array to compare
- * @param   {array}  arr2 second array to comprare
- * @param   {string} key  objecy key (in arrays) to compare against
- *
- * @returns {array}  diff between two arrays
  */
 export const arrayDiff = <A, B>(arr1: A[], arr2: B[], key: string): : any[] =>
   arr1.filter((item1) => !arr2.some((item2) => item1[key] === item2[key]));

templates/helpers/arrayToObject.ts

@@ -1,11 +1,5 @@
 /**
  * Convert array to object sorted by given key value.
- * @function
- *
- * @param   {array}  array raw data source
- * @param   {string} key   kay-value to re-organize by
- *
- * @returns {object} record by title key
  */
 export const arrayToObject = <A, T>(array: A[], key = "title"): Type => {
   const initialValue = {};

templates/helpers/arrayUniqueCount.ts

@@ -4,10 +4,6 @@ interface Aggregate {
 
 /**
  * Aggregates unique values in an array.
- * @function
- *
- * @param {array} iterable array of items to count
- * @returns {object} object with unique items and their count
  */
 export const countUnique = (iterable: string[]) =>
   iterable.reduce((acc: Aggregate, item) => {
@@ -18,10 +14,6 @@ export const countUnique = (iterable: string[]) =>
 /**
  * Aggregates unique values in an array.
  * Sorted by count descending.
- * @function
- *
- * @param {array} iterable array of items to count
- * @returns {object} object with unique items and their count
  */
 export const countUniqueSorted = (iterable: string[]) =>
   Object.entries(countUnique(iterable))

templates/helpers/binarySearch.ts

@@ -9,12 +9,6 @@ const lessThan = (a: : string | number, b: : string | number): boolean => compar
 
 /**
  * Binary search implementation.
- * @function
- *
- * @param  {*[]}    sortedArray
- * @param  {*}      seekElement
- *
- * @return {number}
  */
 export const binarySearch = <A>(sortedArray: A[], seekElement: : string | number): number => {
   // These two indices will contain current array (sub-array) boundaries.

templates/helpers/bufferToFile.ts

@@ -4,12 +4,6 @@ const { writeFile } = promises;
 
 /**
  * Save buffer as local file.
- * @function
- *
- * @param   {Buffer} data media buffer to save
- * @param   {string} name file name
- *
- * @returns {Promise<void>}
  */
 export const bufferToFile = async (data: Buffer, name: string): Promise<void> => {
   try {

templates/helpers/cleanObject.ts

@@ -1,9 +1,5 @@
 /**
  * Remove null or undefined values from an object.
- * @function
- *
- * @param {*} obj entry object to cleanup
- * @returns clean object
  */
 export const cleanObject = <O, T>(obj: O): T =>
   Object.fromEntries(

templates/helpers/comparison.ts

@@ -1,11 +1,5 @@
 /**
  * Default comparison function. It just assumes that "a" and "b" are strings or numbers.
- * @function
- *
- * @param   {(string|number)} a
- * @param   {(string|number)} b
- *
- * @returns {number}
  */
 export const compare = (a: string | number, b: string | number): number => {
   if (a === b) {
@@ -17,57 +11,27 @@ export const compare = (a: string | number, b: string | number): number => {
 
 /**
  * Checks if two variables are equal.
- * @function
- *
- * @param  {*} a
- * @param  {*} b
- *
- * @return {boolean}
  */
 export const equal = <A, B>(a: A, b: B): boolean => compare(a, b) === 0;
 
 /**
  * Checks if variable "a" is less than "b".
- * @function
- *
- * @param  {*} a
- * @param  {*} b
- *
- * @return {boolean}
  */
 export const lessThan = <A, B>(a: A, b: B): boolean => compare(a, b) < 0;
 
 /**
  * Checks if variable "a" is less than or equal to "b".
- * @function
- *
- * @param  {*} a
- * @param  {*} b
- *
- * @return {boolean}
  */
 export const lessThanOrEqual = <A, B>(a: A, b: B): boolean =>
   lessThan(a, b) || equal(a, b);
 
 /**
  * Checks if variable "a" is greater than "b".
- * @function
- *
- * @param  {*} a
- * @param  {*} b
- *
- * @return {boolean}
  */
 export const greaterThan = <A, B>(a: A, b: B): boolean => compare(a, b) > 0;
 
 /**
  * Checks if variable "a" is greater than or equal to "b".
- * @function
- *
- * @param  {*} a
- * @param  {*} b
- *
- * @return {boolean}
  */
 export const greaterThanOrEqual = <A, B>(a: A, b: B): boolean =>
   greaterThan(a, b) || equal(a, b);

templates/helpers/cookies.ts

@@ -1,9 +1,5 @@
 /**
  * Sets a cookie with an optional expiration time.
- *
- * @param name - The name of the cookie.
- * @param value - The value of the cookie.
- * @param expires - The expiration time in seconds or a specific Date object.
  */
 export const setCookie = (
   name: string,
@@ -29,9 +25,6 @@ export const setCookie = (
 
 /**
  * Retrieves the value of a specified cookie.
- *
- * @param name - The name of the cookie to retrieve.
- * @returns The value of the cookie, or null if not found.
  */
 export const getCookie = (name: string): string | null => {
   const nameEQ = `${name}=`

templates/helpers/countSubstrings.ts

@@ -1,10 +1,5 @@
 /**
  * Counts the occurrences of a substring in a given string.
- * @function
- *
- * @param {string} str string to search
- * @param {string} searchValue value to search for
- * @returns {number} found occurrences
  */
 export const countSubstrings = (str: string, searchValue: string): number => {
   let count = 0;

templates/helpers/createBuffer.ts

@@ -2,11 +2,6 @@ import { Readable } from 'stream';
 
 /**
  * Create buffer from readable stream.
- * @function
- * @async
- *
- * @param {Readable} stream
- * @returns {Buffer} video buffer
  */
 export const createBuffer = async (stream: Readable): Promise<Buffer> => {
   const chunks = [];

templates/helpers/dashToCamelCase.ts

@@ -1,10 +1,5 @@
 /**
- * Dashed string to camel case.
- * @function
- *
- * @param   {string} str dash separate string
- *
- * @returns {string} camelCased string
+ * Convert dashed string to camel case.
  */
 export const dashToCamelCase = (str: string): string =>
   str