Interface ITagConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract>

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

Type Parameters

TConfig = void
TEnforceInputContract = void
TEnforceOutputContract = void

Hierarchy (view full)

ITag<TConfig, TEnforceInputContract, TEnforceOutputContract>
- ITagConfigured

Index

Properties

__configHasOnlyOptionalKeys __containsContract [CONTRACT] [symbolFilePath] [symbolTag] [symbolTagConfigured] 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

[symbolTagConfigured]

[symbolTagConfigured]: true

config

config: TConfig

Utilizing config at definition level stores its defaults

`Optional`configSchema

configSchema?: IValidationSchema<TConfig>

id

id: string

`Optional`meta

meta?: ITagMeta

Methods

exists

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

extract

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

with

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