@webantic/util v9.0.4

Modules

util/array

• util/array
  • ~move(array, fromIndex, toIndex) ⇒ Array.<any>
  • ~addToSet(array, item) ⇒ Array.<any>
  • ~addToSetInPlace(set, item) ⇒ boolean
  • ~first(array) ⇒ any
  • ~last(array) ⇒ any
  • ~eachUntil(array, callback)
  • ~remove(array, item) ⇒ Array.<any>
  • ~removeAll(array, item) ⇒ Array.<any>
  • ~forceArray(input) ⇒ Array.<any>
  • ~mapAsync(array, callback, onComplete)
  • ~forEachAsync(array, cb, onComplete)

util/array~move(array, fromIndex, toIndex) ⇒ Array.<any>

Kind: inner method of util/array
Summary: moves an element at a given index to another index
Export:

util/array~addToSet(array, item) ⇒ Array.<any>

Kind: inner method of util/array
Summary: Returns an array containing item, adding it if it is missing. Note: this only uses indexOf for comparison, so it will not work for objects
Returns: Array.<any> - the new array
Export:

util/array~addToSetInPlace(set, item) ⇒ boolean

Kind: inner method of util/array
Summary: Adds item to set if it is missing, returns true if set was modified
Returns: boolean - true if set was modified
Export:

util/array~first(array) ⇒ any

Kind: inner method of util/array
Summary: returns the first element in an array
Returns: any - the first element of the array
Export:

util/array~last(array) ⇒ any

Kind: inner method of util/array
Summary: returns the last element in an array
Returns: any - the last element of the array
Export:

util/array~eachUntil(array, callback)

Kind: inner method of util/array
Summary: calls callback for each item in an array, provided that the previous iteration didn't return false
Export:

util/array~remove(array, item) ⇒ Array.<any>

Kind: inner method of util/array
Summary: Remove an item from an array
Returns: Array.<any> - The new array
Export:

Example

var array = ['a', 'b', 'c']
remove(array, 'b') // returns ['a', 'c']

util/array~removeAll(array, item) ⇒ Array.<any>

Kind: inner method of util/array
Summary: Removes all occurrences of item from array
Returns: Array.<any> - The new array
Export:

Example

var array = ['a', 'b', 'b', 'c']
removeAll(array, 'b') // returns ['a', 'c']

util/array~forceArray(input) ⇒ Array.<any>

Kind: inner method of util/array
Summary: wraps the input in an array if it isn't already one
Returns: Array.<any> - always an array

util/array~mapAsync(array, callback, onComplete)

Map an array's values, iterating asynchronously

Kind: inner method of util/array

util/array~forEachAsync(array, cb, onComplete)

Iterate the elements in an array, calling the user-supplied callback on each element asynchronously

Kind: inner method of util/array

util/blaze

• util/blaze
  • ~attachAPI(blaze, API)
  • ~onCountChanged(callback)

util/blaze~attachAPI(blaze, API)

Attach a DDP connection to Blaze so that it is available in templates' this.subscribe

Kind: inner method of util/blaze

util/blaze~onCountChanged(callback)

Add a function to get called when the count changes

Kind: inner method of util/blaze

util/collection

• util/collection
  • ~insert(collection, items) ⇒ ICollectionReturn
  • ~update(collection, items) ⇒ ICollectionReturn
  • ~remove(collection, _ids) ⇒ ICollectionReturn
  • ~caseInsensitiveSelector(fieldName, str, [wordIsPrefix]) ⇒ Object
  • ~selectorFromParams(selectorParams) ⇒ Object
  • ~getObserverHandlers(context, collection) ⇒ IObserveHandlers
  • ~mapHelpersToThis(pureHelpers) ⇒ any
  • ~IFailedOps : Object
  • ~ICollectionReturn : Object
  • ~IObserveHandlers : Object
  • ~ISelectorParams : Object

util/collection~insert(collection, items) ⇒ ICollectionReturn

Kind: inner method of util/collection
Summary: Inserts a number of items into the given collection
Export:

util/collection~update(collection, items) ⇒ ICollectionReturn

Kind: inner method of util/collection
Summary: Updates a number of items into the given collection
Export:

util/collection~remove(collection, _ids) ⇒ ICollectionReturn

Kind: inner method of util/collection
Summary: Remvoves a number of items by their _id from the given collection
Export:

util/collection~caseInsensitiveSelector(fieldName, str, wordIsPrefix) ⇒ Object

Kind: inner method of util/collection
Summary: Generates a selector for a field which will perform a case-insensitive lookup for the given value
Returns: Object - the Mongo selector object
Export:

util/collection~selectorFromParams(selectorParams) ⇒ Object

Kind: inner method of util/collection
Summary: Parses "skip", "limit", "sort", "before" and "since" into a selector and options object
Returns: Object - The constructed selector & options objects
Export:

util/collection~getObserverHandlers(context, collection) ⇒ IObserveHandlers

Kind: inner method of util/collection
Summary: Returns a map of default observe callback handlers
Returns: IObserveHandlers - The map of callback handlers
Export:

util/collection~mapHelpersToThis(pureHelpers) ⇒ any

Takes an object of helpers and wraps them in functions that use the this context and pass it as the first arg. Allows thisless functions to be used as collection helpers

Kind: inner method of util/collection

util/collection~IFailedOps : Object

Kind: inner typedef of util/collection
Properties

util/collection~ICollectionReturn : Object

Kind: inner typedef of util/collection
Properties

util/collection~IObserveHandlers : Object

Kind: inner typedef of util/collection
Properties

util/collection~ISelectorParams : Object

Kind: inner typedef of util/collection
Properties

util/config

• util/config
  • ~Configuration
    • new Configuration(collection, Meteor, [Tracker], [connection])
  • ~StandaloneConfiguration
    • new StandaloneConfiguration()

util/config~Configuration

Kind: inner class of util/config

new Configuration(collection, Meteor, Tracker, connection)

A configuration class - provides a DB-backed, environment variable / meteor.settings populated set of config values

util/config~StandaloneConfiguration

Kind: inner class of util/config

new StandaloneConfiguration()

A configuration class - provides an environment variable / codebase-populated set of config values

util/data

• util/data
  • ~titles([flatten]) ⇒ Array.<object> | Array.<string>
  • ~genders([flatten]) ⇒ Array.<object> | Array.<string>
  • ~maritalStatuses([flatten]) ⇒ Array.<object> | Array.<string>
  • ~nationalities([flatten]) ⇒ Array.<object> | Array.<string>

util/data~titles(flatten) ⇒ Array.<object> | Array.<string>

Kind: inner method of util/data
Summary: provides a list of name titles
Returns: Array.<object> | Array.<string> - If flatten is true, an array of string values otherwise an array of objects with name and camelized value
Export:

util/data~genders(flatten) ⇒ Array.<object> | Array.<string>

Kind: inner method of util/data
Summary: provides a list of genders
Returns: Array.<object> | Array.<string> - If flatten is true, an array of string values otherwise an array of objects with name and camelized value
Export:

util/data~maritalStatuses(flatten) ⇒ Array.<object> | Array.<string>

Kind: inner method of util/data
Summary: provides a list of maritalStatuses
Returns: Array.<object> | Array.<string> - If flatten is true, an array of string values otherwise an array of objects with name and camelized value
Export:

util/data~nationalities(flatten) ⇒ Array.<object> | Array.<string>

Kind: inner method of util/data
Summary: provides a list of nationalities
Returns: Array.<object> | Array.<string> - If flatten is true, an array of string values otherwise an array of objects with name and camelized value
Export:

util/date

• util/date
  • ~randomBetween(from, to) ⇒ Date
  • ~getDate([startEnd], [prevNext], [interval]) ⇒ Date
  • ~yesterday([startEnd]) ⇒ Date
  • ~tomorrow([startEnd]) ⇒ Date
  • ~lastWeek([startEnd]) ⇒ Date
  • ~nextWeek([startEnd]) ⇒ Date
  • ~lastMonth([startEnd]) ⇒ Date
  • ~nextMonth([startEnd]) ⇒ Date
  • ~getPreviousDay(day) ⇒ string
  • ~getNextDay(day) ⇒ string

util/date~randomBetween(from, to) ⇒ Date

Kind: inner method of util/date
Summary: gets a random date between two others
Returns: Date - the random date
Export:

util/date~getDate(startEnd, prevNext, interval) ⇒ Date

Gets a Date object of a given offset from now

Kind: inner method of util/date
Returns: Date - the date object

util/date~yesterday(startEnd) ⇒ Date

Return a Date object from 24 hours ago

Kind: inner method of util/date
Returns: Date - the date object

util/date~tomorrow(startEnd) ⇒ Date

Return a Date object for 24 hours in the future

Kind: inner method of util/date
Returns: Date - the date object

util/date~lastWeek(startEnd) ⇒ Date

Return a Date object from 7 days ago

Kind: inner method of util/date
Returns: Date - the date object

util/date~nextWeek(startEnd) ⇒ Date

Return a Date object for 7 days in the future

Kind: inner method of util/date
Returns: Date - the date object

util/date~lastMonth(startEnd) ⇒ Date

Return a Date object from 30 days ago

Kind: inner method of util/date
Returns: Date - the date object

util/date~nextMonth(startEnd) ⇒ Date

Return a Date object for 30 days in the future

Kind: inner method of util/date
Returns: Date - the date object

util/date~getPreviousDay(day) ⇒ string

Can be passed either a full or three-letter day name and will return the previous day's name

Kind: inner method of util/date
Returns: string - the name of the previous day

util/date~getNextDay(day) ⇒ string

Can be passed either a full or three-letter day name and will return the next day's name

Kind: inner method of util/date
Returns: string - the name of the next day

util/emitter

• util/emitter
  • .MultiEmitter
    • new MultiEmitter()
  • .Emitter
    • new Emitter()
  • .MultiEmitter#listen(event, callback)
  • .MultiEmitter#broadcast(event, value)
  • .MultiEmitter#removeListeners(event)
  • .Emitter#listen()
  • .Emitter#broadcast(value)
  • .Emitter#removeListeners()

util/emitter.MultiEmitter

Kind: static class of util/emitter
Export:

new MultiEmitter()

Slightly more advanced event emitter style class that allows listening to different events via string arguments

util/emitter.Emitter

Kind: static class of util/emitter
Export:

new Emitter()

Basic class that represents an event that can be listened to and broadcasted

util/emitter.MultiEmitter#listen(event, callback)

Add a callback to be ran whenver this event is broadcasted

Kind: static method of util/emitter

util/emitter.MultiEmitter#broadcast(event, value)

Broadcast an event of the given type

Kind: static method of util/emitter

util/emitter.MultiEmitter#removeListeners(event)

Remove all attached listeners for a specific event type

Kind: static method of util/emitter

util/emitter.Emitter#listen()

Add a callback to be ran whenver this event is broadcasted

Kind: static method of util/emitter

util/emitter.Emitter#broadcast(value)

Calls all callbacks that have been registered with the given value

Kind: static method of util/emitter

util/emitter.Emitter#removeListeners()

Remove all attached listeners

Kind: static method of util/emitter

util/http

• util/http
  • ~getBaseParameter([{ location, type, required }]) ⇒ Object
  • ~requiredBodyString(extendedDef) ⇒ Object
  • ~requiredBodyNumber(extendedDef) ⇒ Object
  • ~requiredBodyDate(extendedDef) ⇒ Object
  • ~requiredBodyBoolean(extendedDef) ⇒ Object
  • ~requiredBodyObject(extendedDef) ⇒ Object
  • ~optionalBodyString(extendedDef) ⇒ Object
  • ~optionalBodyNumber(extendedDef) ⇒ Object
  • ~optionalBodyDate(extendedDef) ⇒ Object
  • ~optionalBodyBoolean(extendedDef) ⇒ Object
  • ~optionalBodyObject(extendedDef) ⇒ Object

util/http~getBaseParameter({ location, type, required }) ⇒ Object

Kind: inner method of util/http
Summary: returns a basic Swagger parameter field
Export:

util/http~requiredBodyString(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a required body string parameter
Export:

util/http~requiredBodyNumber(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a required body number parameter
Export:

util/http~requiredBodyDate(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a required body string parameter
Export:

util/http~requiredBodyBoolean(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a required body boolean parameter
Export:

util/http~requiredBodyObject(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a required body object parameter
Export:

util/http~optionalBodyString(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a optional body string parameter
Export:

util/http~optionalBodyNumber(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a optional body number parameter
Export:

util/http~optionalBodyDate(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a optional body string parameter
Export:

util/http~optionalBodyBoolean(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a optional body boolean parameter
Export:

util/http~optionalBodyObject(extendedDef) ⇒ Object

Kind: inner method of util/http
Summary: scaffolds a optional body object parameter
Export:

util/image

• util/image
  • ~dataURIToBlob(dataURI) ⇒ blob
  • ~toDataURI(file, callback)

util/image~dataURIToBlob(dataURI) ⇒ blob

Kind: inner method of util/image
Summary: converts a data uri to a blob://
Returns: blob - the uri as a blob
Export:

util/image~toDataURI(file, callback)

Kind: inner method of util/image
Summary: converts an image file to a data uri
Export:

util/location

util/location~calculateDistance(lat1, lon1, lat2, lon2) ⇒ number

Kind: inner method of util/location
Summary: Get the distance in KM between two latitude/longitude pairs
Returns: number - The distance between the two points, in KM
Export:

util/meteor

• util/meteor
  • ~assert(assertion, errorCode, [meta])
  • ~assertString(value, name)
  • ~assertBoolean(value, name)
  • ~assertNumber(value, name)
  • ~assertInt(value, name)
  • ~assertObject(value, name)
  • ~assertArray(value, name, type)
  • ~assertDate(value, options)

util/meteor~assert(assertion, errorCode, meta)

Kind: inner method of util/meteor
Summary: if the assertion is falsey, throws an error
Export:

util/meteor~assertString(value, name)

Assert that the typeof ${value} is 'string'

Kind: inner method of util/meteor

util/meteor~assertBoolean(value, name)

Assert that the typeof ${value} is 'boolean'

Kind: inner method of util/meteor

util/meteor~assertNumber(value, name)

Assert that the typeof ${value} is 'number'

Kind: inner method of util/meteor

util/meteor~assertInt(value, name)

Assert that the ${value} is an integer

Kind: inner method of util/meteor

util/meteor~assertObject(value, name)

Assert that the typeof ${value} is 'object'

Kind: inner method of util/meteor

util/meteor~assertArray(value, name, type)

Assert that the ${value} is an array

Kind: inner method of util/meteor

util/meteor~assertDate(value, options)

Assert that the typeof ${value} is 'Date'

Kind: inner method of util/meteor

util/model

• util/model
  • ~ModelDefinition
    • new ModelDefinition(t)
    • .ModelDefinition#auto(func) ⇒ this
    • .ModelDefinition#maybe() ⇒ this
    • .ModelDefinition#max(val, [exclusive]) ⇒ this
    • .ModelDefinition#min(val, [exclusive]) ⇒ this
    • .ModelDefinition#maxCount(val) ⇒ this
    • .ModelDefinition#minCount(val) ⇒ this
    • .ModelDefinition#subtype(format) ⇒ this
    • .ModelDefinition#prop(name, value) ⇒ this
    • .ModelDefinition#props(properties) ⇒ this
    • .ModelDefinition#elems(definition) ⇒ this
    • .ModelDefinition#regex(pattern) ⇒ this
    • .ModelDefinition#in(values) ⇒ this
    • .ModelDefinition#join(model, [field], where) ⇒ this
    • .ModelDefinition#other(key, value) ⇒ this
  • ~def ⇒ this
  • ~ILinkWhere : Object
  • ~ILink : Object

util/model~ModelDefinition

Kind: inner class of util/model
Export:

• ~ModelDefinition
  • new ModelDefinition(t)
  • .ModelDefinition#auto(func) ⇒ this
  • .ModelDefinition#maybe() ⇒ this
  • .ModelDefinition#max(val, [exclusive]) ⇒ this
  • .ModelDefinition#min(val, [exclusive]) ⇒ this
  • .ModelDefinition#maxCount(val) ⇒ this
  • .ModelDefinition#minCount(val) ⇒ this
  • .ModelDefinition#subtype(format) ⇒ this
  • .ModelDefinition#prop(name, value) ⇒ this
  • .ModelDefinition#props(properties) ⇒ this
  • .ModelDefinition#elems(definition) ⇒ this
  • .ModelDefinition#regex(pattern) ⇒ this
  • .ModelDefinition#in(values) ⇒ this
  • .ModelDefinition#join(model, [field], where) ⇒ this
  • .ModelDefinition#other(key, value) ⇒ this

new ModelDefinition(t)

Class to generate model definitions

ModelDefinition.ModelDefinition#auto(func) ⇒ this

Define an autoValue

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#maybe() ⇒ this

Set this field as optional

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#max(val, exclusive) ⇒ this

Set this field's maximum allowed value / length

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#min(val, exclusive) ⇒ this

Set this field's minimum allowed value / length

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#maxCount(val) ⇒ this

Set the maximum number of allowed elements in an array field

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#minCount(val) ⇒ this

Set the minimum number of allowed elements in an array field

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#subtype(format) ⇒ this

Set the subtype / format of this field. E.g. "float" for a number type

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#prop(name, value) ⇒ this

Define a single property of an object-type field

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#props(properties) ⇒ this

Define all properties of an object-type field

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#elems(definition) ⇒ this

Define the elements of an array-type field

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#regex(pattern) ⇒ this

Define a RegEx pattern which applies to a string-type field

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#in(values) ⇒ this

Define a list of permitted values for this field

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#join(model, field, where) ⇒ this

Define a link to another Model

Kind: static method of ModelDefinition

ModelDefinition.ModelDefinition#other(key, value) ⇒ this

Set a custom definition key

Kind: static method of ModelDefinition

util/model~def ⇒ this

Shorthand to get an instance of ModelDefinition

Kind: inner constant of util/model

util/model~ILinkWhere : Object

Kind: inner typedef of util/model
Properties

util/model~ILink : Object

Kind: inner typedef of util/model
Properties

util/number

• util/number
  • ~clamp(val, min, max) ⇒ number
  • ~random([min], [max])
  • ~pad(num, width, char) ⇒ string

util/number~clamp(val, min, max) ⇒ number

Kind: inner method of util/number
Summary: ensures that a number falls between two others, constraining it if necessary
Returns: number - the clamped number
Export:

util/number~random(min, max)

Kind: inner method of util/number
Summary: Returns a random integer, optionally between an min and max
Export:

util/number~pad(num, width, char) ⇒ string

Kind: inner method of util/number
Summary: pads out a number to specified width with specified char or 0
Returns: string - the padded number
Export:

util/object

• util/object
  • ~map(object, callback) ⇒ any
  • ~transform(object, callback)
  • ~forEach()
  • ~filter(object, callback) ⇒ any
  • ~resolve() ⇒ any | undefined
  • ~didResolve() ⇒ boolean
  • ~resolveIf() ⇒ any | null
  • ~resolveSet() ⇒ boolean
  • ~transformPathsToObjects(obj) ⇒
  • ~flatten(input, _output, _prefix)
  • ~flattenAll(input, _output, _prefix)
  • ~resolveSetP(outerObj, outerPath, outerVal) ⇒ boolean
  • ~mapAsync
  • ~transformAsync

util/object~map(object, callback) ⇒ any

Kind: inner method of util/object
Summary: passes each key=>value pair to callback, setting the result to a new object under a key of the same name
Returns: any - a new object with the same key names but mapped values
Export:

util/object~transform(object, callback)

Kind: inner method of util/object
Summary: Like map, but able to transform the key too. Map the object into a completely different

util/object~forEach()

Kind: inner method of util/object
Summary: Like array.forEach, but for an object, gets keys and values

util/object~filter(object, callback) ⇒ any

Kind: inner method of util/object
Summary: passes each key=>value pair of an object to callback, copying them over if the result is truthy
Returns: any - a filtered copy of the input object
Export:

util/object~resolve() ⇒ any | undefined

Kind: inner method of util/object
Summary: get a nested property of an object by string e.g. resolve(myObj, 'nested.property')
Returns: any | undefined - resolved value or undefined if intermediate values are undefined
Export:

util/object~didResolve() ⇒ boolean

Kind: inner method of util/object
Summary: report whether an attempt to resolve a nested property of an object was successful or not.
Returns: boolean - whether the nested property exists
Export:

util/object~resolveIf() ⇒ any | null

Kind: inner method of util/object
Summary: same as resolve but sets the property to val
Returns: any | null - The resolved value or null
Export:

util/object~resolveSet() ⇒ boolean

Kind: inner method of util/object
Summary: same as resolve but sets the property to val
Returns: boolean - whether setting was successful
Export:

util/object~transformPathsToObjects(obj) ⇒

Transform an entire object by converting all of its keys into object paths using resolveSet

Kind: inner method of util/object
Returns: obj for convenience, although transformed in place

util/object~flatten(input, _output, _prefix)

Convert a deep object into one which is flat (has a max depth of 1 level). The output object's keys will use dot notation to symbolise depth. If a property contains a dot, this will be converted to "dot"

Kind: inner method of util/object

Example

var deepObj = {person: {profile: {name: 'Carl', age: 26}, password: 'foobar', '.withDot': true}}
    var res = flatten(deepObj)
    // res === {
    //   'person.profile.name': 'Carl',
    //   'person.profile.age': 26,
    //   'person.password': 'foobar',
    //   'person.[dot]withDot': true
    // }

util/object~flattenAll(input, _output, _prefix)

Convert a deep object into one which is flat (has a max depth of 1 level). The output object's keys will use dot notation to symbolise depth. Also processes arrays

Kind: inner method of util/object

Example

var deepObj = {person: {profile: {name: 'Carl', age: 26}, things: ['foo', 'bar'], '.withdot': true}}
    flattenAll(deepObj)
    // returns {
    //   'person.profile.name': 'Carl',
    //   'person.profile.age': 26,
    //   'person.things.0': 'foo',
    //   'person.things.1': 'bar'
    //   'person.[dot]withDot: true
    // }

util/object~resolveSetP(outerObj, outerPath, outerVal) ⇒ boolean

Kind: inner method of util/object
Summary: same as resolveSet, but will create paths down into objects where they don't exist
Returns: boolean - whether the op was successful
Export:

util/object~mapAsync

Kind: inner typedef of util/object
Summary: passes each key=>value pair to callback asynchronously, setting the result to a new object under a key of the same name. Calls onComplete when all keys have been mapped
Export:

util/object~transformAsync

Kind: inner typedef of util/object
Summary: Like map, but able to transform the key too. Map the object into a completely different shape. Iterates asynchronously
Export:

util/popover

• util/popover
  • ~open(source, content, options)
  • ~openDropdown(source, dropDownItems, options)
  • ~ifLet(toCheck, ifCallback, elseCallback)
  • ~viewportPosition(element)
  • ~addTriangleToFixedElement(element, positionedWhere, pointingAt, container) ⇒
  • ~positionFixed(element, relativeTo)

util/popover~open(source, content, options)

Opens a popover with the specified content located on the edge of the source object

Kind: inner method of util/popover

util/popover~openDropdown(source, dropDownItems, options)

Opens a dropdown, which internally is still a popover with some special additions

Kind: inner method of util/popover(#mod