Interface ITag<TConfig, TEnforceInputContract, TEnforceOutputContract>

interface ITag<
    TConfig = void,
    TEnforceInputContract = void,
    TEnforceOutputContract = void,
> {
    __configHasOnlyOptionalKeys: RequiredKeys<TConfig> extends never
        ? true
        : false;
    __containsContract: true;
    "[CONTRACT]": {
        config: TConfig;
        input: TEnforceInputContract;
        output: TEnforceOutputContract;
    };
    "[symbolFilePath]": string;
    "[symbolTag]": true;
    config?: TConfig;
    configSchema?: IValidationSchema<TConfig>;
    id: string;
    meta: ITagMeta;
    exists(target: TagType[] | ITaggable): boolean;
    extract(target: TagType[] | ITaggable): TConfig | undefined;
    with(
        config: TConfig,
    ): ITagConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract>;
}

Type Parameters

TConfig = void
TEnforceInputContract = void
TEnforceOutputContract = void

Hierarchy (View Summary)

ITagDefinition<TConfig, TEnforceInputContract, TEnforceOutputContract>
IContractable<TConfig, TEnforceInputContract, TEnforceOutputContract>
- ITag
  - ITagConfigured

Index

Properties

__configHasOnlyOptionalKeys __containsContract [CONTRACT] [symbolFilePath] [symbolTag] config? configSchema? id meta

Methods

exists extract with

Properties

`Readonly`__configHasOnlyOptionalKeys

__configHasOnlyOptionalKeys: RequiredKeys<TConfig> extends never ? true : false

A special validation property. It resolves to true if TConfig only has optional keys, otherwise false.

`Readonly`__containsContract

__containsContract: true

`Readonly`[CONTRACT]

"[CONTRACT]": {
    config: TConfig;
    input: TEnforceInputContract;
    output: TEnforceOutputContract;
}

[symbolFilePath]

"[symbolFilePath]": string

[symbolTag]

"[symbolTag]": true

`Optional`config

config?: TConfig

Utilizing config at definition level stores its defaults

`Optional`configSchema

configSchema?: IValidationSchema<TConfig>

id

id: string

meta

Methods

exists

exists(target: TagType[] | ITaggable): boolean
Checks if the tag exists in a taggable or a list of tags.
Parameters
- target: TagType[] | ITaggable
Returns boolean
- Defined in src/types/tag.ts:50

extract

extract(target: TagType[] | ITaggable): TConfig | undefined
Extracts the configuration of the tag from a taggable or a list of tags.
Parameters
- target: TagType[] | ITaggable
Returns TConfig | undefined
- Defined in src/types/tag.ts:60

with

with(
config: TConfig,
): ITagConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract>
Creates a configured instance of the tag.
Parameters
- config: TConfig
Returns ITagConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract>
- Defined in src/types/tag.ts:54