Instance methods

Public

Variable.prototype.getValue()

Gets the value of the variable by returning the private #value property of a specified Variable object.

variable.class.ts

public getValue(): Value | undefined {
  return this.#value;
}

Returns

The return value is the value of a generic type variable Value if set, otherwise undefined.

Example usage

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

// Returns Variable {'{fix}'} of Variable<"fix", string>.
const fix = new Variable('fix');

// Returns undefined of string | undefined.
fix.getValue();

// Returns Variable {'{fix}'} of Variable<"fix", "Open the link https://duckduckgo.com/">.
const fixed = new Variable('fix', 'Open the link https://duckduckgo.com/');

// Returns Open the link https://duckduckgo.com/ of "Open the link https://duckduckgo.com/" | undefined.
fixed.getValue();

Variable.prototype.replaceVariable()

Replaces variable in the format {variable name} with the value of a specified Variable object or with a provided replaceValue, in a given text.

If replaceValue is not provided, ​private #value property is used, and if the #value is undefined an empty string is used.

variable.class.ts

public replaceVariable<ReplaceValue extends Value>(
  text: string,
  replaceValue?: ReplaceValue
): string {
  return this.replaceTag(text, replaceValue || this.#value || '');
}

Generic type variables
ReplaceValue extends Value ​A generic type variable ReplaceValue constrained by a generic type variable Value, by default of the value captured from the provided replaceValue indicates replacement value type.

Parameters

Name: type	Description
text: string	The text of a string type in which replace the variable with the value from the private #value property or a given replaceValue.
replaceValue?: ReplaceValue	Optional value of a generic type variable ReplaceValue to replace the variable in the form {variable name} in a given text.

Returns

The return value is the text of a string type with a replaced variable by value.

Example usage

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

// Returns Variable {'{fix}'} of Variable<"fix", string>.
const fix = new Variable('fix');

// Returns 'There is a' of string.
fix.replaceVariable(`There is a ${fix}`);

// Returns 'There is a real fix for an error.' of string.
fix.replaceVariable(`There is a ${fix}`, 'real fix for an error.');

// Returns Variable {'{fix}'} of Variable<"fix", "Open the link https://duckduckgo.com/">.
const fixed = new Variable('fix', 'Open the link https://duckduckgo.com/');

// Returns 'There is a Open the link https://duckduckgo.com/' of string.
fixed.replaceVariable(`There is a ${fixed}`);

Variable.prototype.toArray()

Returns converted variable to a read-only array where the first element is the name, and the second is the value if set, otherwise undefined.

variable.class.ts

public toArray(): readonly [Name, Value | undefined] {
  return [this.name, this.#value];
}

Returns

The return value is a read-only array of the variable name and value.

Example usage

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

// Returns Variable {'{fix}'} of Variable<"fix", string>.
const fix = new Variable('fix');

// Returns ['fix', undefined] of readonly ["fix", string | undefined].
fix.toArray();

// Returns Variable {'{fix}'} of Variable<"fix", "Open the link https://duckduckgo.com/">.
const fixed = new Variable('fix', 'Open the link https://duckduckgo.com/');

// Returns ['fix', 'Open the link https://duckduckgo.com/'] of readonly ["fix", "Open the link https://duckduckgo.com/" | undefined]
fixed.toArray();

Variable.prototype.toObject()

Returns converted variable to a read-only object where the key is the variable name.

variable.class.ts

public toObject(): Readonly<{ [K in Name]: Value | undefined }> {
  return Object.freeze({ [this.name]: this.#value }) as {
    [K in Name]: Value | undefined;
  };
}

Returns

The return value is a read-only object where the property name is the variable name, and the property value is equal to the variable value.

Example usage

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

// Returns Variable {'{fix}'} of Variable<"fix", string>.
const fix = new Variable('fix');

// Returns {fix: undefined} of Readonly<{fix: string | undefined;}>.
fix.toObject();

// Returns Variable {'{fix}'} of Variable<"fix", "Open the link https://duckduckgo.com/">.
const fixed = new Variable('fix', 'Open the link https://duckduckgo.com/');

// Returns {fix: 'Open the link https://duckduckgo.com/'} of Readonly<{fix: "Open the link https://duckduckgo.com/" | undefined;}>.
fixed.toObject();

Variable.prototype.toString()

Returns the variable in form {name}, a primitive value of the specified Variable object.

variable.class.ts

public toString(): `{${Name}}` {
  return this.valueOf();
}

Returns

The return value is the variable of a generic type variable Name on the template {${Name}}.

Example usage

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

// Returns Variable {'{fix}'} of Variable<"fix", string>.
const fix = new Variable('fix');

// Returns {fix} of "{fix}".
fix.toString();

// Returns Variable {'{fix}'} of Variable<"fix", "Open the link https://duckduckgo.com/">.
const fixed = new Variable('fix', 'Open the link https://duckduckgo.com/');

// Returns {fix} of "{fix}".
fixed.toString();

Variable.prototype.valueOf()

Returns the variable in form {name}, a primitive value of the specified Variable object.

variable.class.ts

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

Returns

The return value is the variable of a generic type variable Name on the template {${Name}}.

Example usage

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

// Returns Variable {'{fix}'} of Variable<"fix", string>.
const fix = new Variable('fix');

// Returns {fix} of "{fix}".
fix.valueOf();

// Returns Variable {'{fix}'} of Variable<"fix", "Open the link https://duckduckgo.com/">.
const fixed = new Variable('fix', 'Open the link https://duckduckgo.com/');

// Returns {fix} of "{fix}".
fixed.valueOf();