docs: improve comments for typedoc

rambler-digital-solutions · Aug 15, 2024 · bb23801 · bb23801
1 parent 8df5e85
commit bb23801
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 9 deletions.
diff --git a/packages/async/index.ts b/packages/async/index.ts
@@ -3,7 +3,8 @@
 const RETRIES_LEFT = 3
 const INTERVAL = 500
 
-export type PromiseFactory<T> = (...args: any[]) => Promise<T>
+/** Retryable function */
+export type RetryableFunction<T> = (...args: any[]) => Promise<T>
 
 /** Retry options */
 export interface RetryOptions {
@@ -19,15 +20,15 @@ export interface RetryOptions {
 
 /** Retry function call */
 export function retry<T>(
-  factory: PromiseFactory<T>,
+  retryableFunction: RetryableFunction<T>,
   options: RetryOptions = {}
-): PromiseFactory<T> {
+): RetryableFunction<T> {
   let {retries = RETRIES_LEFT} = options
   const {timeout = INTERVAL, shouldRetry = () => true, signal} = options
 
   async function call(...args: any[]): Promise<T> {
     try {
-      return await factory(...args)
+      return await retryableFunction(...args)
     } catch (error: any) {
       if (--retries < 1 || !shouldRetry(error)) {
         throw error

diff --git a/packages/crypto/crypto.ts b/packages/crypto/crypto.ts
@@ -11,7 +11,8 @@ export function isSupported() {
   return !!crypto
 }
 
-type TypedArray =
+/** Typed array */
+export type TypedArray =
   | Int8Array
   | Uint8Array
   | Uint8ClampedArray

diff --git a/packages/crypto/index.ts b/packages/crypto/index.ts
@@ -1,5 +1,5 @@
 /* eslint-disable import/no-unused-modules */
-export {getRandomValues, isSupported, subtle} from './crypto'
+export {getRandomValues, isSupported, subtle, type TypedArray} from './crypto'
 export {
   bufferFromString,
   stringFromBuffer,

diff --git a/packages/errors/index.ts b/packages/errors/index.ts
@@ -28,6 +28,7 @@ export class GenericError extends Error {
   code: GenericErrorInput['code']
   details?: GenericErrorInput['details']
 
+  /** Generic error constructor */
   constructor(message: string, input?: GenericErrorInput) {
     super()
     this.name = 'GenericError'

diff --git a/packages/splits/index.ts b/packages/splits/index.ts
@@ -74,6 +74,7 @@ export class Splits {
   private tests: SplitTest[]
   private options: SplitsOptions
 
+  /** Splits constructor */
   public constructor(tests: SplitTest[], options: SplitsOptions = {}) {
     if (!Array.isArray(tests) || !tests.length) {
       throw new Error('expected `settings.tests` is not empty array')

diff --git a/packages/url/index.ts b/packages/url/index.ts
@@ -1,10 +1,13 @@
 /* eslint-disable import/no-unused-modules */
 
-export type ParsedQuery<T = string> = Record<string, T | T[] | null | undefined>
-
+/** Query object */
 export type Query = Record<string, any>
 
-interface UrlObject {
+/** Parsed query object */
+export type ParsedQuery<T = string> = Record<string, T | T[] | null | undefined>
+
+/** URL object */
+export interface UrlObject {
   protocol?: string | null
   host?: string | null
   pathname?: string | null