Expand all

util

Constructor

new util() #

Utility library

Source:
Utility library

Properties

Promise #

Wrapper class for Promises

Source:
Wrapper class for Promises

Methods

Deferred() → {jQuery.Deferred} #

Wrapper class for the Deferred method

Returns:

Type
jQuery.Deferred
Source:
Wrapper class for the Deferred method

all(promises) → {jQuery.Promise} #

Wrapper class for the $.when that is compatible with Promise.all

Parameters:

Name Type Description
promises Array.<jQuery.Promise>

Returns:

Type
jQuery.Promise
Source:
Wrapper class for the $.when that is compatible with Promise.all

docReady(fn) → {jQuery.Object} #

Run method when document is ready.

Parameters:

Name Type Description
fn function

Returns:

Type
jQuery.Object
Source:
Run method when document is ready.

escapeSelector(selector) → {string} #

Escape a string for use as a css selector

Parameters:

Name Type Description
selector string

Returns:

Type
string
Source:
Escape a string for use as a css selector

extend() → {Object} #

Wrapper for jQuery.extend method. In future this can be bound to Object.assign when support allows.

Warning: if only one argument is supplied to util.extend(), this means the target argument was omitted. In this case, the jQuery object itself is assumed to be the target.

Returns:

Type
Object
Source:
Wrapper for jQuery.extend method.

getDocument() → {jQuery.Object} #

Adds a class to the document

Returns:

element representing the documentElement

Type
jQuery.Object
Source:
Adds a class to the document

getWindow() → {jQuery.Object} #

Get the window object

Returns:

Type
jQuery.Object
Source:
Get the window object

parseHTML(html, [ctx]) → {jQuery.Object} #

Given some html, create new element(s). Unlike jQuery.parseHTML this will return a jQuery object not an array.

Parameters:

Name Type Attributes Description
html string
ctx Element optional

Document element to serve as the context in which the HTML fragment will be created

Returns:

Type
jQuery.Object
Source:
Given some html, create new element(s).