Utils

Interfaces

IEqualsReady

Methods

equals()

equals(object): boolean;

Parameters

Parameter	Type
object	Object

Returns

boolean

Variables

delay

const delay: (delay?) => Promise<void> = timeout;

Parameters

Parameter	Type
delay?	number

Returns

Promise<void>

Functions

applyNullableValue()

function applyNullableValue<T>(actual, redefined): T;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
actual	T
redefined	T

Returns

T

---

applyUndefinedValue()

function applyUndefinedValue<T>(actual, redefined): T;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
actual	T
redefined	T

Returns

T

---

arrayEquals()

function arrayEquals(obj1, obj2): boolean;

Parameters

Parameter	Type
obj1	equalsBasicType[]
obj2	equalsBasicType[]

Returns

boolean

Deprecated

use arrayIsEquals from @aurigma/utils-js/algorithms/array

---

arrayReferenceEquals()

function arrayReferenceEquals(obj1, obj2): boolean;

Parameters

Parameter	Type
obj1	Object[]
obj2	Object[]

Returns

boolean

---

assign()

function assign<T>(target, sources, options?): T;

Type Parameters

Type Parameter
T extends Object

Parameters

Parameter	Type
target	T
sources	any[]
options?	{ deep?: boolean; ignoreNull?: boolean; }
options.deep?	boolean
options.ignoreNull?	boolean

Returns

T

---

assignProperties()

function assignProperties<T>(target, propObject): T;

Type Parameters

Type Parameter
T extends Object

Parameters

Parameter	Type
target	T
propObject	Partial<T>

Returns

T

---

capitalize()

function capitalize(word): string;

Parameters

Parameter	Type
word	string

Returns

string

---

contains()

function contains(str1, str2): boolean;

Parameters

Parameter	Type
str1	string
str2	string

Returns

boolean

---

createCssDataUri()

function createCssDataUri(css): string;

Parameters

Parameter	Type
css	string

Returns

string

---

enableMoveDropDownFocus()

function enableMoveDropDownFocus(element, getFocusElement): void;

Parameters

Parameter	Type	Description
element	HTMLElement	Element contains twitter bootstrap dropdown
getFocusElement	() => any	Function returns element to be focused after dropdown expand

Returns

void

---

equals()

function equals(obj1, obj2): boolean;

Parameters

Parameter	Type
obj1	equalsType
obj2	equalsType

Returns

boolean

---

escapeXml()

function escapeXml(str): string;

Parameters

Parameter	Type
str	string

Returns

string

---

flatten()

function flatten<T>(nestedCollec): T[];

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
nestedCollec	T[][]

Returns

T[]

Deprecated

use native JS array flatten

---

getCurrentLineInTextArea()

function getCurrentLineInTextArea(element): string;

Parameters

Parameter	Type
element	HTMLTextAreaElement

Returns

string

---

getExtension()

function getExtension(fileName): string;

Parameters

Parameter	Type
fileName	string

Returns

string

---

getFontNames()

function getFontNames(text): string[];

Parameters

Parameter	Type
text	string

Returns

string[]

---

getHiddenElemenHeight()

function getHiddenElemenHeight(el): number;

Parameters

Parameter	Type
el	HTMLElement

Returns

number

---

getImageSize()

function getImageSize(imageUrl): Promise<{
  height: number;
  width: number;
}>;

Parameters

Parameter	Type
imageUrl	string

Returns

Promise<{ height: number; width: number; }>

Deprecated

The method should not be used. User ImageUtils.getImageSizeByUrl from design-atoms module.

---

getLastPathSegment()

function getLastPathSegment(path): string;

Parameters

Parameter	Type
path	string

Returns

string

---

getNameWithoutExtension()

function getNameWithoutExtension(fileName): string;

Parameters

Parameter	Type
fileName	string

Returns

string

---

getStringEnumValue()

function getStringEnumValue(enumObject, enumValue): string;

Parameters

Parameter	Type
enumObject	Object
enumValue	string

Returns

string

---

getTextFromXml()

function getTextFromXml(xmlFormattedText, replaceParagraphString?): string;

Parameters

Parameter	Type	Default value
xmlFormattedText	string	undefined
replaceParagraphString	string	" "

Returns

string

---

getUniqueId()

function getUniqueId(object): string;

Parameters

Parameter	Type
object	Object

Returns

string

---

isEmpty()

function isEmpty<T>(value): boolean;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
value	T

Returns

boolean

---

isEqual()

function isEqual(a, b): boolean;

Parameters

Parameter	Type
a	any
b	any

Returns

boolean

---

isFocused()

function isFocused(element): any;

Parameters

Parameter	Type
element	Element

Returns

any

---

isNullOrEmptyOrWhiteSpace()

function isNullOrEmptyOrWhiteSpace(str): boolean;

Parameters

Parameter	Type
str	string

Returns

boolean

---

isNumber()

function isNumber(value): value is number;

Parameters

Parameter	Type
value	any

Returns

value is number

---

isObject()

function isObject(value): boolean;

Parameters

Parameter	Type
value	any

Returns

boolean

---

isString()

function isString(value): value is string;

Parameters

Parameter	Type
value	any

Returns

value is string

---

isValidXml()

function isValidXml(str, fixAmpsEnabled?): boolean;

Parameters

Parameter	Type	Default value
str	string	undefined
fixAmpsEnabled	boolean	true

Returns

boolean

---

localStorageEnabled()

function localStorageEnabled(): boolean;

Returns

boolean

---

measureScrollbar()

function measureScrollbar(): number;

Returns

number

---

mmToPoint()

function mmToPoint(millimeters): number;

Parameters

Parameter	Type
millimeters	number

Returns

number

---

normalize()

function normalize<T>(paramObject, def): T;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
paramObject	T
def	Partial<T>

Returns

T

---

parsePercentOrPointValue()

function parsePercentOrPointValue(point, printAreaSize): number;

Parameters

Parameter	Type
point	string | number
printAreaSize	number

Returns

number

---

stringEquals()

Call Signature

function stringEquals(str1, str2, ignoreCase?): boolean;

Parameters

Parameter	Type
str1	string
str2	string
ignoreCase?	boolean

Returns

boolean

Call Signature

function stringEquals(str1, str2, options?): boolean;

Parameters

Parameter	Type
str1	string
str2	string
options?	{ ignoreCase: boolean; }
options.ignoreCase?	boolean

Returns

boolean

---

stringFormat()

function stringFormat(str): string;

Parameters

Parameter	Type
str	string

Returns

string

---

stripForJson()

function stripForJson(obj, omitProperties?): object;

Parameters

Parameter	Type
obj	any
omitProperties?	string | string[]

Returns

object

---

strToInt()

function strToInt(str): number;

Parameters

Parameter	Type
str	string

Returns

number

---

timeout()

function timeout(delay?): Promise<void>;

Parameters

Parameter	Type
delay?	number

Returns

Promise<void>

---

toDashedStyle()

function toDashedStyle(camleCase): string;

Parameters

Parameter	Type
camleCase	string

Returns

string

---

unescapeXml()

function unescapeXml(str): string;

Parameters

Parameter	Type
str	string

Returns

string

---

urlCombine()

function urlCombine(startUrl, ...urlParts): string;

Parameters

Parameter	Type
startUrl	string
...urlParts	string[]

Returns

string