Class Tag

A metadata tag describing a data asset. Associated with a TitleRecord, tags improve record searchability and filtering.

Hierarchy

Tag

Index

Constructors

Properties

Methods

common custom from

Constructors

`Private` constructor

new Tag(tag): Tag
Private
Constructs a new Tag with the provided value. This constructor is private. To create a Tag instance, use the static factory methods.
Parameters
- tag: string
  
  The tag value.
Returns Tag
- Defined in tag.ts:25

Properties

`Readonly` value

value: string

The raw value of the tag.

Methods

`Static` common

common(tag): Tag
Creates a Tag from one of the CommonTags
Parameters
- tag: CommonTags
  
  The common tag to use.
Returns Tag
A Tag instance.

Static
- Defined in tag.ts:60

`Static` custom

custom(tag): Tag
Creates a custom Tag with the provided tag value.
Parameters
- tag: string
  
  The custom tag value.
Returns Tag
A Tag instance.

Static
- Defined in tag.ts:51

`Static` from

from(tag): Tag
Creates a Tag from a provided raw value. If the tag value matches a common tag, a pre-defined Tag is returned. Otherwise, a custom Tag is created.
Parameters
- tag: string
  
  The tag value.
Returns Tag
A Tag instance.

Static
- Defined in tag.ts:38

Generated using TypeDoc