Skip to content

Commit

Permalink
Clean up TSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
donmccurdy committed Nov 14, 2024
1 parent 623c54e commit 8a383cf
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/widget-sources/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ export interface CategoryRequestOptions extends BaseRequestOptions {
operationColumn?: string;
}

/**
* Options for {@link WidgetBaseSource#getFeatures}.
* @experimental
* @internal
*/
export interface FeaturesRequestOptions extends BaseRequestOptions {
/**
* Feature IDs, as found in `_carto_feature_id`. Feature IDs are a hash
Expand Down Expand Up @@ -116,7 +121,11 @@ export interface TimeSeriesRequestOptions extends BaseRequestOptions {
* WIDGET API RESPONSES
*/

/** Response from {@link WidgetBaseSource#getFeatures}. */
/**
* Response from {@link WidgetBaseSource#getFeatures}.
* @experimental
* @internal
*/
export type FeaturesResponse = {rows: Record<string, unknown>[]};

/** Response from {@link WidgetBaseSource#getFormula}. */
Expand Down

0 comments on commit 8a383cf

Please sign in to comment.