[F] HttpVisibilityProvider
Call Signature
Section titled “Call Signature”function HttpVisibilityProvider(verb): VisibilityProvider;A visibility provider for HTTP operations. Pass this value as a provider to the getParameterVisibilityFilter and
getReturnTypeVisibilityFilter functions in the TypeSpec core to get the applicable parameter and return type
visibility filters for an HTTP operation.
When created with a verb, this provider will use the default visibility for that verb.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
verb | HttpVerb | the HTTP verb for the operation |
Returns
Section titled “Returns”VisibilityProvider
- VisibilityProvider
- getParameterVisibilityFilter
- getReturnTypeVisibilityFilter
Call Signature
Section titled “Call Signature”function HttpVisibilityProvider(options): VisibilityProvider;A visibility provider for HTTP operations. Pass this value as a provider to the getParameterVisibilityFilter and
getReturnTypeVisibilityFilter functions in the TypeSpec core to get the applicable parameter and return type
visibility filters for an HTTP operation.
When created with an options object, this provider will use the verbSelector function to determine the verb for the
operation and use the default visibility for that verb, or the configured HTTP verb for the operation, and finally
the GET verb if the verbSelector function is not defined and no HTTP verb is configured.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options | OperationParameterOptions | an options object with a verbSelector function that returns the HTTP verb for the operation |
Returns
Section titled “Returns”VisibilityProvider
- VisibilityProvider
- getParameterVisibilityFilter
- getReturnTypeVisibilityFilter
Call Signature
Section titled “Call Signature”function HttpVisibilityProvider(): VisibilityProvider;A visibility provider for HTTP operations. Pass this value as a provider to the getParameterVisibilityFilter and
getReturnTypeVisibilityFilter functions in the TypeSpec core to get the applicable parameter and return type
visibility filters for an HTTP operation.
When created without any arguments, this provider will use the configured verb for the operation or the GET verb if no HTTP verb is configured and use the default visibility for that selected verb.
Returns
Section titled “Returns”VisibilityProvider
- VisibilityProvider
- getParameterVisibilityFilter
- getReturnTypeVisibilityFilter