@motif/utils v0.4.9

utils : object

Kind: global namespace

• utils : object
  • .scroll
    • .to(options)
    • .top()
  • .compareVersions(firstVersion, secondVersion) ⇒ number
  • .dateAdd(date, duration) ⇒ Date
  • .dateDiff(leftDate, rightDate, unit) ⇒ Date
  • .dateFormat(date, format) ⇒ string
  • .dateISO(value) ⇒ Date
  • .dateSubtract(date, duration) ⇒ Date
  • .decodeSpecialChars(string) ⇒ string
  • .getBool(value, defaultValue) ⇒ boolean
  • .getJSON(data, defaultValue) ⇒ string
  • .is(type, [value], [passLike]) ⇒ boolean
  • .numberFormat(value) ⇒ string
  • .paging(options) ⇒ Paging
  • .parseJSON(jsonValue, defaultValue) ⇒ Object
  • .passwordStrength(value) ⇒ number
  • .queryString(value) ⇒ string
  • .split(string, delimiter, options) ⇒ string
  • .stripSlashes(string) ⇒ string
  • .timestamp() ⇒ Date
  • .truncate(string, maxLength, options) ⇒ string
  • .uuid() ⇒ string
  • .queue(options) ⇒ Queue
  • .timeout(component, key, callback, milliseconds) ⇒ Timeout
    • .getTimeout(component) ⇒ Timeout
    • .call(component, key, callback, milliseconds, [options]) ⇒ TimeoutInstance
    • .once(component, key, callback, milliseconds, [options]) ⇒ TimeoutInstance
    • .interval(component, key, callback, milliseconds, [options]) ⇒ TimeoutInstance
    • .has(component, key) ⇒ boolean
    • .clear(component, [keys]) ⇒ boolean
    • .sleep(milliseconds)
  • .ui(ref) ⇒ UIView
    • .getElement(ref) ⇒ Element
    • .getRect(ref) ⇒ UIRect
    • .getRectEdge(ref) ⇒ UIRectEdge

utils.scroll

Kind: static property of utils

• .scroll
  • .to(options)
  • .top()

utils.scroll.to(options)

Kind: static method of scroll

utils.scroll.top()

Kind: static method of scroll

utils.compareVersions(firstVersion, secondVersion) ⇒ number

Kind: static method of utils

utils.dateAdd(date, duration) ⇒ Date

Kind: static method of utils

utils.dateDiff(leftDate, rightDate, unit) ⇒ Date

Kind: static method of utils

utils.dateFormat(date, format) ⇒ string

Kind: static method of utils

Example

// Represent 11 February 2014 in middle-endian format:
var result = utils.dateFormat(new Date(2014, 1, 11), 'MM/dd/yyyy')
//=> '02/11/2014'

Example

// Represent 2 July 2014 in Esperanto:
import { eoLocale } from 'date-fns/locale/eo'
var result = utils.dateForma(new Date(2014, 6, 2), "do 'de' MMMM yyyy", {
  locale: eoLocale
})
//=> '2-a de julio 2014'

Example

// Escape string by single quote characters:
var result = utils.dateForma(new Date(2014, 6, 2, 15), "h 'o''clock'")
//=> "3 o'clock"

utils.dateISO(value) ⇒ Date

Kind: static method of utils

utils.dateSubtract(date, duration) ⇒ Date

Kind: static method of utils

utils.decodeSpecialChars(string) ⇒ string

Kind: static method of utils

utils.getBool(value, defaultValue) ⇒ boolean

Kind: static method of utils

utils.getJSON(data, defaultValue) ⇒ string

Kind: static method of utils

utils.is(type, value, passLike) ⇒ boolean

Kind: static method of utils

utils.numberFormat(value) ⇒ string

Kind: static method of utils

utils.paging(options) ⇒ Paging

Kind: static method of utils

utils.parseJSON(jsonValue, defaultValue) ⇒ Object

Kind: static method of utils

utils.passwordStrength(value) ⇒ number

Kind: static method of utils

utils.queryString(value) ⇒ string

Kind: static method of utils

utils.split(string, delimiter, options) ⇒ string

Kind: static method of utils

utils.stripSlashes(string) ⇒ string

Kind: static method of utils

utils.timestamp() ⇒ Date

Kind: static method of utils

utils.truncate(string, maxLength, options) ⇒ string

Kind: static method of utils

utils.uuid() ⇒ string

Kind: static method of utils

utils.queue(options) ⇒ Queue

Kind: static method of utils

utils.timeout(component, key, callback, milliseconds) ⇒ Timeout

Kind: static method of utils

• .timeout(component, key, callback, milliseconds) ⇒ Timeout
  • .getTimeout(component) ⇒ Timeout
  • .call(component, key, callback, milliseconds, [options]) ⇒ TimeoutInstance
  • .once(component, key, callback, milliseconds, [options]) ⇒ TimeoutInstance
  • .interval(component, key, callback, milliseconds, [options]) ⇒ TimeoutInstance
  • .has(component, key) ⇒ boolean
  • .clear(component, [keys]) ⇒ boolean
  • .sleep(milliseconds)

utils.timeout.getTimeout(component) ⇒ Timeout

Kind: static method of timeout

utils.timeout.call(component, key, callback, milliseconds, options) ⇒ TimeoutInstance

Kind: static method of timeout

utils.timeout.once(component, key, callback, milliseconds, options) ⇒ TimeoutInstance

Kind: static method of timeout

utils.timeout.interval(component, key, callback, milliseconds, options) ⇒ TimeoutInstance

Kind: static method of timeout

utils.timeout.has(component, key) ⇒ boolean

Kind: static method of timeout

utils.timeout.clear(component, keys) ⇒ boolean

Kind: static method of timeout

utils.timeout.sleep(milliseconds)

Kind: static method of timeout

utils.ui(ref) ⇒ UIView

Kind: static method of utils

• .ui(ref) ⇒ UIView
  • .getElement(ref) ⇒ Element
  • .getRect(ref) ⇒ UIRect
  • .getRectEdge(ref) ⇒ UIRectEdge

utils.ui.getElement(ref) ⇒ Element

Kind: static method of ui

utils.ui.getRect(ref) ⇒ UIRect

Kind: static method of ui

utils.ui.getRectEdge(ref) ⇒ UIRectEdge

Kind: static method of ui

Duration : enum

Kind: global enum

DateUnit : enum

Kind: global enum

Types : enum

Kind: global enum

TimeoutInstanceType : enum

Kind: global enum

Paging : Object

Kind: global typedef
Properties

PagingParameters : Object

Kind: global typedef
Properties

SplitOptions : Object

Kind: global typedef
Properties

TruncateOptions : Object

Kind: global typedef
Properties

QueueOptions : Object

Kind: global typedef
Properties

Queue

Kind: global typedef
Properties

• Queue
  • .add()
  • .remove(id)
  • .reverse()
  • .start()
  • .stop()

queue.add()

Kind: instance method of Queue

queue.remove(id)

Kind: instance method of Queue

queue.reverse()

Kind: instance method of Queue

queue.start()

Kind: instance method of Queue

queue.stop()

Kind: instance method of Queue

ScrollToOptions : Object

Kind: global typedef
Properties

TimeoutOptions : Object

Kind: global typedef
Properties

TimeoutInstance

Kind: global typedef
Properties

• TimeoutInstance
  • .getInstance() ⇒ NodeJS.Timeout | null
  • .getType() ⇒ TimeoutInstanceType
  • .execute()
  • .call()
  • .clear()

timeoutInstance.getInstance() ⇒ NodeJS.Timeout | null

Kind: instance method of TimeoutInstance

timeoutInstance.getType() ⇒ TimeoutInstanceType

Kind: instance method of TimeoutInstance

timeoutInstance.execute()

Kind: instance method of TimeoutInstance

timeoutInstance.call()

Kind: instance method of TimeoutInstance

timeoutInstance.clear()

Kind: instance method of TimeoutInstance

Timeout

Kind: global typedef
Properties

• Timeout
  • .getKeys() ⇒ Array.<string>
  • .getInstances(keys) ⇒ Array.<TimeoutInstance>
  • .has(key) ⇒ boolean
  • .get(key) ⇒ TimeoutInstance
  • .set(key, instance)
  • .expire(key)
  • .delete(key)
  • .clear([keys]) ⇒ boolean
  • .call(key, callback, milliseconds, [options]) ⇒ TimeoutInstance
  • .once(key, callback, milliseconds, [options]) ⇒ TimeoutInstance
  • .interval(key, callback, milliseconds, [options]) ⇒ TimeoutInstance
  • .sleep(milliseconds)

timeout.getKeys() ⇒ Array.<string>

Kind: instance method of Timeout

timeout.getInstances(keys) ⇒ Array.<TimeoutInstance>

Kind: instance method of Timeout

timeout.has(key) ⇒ boolean

Kind: instance method of Timeout

timeout.get(key) ⇒ TimeoutInstance

Kind: instance method of Timeout

timeout.set(key, instance)

Kind: instance method of Timeout

timeout.expire(key)

Kind: instance method of Timeout

timeout.delete(key)

Kind: instance method of Timeout

timeout.clear(keys) ⇒ boolean

Kind: instance method of Timeout

timeout.call(key, callback, milliseconds, options) ⇒ TimeoutInstance

Kind: instance method of Timeout

timeout.once(key, callback, milliseconds, options) ⇒ TimeoutInstance

Kind: instance method of Timeout

timeout.interval(key, callback, milliseconds, options) ⇒ TimeoutInstance

Kind: instance method of Timeout

timeout.sleep(milliseconds)

Kind: instance method of Timeout

UIRect : Object

Kind: global typedef
Properties

UIRectEdge : Object

Kind: global typedef
Properties

UIView : Object

Kind: global typedef