Skip to content

[F] defineTypeInfoProvider

function defineTypeInfoProvider(provider): TypeInfoProvider;

Define a $provideTypeInfo provider that contributes extra information about types to IDE hover documentation and tooling. This helper only provides typing; export the result as $provideTypeInfo from your library’s entry point.

Parameters

Section titled “Parameters”
ParameterType
providerTypeInfoProvider

Returns

Section titled “Returns”

TypeInfoProvider

Example

Section titled “Example”
export const $provideTypeInfo = defineTypeInfoProvider(({ target }) => {
  if (target.kind !== "Operation") return undefined;
  return { content: `Operation ${target.name}` };
});