@dereekb/zoom 13.4.0 → 13.4.2

package/src/lib/zoom.error.api.d.ts

@@ -63,13 +63,14 @@ export declare function logZoomServerErrorFunction(zoomApiNamePrefix: string): L
  * @returns
  */
 export type HandleZoomErrorFetchFactory = (fetch: ConfiguredFetch, logError?: LogZoomServerErrorFunction) => ConfiguredFetch;
-export type ParsedZoomServerError = FetchRequestFactoryError | ZoomServerError | undefined;
+export type ParsedZoomServerError = Maybe<FetchRequestFactoryError | ZoomServerError>;
 export type ParseZoomFetchResponseErrorFunction = (responseError: FetchResponseError) => Promise<ParsedZoomServerError>;
 /**
  * Wraps a ConfiguredFetch to support handling errors returned by fetch.
  *
- * @param fetch
- * @returns
+ * @param parseZoomError Function to parse fetch response errors into typed Zoom errors
+ * @param defaultLogError Default error logging function
+ * @returns A factory that wraps ConfiguredFetch with error handling
  */
 export declare function handleZoomErrorFetchFactory(parseZoomError: ParseZoomFetchResponseErrorFunction, defaultLogError: LogZoomServerErrorFunction): HandleZoomErrorFetchFactory;
 /**
@@ -118,6 +119,12 @@ export interface ZoomRateLimitHeaderDetails {
      */
     readonly retryAfterAt?: Date;
 }
+/**
+ * Parses rate limit header details from a Zoom API response.
+ *
+ * @param headers The response headers to parse
+ * @returns Parsed rate limit details, or null if required headers are missing
+ */
 export declare function zoomRateLimitHeaderDetails(headers: Headers): Maybe<ZoomRateLimitHeaderDetails>;
 export declare class ZoomTooManyRequestsError extends ZoomServerFetchResponseError {
     get headerDetails(): Maybe<ZoomRateLimitHeaderDetails>;
@@ -125,9 +132,9 @@ export declare class ZoomTooManyRequestsError extends ZoomServerFetchResponseErr
 /**
  * Function that parses/transforms a ZoomServerErrorData into a general ZoomServerError or other known error type.
  *
- * @param errorResponseData
- * @param responseError
- * @returns
+ * @param zoomServerError The error data from the Zoom API
+ * @param responseError The original fetch response error
+ * @returns A typed ZoomServerFetchResponseError, or undefined
  */
 export declare function parseZoomServerErrorData(zoomServerError: ZoomServerErrorData, responseError: FetchResponseError): ZoomServerFetchResponseError | undefined;
 export interface SilenceZoomErrorConfig {
@@ -140,6 +147,9 @@ export interface SilenceZoomErrorConfig {
  * Returns a pre-configured MakeUrlSearchParamsOptions that omits the silenceError key.
  *
  * If other options are input, it merges those two options together and adds silenceError to the omitted keys.
+ *
+ * @param options Optional additional MakeUrlSearchParamsOptions to merge
+ * @returns A MakeUrlSearchParamsOptions that omits silenceError
  */
 export declare function omitSilenceZoomErrorKeys(options?: MakeUrlSearchParamsOptions): MakeUrlSearchParamsOptions;
 export type SilenceZoomErrorWithCodesFunction<T> = (silence?: boolean) => (reason: unknown) => T;
@@ -148,5 +158,11 @@ export type SilenceZoomErrorWithCodesFunction<T> = (silence?: boolean) => (reaso
  *
  * For example, when deleting a meeting that does not exist, the error code is 3001. This function can be used to silence that error.
  */
+/**
+ * Creates a function that silences Zoom errors with specific error codes.
+ *
+ * @param codes The error code(s) to silence
+ * @returns A function that creates catch handlers for silencing specified errors
+ */
 export declare function silenceZoomErrorWithCodesFunction<T>(codes: ArrayOrValue<ZoomServerErrorCode>): SilenceZoomErrorWithCodesFunction<void>;
 export declare function silenceZoomErrorWithCodesFunction<T>(codes: ArrayOrValue<ZoomServerErrorCode>, returnFn: (error: ZoomServerFetchResponseError) => T): SilenceZoomErrorWithCodesFunction<T>;

package/src/lib/zoom.limit.d.ts

@@ -8,9 +8,13 @@ export interface ZoomRateLimiterRef {
  * Function to execute when too many requests is reached.
  *
  * Typically used for logging of some sort. Thrown errors are ignored.
+ *
+ * @param headers The parsed rate limit header details from the response
+ * @param response The raw HTTP response
+ * @param fetchResponseError Optional fetch response error, if available
  */
 export type ZoomRateLimitedTooManyRequestsLogFunction = (headers: ZoomRateLimitHeaderDetails, response: Response, fetchResponseError?: FetchResponseError) => PromiseOrValue<void>;
-export declare const DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION: (headers: ZoomRateLimitHeaderDetails) => void;
+export declare const DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION: (headers: ZoomRateLimitHeaderDetails) => void;
 export interface ZoomRateLimitedFetchHandlerConfig {
     /**
      * Custom max rate limit.
@@ -32,4 +36,14 @@ export interface ZoomRateLimitedFetchHandlerConfig {
     readonly onTooManyRequests?: ZoomRateLimitedTooManyRequestsLogFunction | false;
 }
 export type ZoomRateLimitedFetchHandler = RateLimitedFetchHandler<ResetPeriodPromiseRateLimiter>;
+/**
+ * Creates a rate-limited fetch handler configured for the Zoom API.
+ *
+ * @param config Optional configuration for rate limiting behavior
+ * @returns A configured rate-limited fetch handler
+ */
 export declare function zoomRateLimitedFetchHandler(config?: Maybe<ZoomRateLimitedFetchHandlerConfig>): ZoomRateLimitedFetchHandler;
+/**
+ * @deprecated use DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION instead.
+ */
+export declare const DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION: (headers: ZoomRateLimitHeaderDetails) => void;