v: Instance methods

Public

Wrapper.prototype.isClosingIn()

Checks if the provided text has the closing chars of specified Wrapper object at the end of the given text.

wrapper.class.ts

public isClosingIn(text: string): boolean {
  return Wrapper.hasClosing(text, this.closing);
}

Parameters

Name: type	Description
text: string	The text of string to test against the existence of the closing chars.

Returns

The return value is

Example usage

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

Wrapper.prototype.isOpeningIn()

Description

wrapper.class.ts

public isOpeningIn(text: string): boolean {
  return Wrapper.hasOpening(text, this.opening);
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.replaceClosingIn()

Description

wrapper.class.ts

public replaceClosingIn(text: string, replaceValue: string): string {
  return Wrapper.replaceClosing(text, this.closing, replaceValue);
}public replaceOpeningIn(text: string, replaceValue: string): string {
  return Wrapper.replaceOpening(text, this.opening, replaceValue);
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.replaceOpeningIn()

Description

wrapper.class.ts

public replaceOpeningIn(text: string, replaceValue: string): string {
  return Wrapper.replaceOpening(text, this.opening, replaceValue);
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.removeWrapIn()

Description

wrapper.class.ts

public removeWrapIn(text: string): string {
  return (
    (text = this.replaceClosingIn(text, '')),
    (text = this.replaceOpeningIn(text, '')),
    text
  );
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.textReplaceClosing()

Description

wrapper.class.ts

public textReplaceClosing(closing: string): string {
  return Wrapper.replaceClosing(this.text, this.closing, closing);
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.textReplaceOpening()

Description

wrapper.class.ts

public textReplaceOpening(opening: string): string {
  return Wrapper.replaceOpening(this.text, this.opening, opening);
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.textUnwrap()

Description

wrapper.class.ts

public textUnwrap<
  CustomOpening extends string = Opening,
  CustomClosing extends string = Closing
>(
  opening: CustomOpening = this.opening as any,
  closing: CustomClosing = this.closing as any
): string {
  return Wrapper.unwrap(this.text, opening, closing);
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.textWrap()

Description

wrapper.class.ts

public textWrap<TextOpening extends string, TextClosing extends string>(
  opening: TextOpening,
  closing: TextClosing
): Wrapped<TextOpening, Text, TextClosing> {
  return new Wrap(opening, closing, this.text).valueOf();
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.toArray()

Description

wrapper.class.ts

public toArray(): readonly [Opening, Text, Closing] {
  return [this.opening, this.text, this.closing];
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.toWrap()

Description

wrapper.class.ts

public toWrap(): Wrap<Opening, Text, Closing> {
  return new Wrap(this.opening, this.closing, this.text);
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.unwrap()

Description

wrapper.class.ts

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

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.unwrapText()

Description

wrapper.class.ts

public unwrapText<
  CustomOpening extends string = Opening,
  CustomClosing extends string = Closing
>(
  opening: CustomOpening = this.opening as any,
  closing: CustomClosing = this.closing as any
): string {
  return `${this.opening}${Wrapper.unwrap(this.text, opening, closing)}${
    this.closing
  }`;
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.wrap()

Description

wrapper.class.ts

public wrap<
  CustomOpening extends string = Opening,
  CustomClosing extends string = Closing
>(
  opening: CustomOpening = this.opening as any,
  closing: CustomClosing = this.closing as any
): Wrapped<CustomOpening, Wrapped<Opening, Text, Closing>, CustomClosing> {
  return new Wrap(opening, closing, this.valueOf()).valueOf();
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.wrapOn()

Description

wrapper.class.ts

public wrapOn<Txt extends string = ''>(
  text: Txt
): Wrapped<Opening, Txt, Closing> {
  return new Wrap(this.opening, this.closing, text).valueOf();
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.wrapText()

Description

wrapper.class.ts

public wrapText<
  TextOpening extends string = '',
  TextClosing extends string = ''
>(
  opening: TextOpening,
  closing: TextClosing
): Wrapped<Opening, Wrapped<TextOpening, Text, TextClosing>, Closing> {
  return `${this.opening}${this.textWrap(opening, closing)}${this.closing}`;
}

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

------------------------

Wrapper.prototype.isTextWrapped()

Description

wrapper.class.ts

Parameters

Name: type	Description

Returns

The return value is

Example usage

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

Wrapper.prototype.textHasClosing()

Checks if the provided text has the closing of specified Wrapper object at the end of the text.

wrapper.class.ts

public textHasClosing(text: string): boolean {
  return (
    isStringType(text) && text.slice(-this.closing.length) === this.closing
  );
}

Parameters

Name: type	Description
text: string	The text of a string to test against the existence of the closing chars.

Returns

The return value is a boolean indicating whether the given text has the closing of the wrap.

Example usage

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

// Returns true of boolean.
new Wrapper(`[`, `]`).textHasClosing(`[quote]`);

// Returns false of boolean.
new Wrapper(`{{`, `}}`).textHasClosing(`{{variable`);

Wrapper.prototype.textHasOpening()

Checks if the provided text has the opening of the specified Wrapper object at the beginning of the text.

wrapper.class.ts

public textHasOpening(text: string): boolean {
  return (
    isStringType(text) && text.slice(0, this.opening.length) === this.opening
  );
}

Parameters

Name: type	Description
text: string	The text of a string to test against the existence of the opening chars.

Returns

The return value is a boolean indicating whether the given text has the opening of the wrap.

Example usage

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

// Returns true of boolean.
new Wrapper(`[`, `]`).textHasOpening(`[quote]`);

Wrapper.prototype.unwrapText()

Returns the text without the opening and closing of the Wrapper.

wrapper.class.ts

public unwrapText(text: string): string {
  this.textHasClosing(text) &&
    (text = text.valueOf().slice(0, text.length - this.closing.length));
  this.textHasOpening(text) &&
    (text = text.valueOf().slice(this.opening.length));
  return text;
}

Parameters

Name: type	Description
text: string	The text of a string type to unwrap.

Returns

The return value is the unwrapped text of a string if the opening or closing is found or the given text.

Example usage

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

// Define a new `Wrapper`.
const wrapper = new Wrapper('[', ']');

 // Returns [[There is a wrapped text]]
const unwrapped = wrapper.unwrapText('[[[There is a wrapped text]]]');

// Returns [There is a wrapped text]
wrapper.unwrapText(unwrapped);

Wrapper.prototype.wrapText()

Wraps specific text with the wrap, the opening, and closing of the Wrapper object.

wrapper.class.ts

public wrapText<Text extends string = ``>(
  text: Text
): `${Opening}${Text}${Closing}` {
  return new Wrap(this.opening, this.closing, text).valueOf();
}

Parameters

Name: type	Description
text: Text	The text of a generic type variable Text, to be wrapped.

Returns

Return type
`${Opening}${Text}${Closing}` The return type is the template literal consists of generic type variables in order Opening, Content, and Closing.

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

Example usage

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

// Returns Wrapped {'[Lorem]'} of Wrapped<"Lorem", "[", "]">
new Wrapper('[', ']').wrapText('Lorem');

// Returns Wrapped {'{Lorem}'} of Wrapped<"Lorem", "{", "}">
new Wrapper('{', '}').wrapText('Lorem');