Instance accessors

The properties of `Wrap` the string object.

Public

Wrap.prototype.closing

The get accessor gets the closing of the wrap by returning the #closing property of the specified object.

wrap.class.ts

public get closing(): Closing {
  return this.#closing;
}

Returns

The return value is closing of the wrap of a generic type variable Closing.

Example usage

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

// Returns ] of type "]".
new Wrap(`[`, `]`, 'quote').closing;

Wrap.prototype.opening

The get accessor gets the opening of the wrap by returning the #opening property of the specified object.

wrap.class.ts

public get opening(): Opening {
  return this.#opening;
}

Returns

The return value is the opening of the wrap of a generic type variable Opening.

Example usage

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

// Returns [ of type "[".
new Wrap(`[`, `]`, 'quote').opening;

Wrap.prototype.text

The get accessor gets the text of the Wrap by returning the #text property of a specified object.

wrap.class.ts

public get text(): Text {
  return this.#text;
}

Returns

The return value is the text of a generic type variable Text.

Example usage

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

// Returns quote of type "quote".
new Wrap(`[`, `]`, 'quote').text;

[Symbol.toStringTag]

The get accessor, with the help of toStringTag of Symbol, changes the default object tag to wrap for an instance of the Wrap.

Good to know: The property can be read by the typeOf() function of the type package.

wrap.class.ts

public get [Symbol.toStringTag](): string {
  return 'wrap';
}

Example usage

// Example usage.
import { Wrap } from '@angular-package/text';
import { typeOf } from '@angular-package/type';

// Define the wrap.
const tagWrap = new Wrap('[', ']');

// Returns wrap.
typeOf(tagWrap);