@dereekb/trello 13.11.14 → 13.11.15

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

@@ -55,7 +55,7 @@ export type TrelloPageItemIdReader<T> = (item: T) => TrelloId;
 /**
  * Default reader that pulls `id` off the item. Works for most Trello resource types.
  *
- * @param item The page item whose id to read.
+ * @param item - The page item whose id to read.
  * @returns The item's id.
  */
 export declare const defaultTrelloPageItemIdReader: <T extends {
@@ -64,7 +64,7 @@ export declare const defaultTrelloPageItemIdReader: <T extends {
 /**
  * Reader that pulls the action id off a Trello action item.
  *
- * @param item The action page item whose id to read.
+ * @param item - The action page item whose id to read.
  * @returns The item's action id.
  */
 export declare const trelloActionIdReader: <T extends {
@@ -73,10 +73,11 @@ export declare const trelloActionIdReader: <T extends {
 /**
  * Wraps a raw Trello collection fetch into a {@link TrelloPageResult}.
  *
- * @param input The page filter that was used.
- * @param data The raw page items.
- * @param idReader Function to read the id from the last item.
+ * @param input - The page filter that was used.
+ * @param data - The raw page items.
+ * @param idReader - Function to read the id from the last item.
  * @returns A page result with the data and a cursor for the next page.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function buildTrelloPageResult<T>(input: TrelloCursorPageFilter, data: ReadonlyArray<T>, idReader: TrelloPageItemIdReader<T>): TrelloPageResult<T>;
@@ -84,9 +85,10 @@ export type TrelloFetchPageFetchFunction<I extends TrelloCursorPageFilter, R ext
 /**
  * Creates a FetchPageFactory using the input TrelloFetchPageFetchFunction.
  *
- * @param fetch Function that fetches a single page of results from the Trello API.
- * @param defaults Optional default pagination configuration.
+ * @param fetch - Function that fetches a single page of results from the Trello API.
+ * @param defaults - Optional default pagination configuration.
  * @returns A configured FetchPageFactory that handles Trello's cursor-based pagination using `before`.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function trelloFetchPageFactory<I extends TrelloCursorPageFilter, R extends TrelloPageResult<unknown>>(fetch: TrelloFetchPageFetchFunction<I, R>, defaults?: Maybe<FetchPageFactoryConfigDefaults>): FetchPageFactory<I, R>;

package/src/lib/trello.config.d.ts

@@ -1,4 +1,4 @@
-import { type TrelloApiKey, type TrelloApiToken, type TrelloApiUrl } from './trello.type';
+import { type TrelloApiKey, type TrelloApiToken } from './trello.type';
 /**
  * Configuration for a TrelloContext.
  */
@@ -16,5 +16,5 @@ export interface TrelloConfig {
     /**
      * Optional custom API base URL. Defaults to https://api.trello.com/1.
      */
-    readonly apiUrl?: TrelloApiUrl | string;
+    readonly apiUrl?: string;
 }

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

@@ -53,8 +53,9 @@ export type LogTrelloServerErrorFunction = (error: FetchRequestFactoryError | Tr
 /**
  * Creates a logTrelloServerErrorFunction that logs the error to console.
  *
- * @param trelloApiNamePrefix Prefix to use when logging.
- * @returns A function that logs Trello server errors to the console.
+ * @param trelloApiNamePrefix - Prefix to use when logging.
+ * @returns Logs Trello server errors to the console.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function logTrelloServerErrorFunction(trelloApiNamePrefix: string): LogTrelloServerErrorFunction;
@@ -62,16 +63,17 @@ export declare const logTrelloErrorToConsole: LogTrelloServerErrorFunction;
 /**
  * Parses a FetchResponseError into a typed Trello API error.
  *
- * @param responseError The fetch response error to parse.
+ * @param responseError - The fetch response error to parse.
  * @returns A typed Trello error, or undefined if the response could not be parsed.
  */
 export declare function parseTrelloApiError(responseError: FetchResponseError): Promise<Maybe<TrelloServerFetchResponseError>>;
 /**
  * Wraps a ConfiguredFetch to translate FetchResponseError into typed Trello errors.
  *
- * @param fetch The fetch to wrap.
- * @param logError Optional logger.
+ * @param fetch - The fetch to wrap.
+ * @param logError - Optional logger.
  * @returns A ConfiguredFetch that throws typed Trello errors for known error responses.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function handleTrelloErrorFetch(fetch: ConfiguredFetch, logError?: LogTrelloServerErrorFunction): ConfiguredFetch;

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

@@ -33,8 +33,9 @@ export type TrelloRateLimitedFetchHandler = RateLimitedFetchHandler<ResetPeriodP
  *
  * Backs off after 429 responses and respects the documented per-token rate limit.
  *
- * @param config Optional configuration for rate limiting behavior.
+ * @param config - Optional configuration for rate limiting behavior.
  * @returns A configured rate-limited fetch handler.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function trelloRateLimitedFetchHandler(config?: Maybe<TrelloRateLimitedFetchHandlerConfig>): TrelloRateLimitedFetchHandler;