API reference up.util

module

---

Features

• up.util.assign(target, ...sources) JS deprecated

  Merge the own properties of one or more sources into the target object.

• up.util.compact(list) JS

  Returns all elements from the given list that are neither null nor undefined.

• up.util.contains(value, subValue) JS

  Returns whether the given value contains another value.

• up.util.copy(object) JS

  Returns a shallow copy of the given value.

• up.util.copy.key JS

  This property contains the name of a method that user-defined classes may implement to hook into the up.util.copy() protocol.

• up.util.each(list, block) JS

  Calls the given function for each element (and optional index) of the given list or iterator.

• up.util.escapeHTML(string) JS

  Escapes the given string of HTML by replacing control chars with their HTML entities.

• up.util.evalOption(value, ...args) JS

  If the given value is a function, calls the function with the given args. Otherwise it just returns value.

• up.util.every(list, tester) JS

  Returns whether the given function returns a truthy value for all elements in the given list or iterator.

• up.util.except(object, ...keys) JS deprecated

  Returns a copy of the given object that contains all except the given keys.

• up.util.filter(list, tester) JS

  Returns all elements from the given list that return a truthy value when passed to the given function.

• up.util.find(list, tester) JS

  Passes each element in the given array-like value to the given function. Returns the first element for which the function returns a truthy value.

• up.util.findResult(list, tester) JS

  Consecutively calls the given function with each element in the given list. Returns the first truthy return value.

• up.util.flatMap(list, mapping) JS

  Maps each element using a mapping function, then flattens the result into a new array.

• up.util.flatten(array) JS

  Flattens the given array a single depth level.

• up.util.isArray(value) JS

  Returns whether the given argument is an array.

• up.util.isBlank(value) JS

  Returns whether the given argument is considered to be blank.

• up.util.isBlank.key JS

  This property contains the name of a method that user-defined classes may implement to hook into the up.util.isBlank() protocol.

• up.util.isBoolean(value) JS

  Returns whether the given argument is a boolean value.

• up.util.isDefined(value) JS

  Returns whether the given argument is not undefined.

• up.util.isElement(value) JS

  Returns whether the given argument is a DOM element.

• up.util.isEqual(a, b) JS

  Returns whether the two arguments are equal by value.

• up.util.isEqual.key JS

  This property contains the name of a method that user-defined classes may implement to hook into the up.util.isEqual() protocol.

• up.util.isFunction(value) JS

  Returns whether the given argument is a function.

• up.util.isGiven(value) JS

  Returns whether the given argument is neither undefined nor null.

• up.util.isJQuery(value) JS

  Returns whether the given argument is a jQuery collection.

• up.util.isList(value) JS

  Returns whether the given argument is an array-like value.

• up.util.isMissing(value) JS

  Returns whether the given argument is either undefined or null.

• up.util.isNull(object) JS

  Returns whether the given argument is null.

• up.util.isNumber(value) JS

  Returns whether the given argument is a number.

• up.util.isObject(value) JS

  Returns whether the given argument is an object.

• up.util.isPresent(value) JS

  Returns whether the given argument is not blank.

• up.util.isPromise(value) JS

  Returns whether the given argument is an object with a then method.

• up.util.isString(value) JS

  Returns whether the given argument is a string.

• up.util.isUndefined(value) JS

  Returns whether the given argument is undefined.

• up.util.last(array) JS

  Returns the last element of the given array or string.

• up.util.map(list, block) JS

  Maps all items in a list to a new array of items.

• up.util.mapObject(array, mapping) JS

  Creates an object from the given array and mapping function.

• up.util.merge(...sources) JS

  Creates a new object by merging together the properties from the given objects.

• up.util.microtask(task) JS deprecated

  Pushes the given function to the JavaScript microtask queue.

• up.util.noop() JS

  A function that does nothing.

• up.util.normalizeURL(url, [options]) JS

  Returns a normalized version of the given URL string.

• up.util.omit(object, keys) JS

  Returns a copy of the given object that contains all except the given keys.

• up.util.only(object, ...keys) JS deprecated

  Returns a copy of the given object that only contains the given keys.

• up.util.parseNumber(value) JS experimental

  Parses the given value and returns a number.

• up.util.parseRelaxedJSON(text) JS experimental

  Parses a string of relaxed JSON into a JavaScript value.

• up.util.parseURL(the) JS

  Parses the given URL into components such as hostname and path.

• up.util.pick(object, keys) JS

  Returns a copy of the given object that only contains the given keys.

• up.util.pickBy(object, tester) JS experimental

  Returns a copy of the given object that only contains properties that pass the given tester function.

• up.util.pluckKey(object, key) JS

  Deletes the property with the given key from the given object and returns its value.

• up.util.presence(value, [tester]) JS

  Returns the given argument if the argument is present, otherwise returns undefined.

• up.util.reject(list, tester) JS

  Returns all elements from the given array-like value that do not return a truthy value when passed to the given function.

• up.util.remove(array, element) JS

  Removes the given element from the given array.

• up.util.some(list, tester) JS

  Returns whether the given function returns a truthy value for any element in the given array-like value.

• up.util.task(callback) JS

  Schedules a function to the JavaScript task queue (also "macrotask queue").

• up.util.timer(millis, callback) JS

  Waits for the given number of milliseconds, then runs the given callback.

• up.util.times(count, block) JS deprecated

  Calls the given function for the given number of times.

• up.util.toArray(value) JS

  Converts the given array-like value into an array.

• up.util.uniq(array) JS

  Returns the given array without duplicates.

• up.util.uniqBy(array) JS experimental

  This function is like uniq, except that the given function is invoked for each element to generate the value for which uniqueness is computed.

• up.util.values(object) JS deprecated

  Returns an array of values of the given object.

• up.util.wrapList(value) JS

  Returns the given value if it is array-like, otherwise returns an array with the given value as its only element.