HttpApiHyperlinkLayerEffectConfig<ApiId, Groups>Configuration for HttpApiHyperlink.layerEffect.
modelsHttpApiHyperlink.layerEffect
Source src/HttpApiHyperlink.ts:8411 lines
export interface interface HttpApiHyperlinkLayerEffectConfig<ApiId extends string = string, Groups extends HttpApiGroup.Constraint = HttpApiGroup.Top>Configuration for
HttpApiHyperlink.layerEffect
.
HttpApiHyperlinkLayerEffectConfig<
function (type parameter) ApiId in HttpApiHyperlinkLayerEffectConfig<ApiId extends string = string, Groups extends HttpApiGroup.Constraint = HttpApiGroup.Top>ApiId extends string = string,
function (type parameter) Groups in HttpApiHyperlinkLayerEffectConfig<ApiId extends string = string, Groups extends HttpApiGroup.Constraint = HttpApiGroup.Top>Groups extends import HttpApiGroupHttpApiGroup.Constraint = import HttpApiGroupHttpApiGroup.Top,
> {
readonly HttpApiHyperlinkLayerEffectConfig<ApiId extends string = string, Groups extends HttpApiGroup.Constraint = Top>.concurrency?: number | undefinedconcurrency?: number;
/**
* When set, endpoint usage metrics and registry hooks are applied to the built client
* (same as {@link instrumentEndpoints}).
*/
readonly HttpApiHyperlinkLayerEffectConfig<ApiId extends string = string, Groups extends HttpApiGroup.Constraint = Top>.api?: HttpApi.HttpApi<ApiId, Groups> | undefinedWhen set, endpoint usage metrics and registry hooks are applied to the built client
(same as
instrumentEndpoints
).
api?: import HttpApiTypeHttpApiType.interface HttpApi<out Id extends string, in out Groups extends HttpApiGroup.Constraint = never>An HttpApi is a collection of HTTP API groups and endpoints that represents a
portion of your domain.
When to use
Use when endpoint implementations can be provided with HttpApiBuilder.group, and the
completed API can be registered with HttpApiBuilder.layer.
HttpApi<function (type parameter) ApiId in HttpApiHyperlinkLayerEffectConfig<ApiId extends string = string, Groups extends HttpApiGroup.Constraint = HttpApiGroup.Top>ApiId, function (type parameter) Groups in HttpApiHyperlinkLayerEffectConfig<ApiId extends string = string, Groups extends HttpApiGroup.Constraint = HttpApiGroup.Top>Groups>;
}