Overview

Wrap {}

The Wrap object is based on the String object and represents the immutable primitive value of the text wrapped by the opening and closing chars. It is designed to preserve the type names of the supplied opening, text, and closing chars by using the generic type variables.

String - JavaScript | MDNMDN Web Docs

Documentation - Template Literal Typestypescriptlang

Instance

Accessors

closing The get accessor gets the closing of the wrap by returning the #closing property of the specified object.
opening The get accessor gets the opening of the wrap by returning the #opening property of the specified object.
text The get accessor gets the text of the Wrap by returning the #text property of a specified object.
[Symbol.toStringTag] The get accessor toStringTag of the Symbol changes the default tag String of the instance to the custom tag Wrap.

Properties

#closing Private property of the closing chars of a generic type variable Closing.
#opening Private property of the opening chars of a generic type variable Opening.
#text Private property of text of a generic type variable Text.

Methods

getClosing() Gets the closing chars of the wrap by returning the #closing property of a specified object.
getOpening() Gets the opening chars of the wrap by returning the #opening property of a specified object.
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.
hasClosing() Checks whether the primitive value of a specified object has the closing chars or given closing chars.
hasOpening() Checks whether the primitive value of a specified object has the opening chars or given opening chars.
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.
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.
★ replaceClosing() Returns the primitive value with replaced closing chars.
★ replaceOpening() Returns the primitive value with replaced opening chars.
★ replaceText() Returns the primitive value with replaced text.
toString() Gets the wrap, the primitive value of a specified Wrap object.
valueOf() Returns the wrap, primitive value of a specified Wrap object.

Static

Methods

hasClosing() Checks whether the text has given closing chars at the end.
hasOpening() Checks whether the text has given opening chars at the beginning.
isWrap() The method checks whether the value of any type is the Wrap instance of any or given opening and closing chars.