Interface ITagDefinition<TConfig, _TEnforceInputContract, _TEnforceOutputContract, _TAllowedTargets>

Declarative tag definition contract.

interface ITagDefinition<
    TConfig = void,
    _TEnforceInputContract = void,
    _TEnforceOutputContract = void,
    _TAllowedTargets extends TagTarget | void = void,
> {
    config?: TConfig;
    configSchema?: ValidationSchemaInput<TConfig>;
    id: string;
    meta?: ITagMeta;
    targets?: readonly TagTarget[];
}

Type Parameters

TConfig = void
_TEnforceInputContract = void
_TEnforceOutputContract = void
_TAllowedTargets extends TagTarget | void = void

Hierarchy (View Summary)

ITagDefinition
- ITag

Index

Properties

config? configSchema? id meta? targets?

Properties

`Optional`config

config?: TConfig

Utilizing config at definition level stores its defaults

`Optional`configSchema

configSchema?: ValidationSchemaInput<TConfig>

Optional validation schema for configured tag payloads.

id

id: string

Stable tag identifier.

`Optional`meta

meta?: ITagMeta

Optional metadata used by docs and tooling.

`Optional`targets

targets?: readonly TagTarget[]

Restricts where this tag can be attached. Omit to allow any taggable definition kind.