Interface TagFluentBuilder<TConfig, TEnforceIn, TEnforceOut, TAllowedTargets>

id

build

• build(): ITag<TConfig, TEnforceIn, TEnforceOut, TAllowedTargets>

  Materializes the final tag definition for registration or reuse.

  Returns ITag<TConfig, TEnforceIn, TEnforceOut, TAllowedTargets>

config

• config<TNewConfig>(
      config: TNewConfig,
  ): TagFluentBuilder<TNewConfig, TEnforceIn, TEnforceOut, TAllowedTargets>

  Stores default configuration on the tag definition.

  Type Parameters

  • TNewConfig

  Parameters

  • config: TNewConfig

  Returns TagFluentBuilder<TNewConfig, TEnforceIn, TEnforceOut, TAllowedTargets>

configSchema

• configSchema<
      TNewConfig = never,
      TSchema extends
          ValidationSchemaInput<[TNewConfig] extends [never] ? any : TNewConfig> = ValidationSchemaInput<
          [TNewConfig] extends [never] ? any : TNewConfig,
      >,
  >(
      schema: TSchema,
  ): TagFluentBuilder<
      ResolveValidationSchemaInput<TNewConfig, TSchema>,
      TEnforceIn,
      TEnforceOut,
      TAllowedTargets,
  >

  Declares the tag configuration schema.

  Type Parameters

  • TNewConfig = never
  • TSchema extends ValidationSchemaInput<[TNewConfig] extends [never] ? any : TNewConfig> = ValidationSchemaInput<[TNewConfig] extends [never] ? any : TNewConfig>

  Parameters

  • schema: TSchema

  Returns TagFluentBuilder<
      ResolveValidationSchemaInput<TNewConfig, TSchema>,
      TEnforceIn,
      TEnforceOut,
      TAllowedTargets,
  >

for

• for<TNewTarget extends TagTarget>(
      target: TNewTarget,
  ): TagFluentBuilder<TConfig, TEnforceIn, TEnforceOut, TNewTarget>

  Restricts the tag to a single definition kind.

  Type Parameters

  • TNewTarget extends TagTarget

  Parameters

  • target: TNewTarget

  Returns TagFluentBuilder<TConfig, TEnforceIn, TEnforceOut, TNewTarget>

• for<const TNewTargets extends readonly [TagTarget, TagTarget]>(
      targets: TNewTargets,
  ): TagFluentBuilder<TConfig, TEnforceIn, TEnforceOut, TNewTargets[number]>

  Restricts the tag to multiple definition kinds.

  Type Parameters

  • const TNewTargets extends readonly [TagTarget, TagTarget]

  Parameters

  • targets: TNewTargets

  Returns TagFluentBuilder<TConfig, TEnforceIn, TEnforceOut, TNewTargets[number]>

meta

• meta<TNewMeta extends ITagMeta>(
      m: TNewMeta,
  ): TagFluentBuilder<TConfig, TEnforceIn, TEnforceOut, TAllowedTargets>

  Attaches metadata used by docs and tooling.

  Type Parameters

  • TNewMeta extends ITagMeta

  Parameters

  • m: TNewMeta

  Returns TagFluentBuilder<TConfig, TEnforceIn, TEnforceOut, TAllowedTargets>

schema

• schema<
      TNewConfig = never,
      TSchema extends
          ValidationSchemaInput<[TNewConfig] extends [never] ? any : TNewConfig> = ValidationSchemaInput<
          [TNewConfig] extends [never] ? any : TNewConfig,
      >,
  >(
      schema: TSchema,
  ): TagFluentBuilder<
      ResolveValidationSchemaInput<TNewConfig, TSchema>,
      TEnforceIn,
      TEnforceOut,
      TAllowedTargets,
  >

  Alias for configSchema. Use this to define the tag configuration validation contract.

  Type Parameters

  • TNewConfig = never
  • TSchema extends ValidationSchemaInput<[TNewConfig] extends [never] ? any : TNewConfig> = ValidationSchemaInput<[TNewConfig] extends [never] ? any : TNewConfig>

  Parameters

  • schema: TSchema

  Returns TagFluentBuilder<
      ResolveValidationSchemaInput<TNewConfig, TSchema>,
      TEnforceIn,
      TEnforceOut,
      TAllowedTargets,
  >