Skip to content

Commit

Permalink
docs(sources): Improve docs for sources functions
Browse files Browse the repository at this point in the history
  • Loading branch information
donmccurdy committed Jun 26, 2024
1 parent ac105e3 commit 3221da8
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/sources/wrappers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,23 +50,23 @@ export type VectorTableSourceOptions =
export type VectorQuerySourceOptions =
WrappedSourceOptions<_VectorQuerySourceOptions>;

/** Wrapper adding widget support to {@link _vectorTableSource}. */
/** Wrapper adding Widget API support to [vectorTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
export async function vectorTableSource(
props: VectorTableSourceOptions
): Promise<VectorTableSourceResponse> {
const response = await _vectorTableSource(props as _VectorTableSourceOptions);
return {...response, widgetSource: new WidgetTableSource(props)};
}

/** Wrapper adding widget support to {@link _vectorQuerySource}. */
/** Wrapper adding Widget API support to [vectorQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
export async function vectorQuerySource(
props: VectorQuerySourceOptions
): Promise<VectorQuerySourceResponse> {
const response = await _vectorQuerySource(props as _VectorQuerySourceOptions);
return {...response, widgetSource: new WidgetQuerySource(props)};
}

/** Wrapper adding widget support to {@link _vectorTilesetSource}. */
/** Wrapper adding Widget API support to [vectorTilesetSource](https://deck.gl/docs/api-reference/carto/data-sources). */
export async function vectorTilesetSource() {
throw new Error('not implemented');
}
Expand All @@ -78,23 +78,23 @@ export async function vectorTilesetSource() {
export type H3TableSourceOptions = WrappedSourceOptions<_H3TableSourceOptions>;
export type H3QuerySourceOptions = WrappedSourceOptions<_H3QuerySourceOptions>;

/** Wrapper adding widget support to {@link _h3TableSource}. */
/** Wrapper adding Widget API support to [h3TableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
export async function h3TableSource(
props: H3TableSourceOptions
): Promise<H3TableSourceResponse> {
const response = await _h3TableSource(props);
return {...response, widgetSource: new WidgetTableSource(props)};
}

/** Wrapper adding widget support to {@link _h3QuerySource}. */
/** Wrapper adding Widget API support to [h3QuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
export async function h3QuerySource(
props: H3QuerySourceOptions
): Promise<H3QuerySourceResponse> {
const response = await _h3QuerySource(props);
return {...response, widgetSource: new WidgetQuerySource(props)};
}

/** Wrapper adding widget support to {@link _h3TilesetSource}. */
/** Wrapper adding Widget API support to [h3TilesetSource](https://deck.gl/docs/api-reference/carto/data-sources). */
export async function h3TilesetSource() {
throw new Error('not implemented');
}
Expand All @@ -109,23 +109,23 @@ export type QuadbinTableSourceOptions =
export type QuadbinQuerySourceOptions =
WrappedSourceOptions<_QuadbinQuerySourceOptions>;

/** Wrapper adding widget support to {@link _quadbinTableSource}. */
/** Wrapper adding Widget API support to [quadbinTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
export async function quadbinTableSource(
props: QuadbinTableSourceOptions & WidgetBaseSourceProps
): Promise<QuadbinTableSourceResponse> {
const response = await _quadbinTableSource(props);
return {...response, widgetSource: new WidgetTableSource(props)};
}

/** Wrapper adding widget support to {@link _quadbinQuerySource}. */
/** Wrapper adding Widget API support to [quadbinQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
export async function quadbinQuerySource(
props: QuadbinQuerySourceOptions & WidgetBaseSourceProps
): Promise<QuadbinQuerySourceResponse> {
const response = await _quadbinQuerySource(props);
return {...response, widgetSource: new WidgetQuerySource(props)};
}

/** Wrapper adding widget support to {@link _quadbinTilesetSource}. */
/** Wrapper adding Widget API support to [quadbinTilesetSource](https://deck.gl/docs/api-reference/carto/data-sources). */
export async function quadbinTilesetSource() {
throw new Error('not implemented');
}

0 comments on commit 3221da8

Please sign in to comment.