@dereekb/zoom 13.11.14 → 13.11.15

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

@@ -4,16 +4,16 @@ export declare const logZoomErrorToConsole: import("..").LogZoomServerErrorFunct
 /**
  * Parses a FetchResponseError into a typed Zoom API error.
  *
- * @param responseError The fetch response error to parse
- * @returns The parsed error, or undefined if parsing fails
+ * @param responseError - The fetch response error to parse.
+ * @returns The parsed error, or undefined if parsing fails.
  */
 export declare function parseZoomApiError(responseError: FetchResponseError): Promise<ParsedZoomServerError>;
 /**
  * Parses a ZoomServerErrorData into a Zoom API-specific error.
  *
- * @param zoomServerError The raw error data from the Zoom API
- * @param responseError The original fetch response error
- * @returns A parsed error, or undefined if the error is unrecognized
+ * @param zoomServerError - The raw error data from the Zoom API.
+ * @param responseError - The original fetch response error.
+ * @returns A parsed error, or undefined if the error is unrecognized.
  */
 export declare function parseZoomApiServerErrorResponseData(zoomServerError: ZoomServerErrorData, responseError: FetchResponseError): import("@dereekb/util/fetch").FetchRequestFactoryError | import("..").ZoomServerError<ZoomServerErrorData<unknown>> | undefined;
 export declare const handleZoomErrorFetch: import("..").HandleZoomErrorFetchFactory;

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

@@ -23,8 +23,9 @@ export type ZoomFactory = (config: ZoomConfig) => Zoom;
 /**
  * Creates a Zoom API factory from the given configuration.
  *
- * @param factoryConfig Configuration including OAuth context, rate limiting, and fetch settings
- * @returns A factory function that creates a configured Zoom API instance
+ * @param factoryConfig - Configuration including OAuth context, rate limiting, and fetch settings.
+ * @returns A factory function that creates a configured Zoom API instance.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zoomFactory(factoryConfig: ZoomFactoryConfig): ZoomFactory;

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

@@ -66,9 +66,10 @@ export type ZoomFetchPageFetchFunction<I extends ZoomPageFilter, R extends ZoomP
 /**
  * Creates a FetchPageFactory using the input ZoomFetchPageFetchFunction.
  *
- * @param fetch - function that fetches a single page of results from the Zoom API
- * @param defaults - optional default pagination configuration
- * @returns a configured FetchPageFactory that handles Zoom's cursor-based pagination using `next_page_token`
+ * @param fetch - Function that fetches a single page of results from the Zoom API.
+ * @param defaults - Optional default pagination configuration.
+ * @returns A configured FetchPageFactory that handles Zoom's cursor-based pagination using `next_page_token`
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zoomFetchPageFactory<I extends ZoomPageFilter, R extends ZoomPageResult<any>>(fetch: ZoomFetchPageFetchFunction<I, R>, defaults?: Maybe<FetchPageFactoryConfigDefaults>): import("@dereekb/util/fetch").FetchPageFactory<I, R>;

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

@@ -52,8 +52,9 @@ export type LogZoomServerErrorFunction = (error: FetchRequestFactoryError | Zoom
 /**
  * Creates a logZoomServerErrorFunction that logs the error to console.
  *
- * @param zoomApiNamePrefix Prefix to use when logging. I.E. ZoomError, etc.
+ * @param zoomApiNamePrefix - Prefix to use when logging. I.E. ZoomError, etc.
  * @returns
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function logZoomServerErrorFunction(zoomApiNamePrefix: string): LogZoomServerErrorFunction;
@@ -69,9 +70,10 @@ export type ParseZoomFetchResponseErrorFunction = (responseError: FetchResponseE
 /**
  * Wraps a ConfiguredFetch to support handling errors returned by fetch.
  *
- * @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
+ * @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.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function handleZoomErrorFetchFactory(parseZoomError: ParseZoomFetchResponseErrorFunction, defaultLogError: LogZoomServerErrorFunction): HandleZoomErrorFetchFactory;
@@ -124,8 +126,8 @@ export interface ZoomRateLimitHeaderDetails {
 /**
  * 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
+ * @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 {
@@ -134,9 +136,9 @@ export declare class ZoomTooManyRequestsError extends ZoomServerFetchResponseErr
 /**
  * Function that parses/transforms a ZoomServerErrorData into a general ZoomServerError or other known error type.
  *
- * @param zoomServerError The error data from the Zoom API
- * @param responseError The original fetch response error
- * @returns A typed ZoomServerFetchResponseError, or undefined
+ * @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 {
@@ -150,8 +152,8 @@ export interface SilenceZoomErrorConfig {
  *
  * 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
+ * @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;

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

@@ -39,8 +39,8 @@ export type ZoomRateLimitedFetchHandler = RateLimitedFetchHandler<ResetPeriodPro
 /**
  * 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
+ * @param config - Optional configuration for rate limiting behavior.
+ * @returns A configured rate-limited fetch handler.
  */
 export declare function zoomRateLimitedFetchHandler(config?: Maybe<ZoomRateLimitedFetchHandlerConfig>): ZoomRateLimitedFetchHandler;
 /**