Instance methods

Public

Wrap.prototype.getClosing()

Gets the closing chars of the wrap by returning the #closing property of a specified object.

wrap.class.ts

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

Returns

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

Example usage

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

// Returns ] of type "]".
new Wrap(`[`, `]`).getClosing();

Wrap.prototype.getOpening()

Gets the opening chars of the wrap by returning the #opening property of a specified object.

wrap.class.ts

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

Returns

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

Example usage

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

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

Wrap.prototype.getText()

Gets the text of the wrap by returning the #text property of a specified object, without the opening and closing chars of the Wrap.

wrap.class.ts

public getText(): 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').getText();

Wrap.prototype.hasClosing()

Checks whether the primitive value of a specified object has the closing chars or given closing chars. An empty string indicates undefined.

wrap.class.ts

public hasClosing(closing?: string): boolean {
  return (
    isStringLength(this.#closing, { min: 1 }) &&
    (isStringType(closing) ? this.#closing === closing : true)
  );
}

Parameters

Name: type	Description
closing?: string	Optional closing chars of a string type to check whether the primitive value contains them at the end.

Returns

The return value is a boolean indicating whether the primitive value has the closing chars.

Functions used

isStringLength(), isStringType()

Example usage

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

// Returns true.
new Wrap(`[`, `]`, 'quote').hasClosing();

// Returns true.
new Wrap(`[`, `]`, 'quote').hasClosing(']');

// Returns false.
new Wrap(`[`, `]`, 'quote').hasClosing('');

// Returns false.
new Wrap(`[`, ``, 'quote').hasClosing();

// Returns false.
new Wrap(`[`, ``, 'quote').hasClosing('');

// Returns false.
new Wrap(`[`, ``, 'quote').hasClosing(']');

Wrap.prototype.hasOpening()

Checks whether the primitive value of a specified object has the opening chars or given opening chars. An empty string indicates undefined.

wrap.class.ts

public hasOpening(opening?: string): boolean {
  return (
    isStringLength(this.#opening, { min: 1 }) &&
    (isStringType(opening) ? this.#opening === opening : true)
  );
}

Parameters

Name: type	Description
opening?: string	Optional opening chars of a string type to check if the primitive value contains them at the beginning.

Returns

The return value is a boolean indicating whether the primitive value has the opening chars.

Functions used

isStringLength(), isStringType()

Example usage

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

// Returns true.
new Wrap(`[`, `]`, 'quote').hasOpening();

// Returns true.
new Wrap(`[`, `]`, 'quote').hasOpening('[');

// Returns false.
new Wrap(`[`, `]`, 'quote').hasOpening('');

// Returns false.
new Wrap(``, `]`, 'quote').hasOpening();

// Returns false.
new Wrap(``, `]`, 'quote').hasOpening('');

// Returns false.
new Wrap(``, `]`, 'quote').hasOpening('[');

Wrap.prototype.hasText()

The method checks whether the text of a specified Wrap object is defined, which means it's a string of at least one char and optionally equal to the given text.

wrap.class.ts

public hasText(text?: string): boolean {
  return (
    isStringLength(this.#text, { min: 1 }) &&
    (isStringType(text) ? this.#text === text : true)
  );
}

Parameters

Name: type	Description
text?: string	Optional text of string type to check whether it's equal to the text of the Wrap object.

Returns

The return value is a boolean indicating whether the text is defined and equal to the optionally given text.

Functions used

isStringLength(), isStringType()

Example usage

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

// Returns true.
new Wrap(`[`, `]`, 'quote').hasText();

// Returns true.
new Wrap(`[`, `]`, 'quote').hasText('quote');

// Returns false.
new Wrap(`[`, `]`).hasText();

// Returns false.
new Wrap(`[`, `]`, '').hasText();

// Returns false.
new Wrap(`[`, `]`, '').hasText('');

Wrap.prototype.isWrapped()

The method checks whether the primitive value of the specified object is wrapped by the opening and closing chars of an instance or given opening and closing chars.

wrap.class.ts

public isWrapped(
  opening: string = this.opening,
  closing: string = this.closing
): boolean {
  return this.hasOpening(opening) && this.hasClosing(closing);
}

Parameters

Name: type	Description
opening: string	Optional closing chars of a string type to check if the text contains them at the end.
closing: string	Optional closing chars of a string type to check if the text contains them at the end.

Returns

The return value is a boolean indicating whether the object has both opening and closing chars.

Example usage

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

// Returns true.
new Wrap(`[`, `]`, 'quote').isWrapped();

// Returns true.
new Wrap(`[`, `]`, 'quote').isWrapped('[');

// Returns true.
new Wrap(`[`, `]`, 'quote').isWrapped(undefined, ']');

// Returns false.
new Wrap(`[`, `]`, 'quote').isWrapped('<');

// Returns false.
new Wrap(`[`, `]`, 'quote').isWrapped(undefined, '>');

// Returns false.
new Wrap(`[`, `]`, 'quote').isWrapped('<', '>');

// Returns false.
new Wrap(``, ``, 'quote').isWrapped();

// Returns false.
new Wrap(``, ``, 'quote').isWrapped('', '');

Wrap.prototype.replaceClosing()

Returns the primitive value with replaced closing chars.

wrap.class.ts

public replaceClosing<ReplaceClosing extends string = ''>(
  closing: ReplaceClosing
): `${Opening}${Text}${ReplaceClosing}` {
  return `${this.#opening}${this.#text}${String(closing) as ReplaceClosing}`;
}

Generic type variables
ReplaceClosing extends string A generic type variable constrained by the string, by default of the value captured from the provided closing indicates the ReplaceClosing type on template of the return type.

Parameters

Name: type	Description
closing: replaceClosing	The closing chars of a generic type variable ReplaceClosing to replace the closing chars in the primitive value.

Returns

The return value is the primitive value with replaced closing chars of a generic type variables in order Opening, Text and ReplaceClosing on the template ${Opening}${Text}${ReplaceClosing}.

Example usage

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

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

Wrap.prototype.replaceOpening()

Returns the primitive value with replaced opening chars.

wrap.class.ts

public replaceOpening<ReplaceOpening extends string = ''>(
  opening: ReplaceOpening
): `${ReplaceOpening}${Text}${Closing}` {
  return `${opening}${this.#text}${this.#closing}`;
}

Generic type variables
ReplaceOpening extends string A generic type variable constrained by the string, by default of the value captured from the provided opening indicates the ReplaceOpening type on template of the return type.

Parameters

Name: type	Description
opening: ReplaceOpening	The opening chars of a generic type variable ReplaceOpening to replace the opening chars in the primitive value.

Returns

The return value is the primitive value with replaced opening chars of a generic type variables in order ReplaceOpening, Text and Closing on the template ${ReplaceOpening}${Text}${Closing}.

Example usage

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

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

Wrap.prototype.replaceText()

Returns the primitive value with replaced text.

wrap.class.ts

public replaceText<ReplaceText extends string = ''>(
  text: ReplaceText
): `${Opening}${ReplaceText}${Closing}` {
  return `${this.#opening}${text}${this.#closing}`;
}

Generic type variables
ReplaceText extends string A generic type variable constrained by the string, by default of the value captured from the provided text indicates the ReplaceText type on template of the return type.

Parameters

Name: type	Description
text: ReplaceText	The text of a generic type variable ReplaceText to replace the text in the primitive value.

Returns

The return value is the primitive value with replaced text of a generic type variables in order Opening, ReplaceText and Closing on the template ${Opening}${ReplaceText}${Closing}.

Example usage

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

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

Wrap.prototype.toString()

Gets the wrap, the primitive value of a specified Wrap object.

wrap.class.ts

public toString(): `${Opening}${Text}${Closing}` {
  return super.toString() as `${Opening}${Text}${Closing}`;
}

Returns

The return value is the wrap of generic type variables in order Opening, Text, and Closing on the template ${Opening}${Content}${Closing}.

Example usage

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

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

Wrap.prototype.valueOf()

Returns the wrap, primitive value of a specified Wrap object.

wrap.class.ts

public valueOf(): `${Opening}${Text}${Closing}` {
  return super.valueOf() as `${Opening}${Text}${Closing}`;
}

Returns

The return value is the wrap of generic type variables in order Opening, Text, and Closing on the template ${Opening}${Text}${Closing}.

Example usage

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

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