Static methods
Public
Wrapper.define()
Wrapper.define()
Defines a new Wrapper
instance consisting of the allowed opening and closing.
Good to know: The opening and closing parameters are filtered by the allowed chars.
Opening extends string
Closing extends string
Parameters
opening: Opening
The allowed opening of the wrap of a generic type variable Opening
.
closing: Closing
The allowed closing of the wrap of a generic type variable Closing
.
Returns
The return value is a new Wrapper
instance of given opening and closing.
Example usage
Wrapper.getAllowedChars()
Wrapper.getAllowedChars()
Gets the allowed characters of the AllowedChars
type from the static Wrapper
.
Good to know: The method refers to a private static property allowedChars
which is the default value for filtering the wrap in the static define()
, setWrap()
, wrapText()
methods.
Returns
The return value is a an AllowedChars
pattern of allowed characters.
Example usage
Wrapper.getWrap()
Wrapper.getWrap()
Gets an instance of Wrap
stored in the static Wrapper
.
Good to know: The method refers to a private static property wrap that is used by the static wrapText()
method for wrapping the text.
Opening extends string
Closing extends string
Returns
The return value is an instance of Wrap
.
Example usage
Wrapper.isWrapper()
Wrapper.isWrapper()
The method checks if the value of any type is an instance of the Wrapper
.
Opening extends string
Closing extends string
Parameters
value: any
opening?: Opening
closing?: Closing
Returns
value is Wrapper
The return value is a boolean
type indicating whether the value is an instance of Wrapper
.
Example usage
Wrapper.setAllowedChars()
Wrapper.setAllowedChars()
The method sets the default pattern of allowed characters for static Wrapper
.
Good to know: The allowed characters refers to a private static allowedChars
property, which is the default value for filtering the wrap in the static define()
, setWrap()
, wrapText()
methods.
Parameters
allowedChars: RegExp
Returns
The return value is a static Wrapper
.
Example usage
Wrapper.setWrap()
Wrapper.setWrap()
Sets a new instance of Wrap
into the static Wrapper
. The wrap set by this method is used to wrap the text by the static wrapText()
method for wrapping the text.
Good to know: The opening
and closing
parameters are filtered by the allowed characters of static Wrapper
set by the static method setAllowedChars()
.
Opening extends string
Closing extends string
Parameters
opening: Opening
The wrap opening of a generic type variable Opening
.
closing: Closing
The wrap closing of a generic type variable Closing
.
Returns
The return value is a static Wrapper
.
Example usage
Wrapper.wrapText()
Wrapper.wrapText()
The static method wraps the specified text with a stored Wrap
instance in the static Wrapper
or with a given opening or closing.
Good to know: The opening
and closing
parameters are filtered by the allowed chars of static Wrapper
set by the static method setAllowedChars()
.
Text extends string
Opening extends string
Closing extends string
Parameters
text: Text
opening: Opening
closing: Closing
Returns
The return value is a new Wrapped
instance of given text.
Example usage
Last updated
Was this helpful?