Instance methods

Tag.prototype.

Public

Tag.prototype.getClosingTag()

Gets the closing tag of a specified Tag object.

public getClosingTag(): ClosingTag<Name, Chars> {
  return this.closingTag;
}

Returns

The return value is the closing tag of a generic type ClosingTag.

Tag.prototype.getName()

Gets the tag name without the opening and closing char.

public getName(): Name {
  return this.#name;
}

Returns

The return value is the tag name of a generic type variable Name.

Tag.prototype.getOpeningTag()

Gets the opening tag of the specified Tag object.

public getOpeningTag(): OpeningTag<Name, Chars> {
  return this.tag as OpeningTag<Name, Chars>;
}

Returns

The return value is the opening tag of a generic type OpeningTag.

Tag.prototype.getWrap()

Gets the wrap of a tag name.

public getWrap(): Wrap<Chars> {
  return this.#wrap;
}

Returns

The return value is an instance of Wrap.

Tag.prototype.replaceTag()

The method replaces the tag of a specified Tag object with the provided replaceValue in the given text if both values are strings.

Need to know: The return type of a generic type variable Text returns the text with not replaced tags.

public replaceTag<Text extends string>(
  text: Text,
  replaceValue?: string
): Text {
  return guardString(text)
    ? isString(replaceValue)
      ? (text.split(this.tag).join(replaceValue) as Text)
      : text
    : ('' as Text);
}

Generic Type variables

Name / Description
Text extends string ​A generic type variable constrained by the string by default of the value captured from the provided text parameter indicates the type of Text via the return type.

Parameters

Name: type	Description
text: Text	The text in which to replace a tag of a specified object with a given replaceValue.
replaceValue?: string	The value to replace a tag of a specified object in the given text.

Returns

The return value is the given text of a generic type variable Text with a replaced tag if both the text and replaceValue are strings. If replaceValue is not a string returns not replaced text, and if both the text and replaceValue are not strings returns an empty string.

Tag.prototype.tagText()

The method tags the provided text with the opening and closing tag.

public tagText<Text extends string>(text: Text): Tagged<Text, Name, Chars> {
  return new Tagged(
    `${this.openingTag}${text}${this.closingTag}` as Text,
    this
  );
}

Generic type variables

Name / Description
Text extends string ​A generic type variable constrained by the string by default of the value captured from the provided text parameter indicates the type of Tagged via the return type.

Parameters

Name: type	Description
text: Text	The text of a string type, to be tagged with the opening and closing tag.

Returns

The return value is a new Tagged instance with a tagged text.

Example usage

// Example usage.
import { tagText } from '@angular-package/text';

// Define the tag.
const quote = new Tag(`quote`);

// Tag the text with a `quote` tag.
// Returns Tagged {`[quote]"It's a possible."[/quote]`}
quote.tagText(`"It's a possible."`);

Tag.prototype.valueOf()

Returns tag name, a primitive value of the specified Tag object.

public valueOf(): Name {
  return super.valueOf() as Name;
}

Returns

The return value is a tag name of a generic type variable Name.