smize v1.2.2

smize : object

Kind: global namespace

• smize : object
  • .composables : object
    • .AJAX
      • new AJAX(scope)
      • .afterAll(xhr, status, response) ⇒ boolean
      • .afterEach(xhr, status, response) ⇒ boolean
      • .call(config, stopOnError) ⇒ void
    • .Base
      • new Base(config, defaults)
      • .configure(config) ⇒ boolean
      • .subscribe(eventNames) ⇒ boolean
      • .handleSubscriptions(eventName) ⇒ boolean
    • .Debug
      • new Debug(scope, config)
      • .error() ⇒ boolean
      • .formatMessage(methodName, message) ⇒ string
      • .info() ⇒ boolean
      • .matchesFilters(message) ⇒ boolean
      • .warn() ⇒ boolean
      • .write(writeArguments) ⇒ boolean
  • .data : object
    • .getCookies(cookieString) ⇒ object
    • .getLocalItem(itemName, defaultValue) ⇒ object
    • .getMetaKeys() ⇒ object
    • .getQueryKeys(queryString) ⇒ object
    • .getSessionItem(itemName, defaultValue) ⇒ object
    • .removeLocalItem(itemName) ⇒ boolean
    • .removeSessionItem(itemName) ⇒ boolean
    • .setLocalItem(itemName, value) ⇒ boolean
    • .setSessionItem(itemName, value) ⇒ boolean
    • .transferKeys(source, target, concatArrays, dedupeArrays) ⇒ boolean
  • .events : object
    • .debounce(originalFunction, executionDelay, callImmediately) ⇒ function
    • .publish(subscriptionName) ⇒ boolean
    • .subscribe(subscriptionName, subscriber) ⇒ boolean
  • .html : object
    • .addClass(elements, classNames) ⇒ boolean
    • .getClasses(elements) ⇒ array
    • .hasClass(elements, classNames) ⇒ boolean
    • .isValidElement(element) ⇒ boolean
    • .nodeListToArray(elements) ⇒ array
    • .removeClass(elements, classNames) ⇒ boolean
  • .il8n : object
    • .addDictionaryKey(dictionaryKey) ⇒ boolean
    • .addDictionaryKeys(dictionaryKeys) ⇒ boolean
    • .formatDate(date, language) ⇒ string
    • .formatDateString(dateString, language) ⇒ string
    • .formatNumber(numberValue, language, options) ⇒ string
    • .getKeyValue(dictionaryKeyName, language) ⇒ string
    • .setKeyValue(dictionaryKeyName, language, value) ⇒ boolean
  • .responsive : object
    • .currentBreakpoint
    • .addBreakpoint(breakpointName, breakpointSettings) ⇒ boolean
    • .addSubscriber(breakpointNames, subscriberFunction) ⇒ boolean
    • .bindEventHandlers() ⇒ boolean
    • .getBreakpoint(breakpointName) ⇒ object
    • .getCurrentBreakpoints(viewport) ⇒ Array
    • .getSubscriberCount(breakpointName) ⇒ number
    • .removeBreakpoint(breakpointName) ⇒ boolean
  • .ui : object
    • .bindModule(element) ⇒ boolean
    • .bindScope(scope, deferSelector) ⇒ boolean
    • .registerModule(moduleName, ClassReference, defaultConfiguration) ⇒ boolean
  • .utils : object
    • .arrayFromArrayLike(arrayLike) ⇒ array
    • .objectFromString(string) ⇒ object
    • .replaceTokens(originalString, tokenSources, removeRemainder) ⇒ string
    • .resolveBits(bits, expectedType, root) ⇒ object
    • .stringFromObject(obj) ⇒ string
  • .valid : object
    • .isDocumentValid() ⇒ boolean
    • .isFalsy(value) ⇒ boolean
    • .isOfType(value, checkType) ⇒ boolean
    • .isTruthy(value) ⇒ boolean
    • .isValidArray(value) ⇒ boolean
    • .isValidCountryCode(countryCode) ⇒ boolean
    • .isValidObject(value) ⇒ boolean
    • .isValidString(value) ⇒ boolean
    • .isWindowValid() ⇒ boolean
    • .validBoolean(value, defaultValue) ⇒ boolean
    • .validNumber(value, defaultValue) ⇒ number
    • .validObject(value, defaultValue) ⇒ object
    • .validString(value, defaultValue) ⇒ string
  • .ns(bitParts, root) ⇒ object

smize.composables : object

A collection of composable classes that provide reusable functionality.

Kind: static namespace of smize

• .composables : object
  • .AJAX
    • new AJAX(scope)
    • .afterAll(xhr, status, response) ⇒ boolean
    • .afterEach(xhr, status, response) ⇒ boolean
    • .call(config, stopOnError) ⇒ void
  • .Base
    • new Base(config, defaults)
    • .configure(config) ⇒ boolean
    • .subscribe(eventNames) ⇒ boolean
    • .handleSubscriptions(eventName) ⇒ boolean
  • .Debug
    • new Debug(scope, config)
    • .error() ⇒ boolean
    • .formatMessage(methodName, message) ⇒ string
    • .info() ⇒ boolean
    • .matchesFilters(message) ⇒ boolean
    • .warn() ⇒ boolean
    • .write(writeArguments) ⇒ boolean

composables.AJAX

A composable class that provides AJAX functionality

Kind: static class of composables
Properties

• .AJAX
  • new AJAX(scope)
  • .afterAll(xhr, status, response) ⇒ boolean
  • .afterEach(xhr, status, response) ⇒ boolean
  • .call(config, stopOnError) ⇒ void

new AJAX(scope)

Creates a new, scoped instance of the AJAX class

AJAX.afterAll(xhr, status, response) ⇒ boolean

Tasks performed after all AJAX calls in a series of calls

Kind: static method of AJAX
Returns: boolean - The method executed successfully

AJAX.afterEach(xhr, status, response) ⇒ boolean

Tasks performed after each AJAX call in a series of calls

Kind: static method of AJAX
Returns: boolean - The method executed successfully

AJAX.call(config, stopOnError) ⇒ void

Places an AJAX call

Kind: static method of AJAX

composables.Base

A base class that can be extended to provide common functionality

Kind: static class of composables
Properties

• .Base
  • new Base(config, defaults)
  • .configure(config) ⇒ boolean
  • .subscribe(eventNames) ⇒ boolean
  • .handleSubscriptions(eventName) ⇒ boolean

new Base(config, defaults)

Creates a new instance of the Base class

Base.configure(config) ⇒ boolean

Configures a class instance from a configuration object

Kind: static method of Base
Returns: boolean - Was the configuration successful?

Base.subscribe(eventNames) ⇒ boolean

Subscribes to one or more events using smize.events.subscribe

Kind: static method of Base
Returns: boolean - Were events successfully subscribed to?

Base.handleSubscriptions(eventName) ⇒ boolean

A handler method that delegates resolved subscriptions to the appropriate method

Kind: static abstract method of Base
Returns: boolean - Was the subscription event handled?

composables.Debug

A composable class that provides Debug functionality

Kind: static class of composables
Properties

• .Debug
  • new Debug(scope, config)
  • .error() ⇒ boolean
  • .formatMessage(methodName, message) ⇒ string
  • .info() ⇒ boolean
  • .matchesFilters(message) ⇒ boolean
  • .warn() ⇒ boolean
  • .write(writeArguments) ⇒ boolean

new Debug(scope, config)

Creates a new, scoped instance of the Debug class

Debug.error() ⇒ boolean

Writes an error log, accepting the same params as console.error

Kind: static method of Debug
Returns: boolean - Was the message logged?

Debug.formatMessage(methodName, message) ⇒ string

Formats a message string

Kind: static method of Debug
Returns: string - The formatted message or an empty string

Debug.info() ⇒ boolean

Writes an info log, accepting the same params as console.info

Kind: static method of Debug
Returns: boolean - Was the message logged?

Debug.matchesFilters(message) ⇒ boolean

Ensures a message matches any filters specified

Kind: static method of Debug
Returns: boolean - Did the message pass our filters?

Debug.warn() ⇒ boolean

Writes an warn log, accepting the same params as console.warn

Kind: static method of Debug
Returns: boolean - Was the message logged?

Debug.write(writeArguments) ⇒ boolean

Writes a log to the console if it is able to

Kind: static method of Debug
Returns: boolean - Was the message logged?

smize.data : object

Provides data-related utilities

Kind: static namespace of smize

• .data : object
  • .getCookies(cookieString) ⇒ object
  • .getLocalItem(itemName, defaultValue) ⇒ object
  • .getMetaKeys() ⇒ object
  • .getQueryKeys(queryString) ⇒ object
  • .getSessionItem(itemName, defaultValue) ⇒ object
  • .removeLocalItem(itemName) ⇒ boolean
  • .removeSessionItem(itemName) ⇒ boolean
  • .setLocalItem(itemName, value) ⇒ boolean
  • .setSessionItem(itemName, value) ⇒ boolean
  • .transferKeys(source, target, concatArrays, dedupeArrays) ⇒ boolean

data.getCookies(cookieString) ⇒ object

Retrieves cookies as key: value pairs

Kind: static method of data
Returns: object - A collection of keys

data.getLocalItem(itemName, defaultValue) ⇒ object

Retrieves an item from localStorage - type inferred from the default value

Kind: static method of data
Returns: object - The stored value, defaults to string

data.getMetaKeys() ⇒ object

Retrieves element values as key: value pairs

Kind: static method of data
Returns: object - A collection of keys

data.getQueryKeys(queryString) ⇒ object

Retrieves query string parameters as key: value pairs

Kind: static method of data
Returns: object - A collection of keys

data.getSessionItem(itemName, defaultValue) ⇒ object

Retrieves an item from sessionStorage - type inferred from the default value

Kind: static method of data
Returns: object - The stored value, defaults to a string

data.removeLocalItem(itemName) ⇒ boolean

Removes an item from localStorage if it exists

Kind: static method of data
Returns: boolean - Was the removal successful?

data.removeSessionItem(itemName) ⇒ boolean

Removes an item from sessionStorage if it exists

Kind: static method of data
Returns: boolean - Was the removal successful?

data.setLocalItem(itemName, value) ⇒ boolean

Creates or updates a localStorage item

Kind: static method of data
Returns: boolean - Was the update successful?

data.setSessionItem(itemName, value) ⇒ boolean

Creates or updates a sessionStorage item

Kind: static method of data
Returns: boolean - Was the update successful?

data.transferKeys(source, target, concatArrays, dedupeArrays) ⇒ boolean

Transfers key: value pairs between two objects

Kind: static method of data
Returns: boolean - Was the transfer successful?
Todo

• Explore object copying APIs to clean this logic up

smize.events : object

Provides utilities for publishing and subscribing to events

Kind: static namespace of smize

• .events : object
  • .debounce(originalFunction, executionDelay, callImmediately) ⇒ function
  • .publish(subscriptionName) ⇒ boolean
  • .subscribe(subscriptionName, subscriber) ⇒ boolean

events.debounce(originalFunction, executionDelay, callImmediately) ⇒ function

Debounces event calls to improve performance

Kind: static method of events
Returns: function - The debounced function or the original value

events.publish(subscriptionName) ⇒ boolean

Publishes information to all subscribers of a given subscription

Kind: static method of events
Returns: boolean - Was the subscription published?

events.subscribe(subscriptionName, subscriber) ⇒ boolean

Publishes information to all subscribers of a given subscription

Kind: static method of events
Returns: boolean - Did we successfully subscribe?

smize.html : object

Provides generic utilities for managing HTML nodes

Kind: static namespace of smize

• .html : object
  • .addClass(elements, classNames) ⇒ boolean
  • .getClasses(elements) ⇒ array
  • .hasClass(elements, classNames) ⇒ boolean
  • .isValidElement(element) ⇒ boolean
  • .nodeListToArray(elements) ⇒ array
  • .removeClass(elements, classNames) ⇒ boolean

html.addClass(elements, classNames) ⇒ boolean

Adds one or more CSS classes to one or more elements

Kind: static method of html
Returns: boolean - Was the operation successful?

html.getClasses(elements) ⇒ array

Returns an Array of all classes on one or more elements

Kind: static method of html
Returns: array - The classes found on the element(s)

html.hasClass(elements, classNames) ⇒ boolean

Checks that all elements have all CSS classes

Kind: static method of html
Returns: boolean - Do all elements have all classes?

html.isValidElement(element) ⇒ boolean

Verifies that one object is a valid HTML element

Kind: static method of html
Returns: boolean - Is this a valid element?

html.nodeListToArray(elements) ⇒ array

Creates an Array from an element or a NodeList

Kind: static method of html
Returns: array - An Array of one or more HTML elements

html.removeClass(elements, classNames) ⇒ boolean

Removes one or more CSS classes from one or more elements

Kind: static method of html
Returns: boolean - Was the operation successful?

smize.il8n : object

Provides utilities for localization and internationalization

Kind: static namespace of smize

• .il8n : object
  • .addDictionaryKey(dictionaryKey) ⇒ boolean
  • .addDictionaryKeys(dictionaryKeys) ⇒ boolean
  • .formatDate(date, language) ⇒ string
  • .formatDateString(dateString, language) ⇒ string
  • .formatNumber(numberValue, language, options) ⇒ string
  • .getKeyValue(dictionaryKeyName, language) ⇒ string
  • .setKeyValue(dictionaryKeyName, language, value) ⇒ boolean

il8n.addDictionaryKey(dictionaryKey) ⇒ boolean

Kind: static method of il8n
Returns: boolean - Was the key successfully added?

il8n.addDictionaryKeys(dictionaryKeys) ⇒ boolean

Adds a collection of dictionary keys to the DICTIONARY; key format (provide as many language/country values as needed): { "name": "A unique name for the dictionary key", "en": "A default English value; use ISO 639-1 values for the language code", "en-US": "The US English value; use IETF language tags" }

Kind: static method of il8n
Returns: boolean - Were the key successfully added?

il8n.formatDate(date, language) ⇒ string

Formats an instance of Date as a localized string for a given language

Kind: static method of il8n
Returns: string - The formatted date

il8n.formatDateString(dateString, language) ⇒ string

Formats a date string for a given language

Kind: static method of il8n
Returns: string - The formatted date or an empty string

il8n.formatNumber(numberValue, language, options) ⇒ string

Formats a number for display in a given language

Kind: static method of il8n
Returns: string - The formatted number or an empty string

il8n.getKeyValue(dictionaryKeyName, language) ⇒ string

Retrieves the localized value for the given dictionary key

Kind: static method of il8n
Returns: string - The dictionary key value or an empty string

il8n.setKeyValue(dictionaryKeyName, language, value) ⇒ boolean

Updates the value of a given dictionary key for the specified language

Kind: static method of il8n
Returns: boolean - Was the dictionary key updated?

smize.responsive : object

Provides utilities for handling responsive behavior

Kind: static namespace of smize

• .responsive : object
  • .currentBreakpoint
  • .addBreakpoint(breakpointName, breakpointSettings) ⇒ boolean
  • .addSubscriber(breakpointNames, subscriberFunction) ⇒ boolean
  • .bindEventHandlers() ⇒ boolean
  • .getBreakpoint(breakpointName) ⇒ object
  • .getCurrentBreakpoints(viewport) ⇒ Array
  • .getSubscriberCount(breakpointName) ⇒ number
  • .removeBreakpoint(breakpointName) ⇒ boolean

responsive.currentBreakpoint

Kind: static property of responsive
Properties

responsive.addBreakpoint(breakpointName, breakpointSettings) ⇒ boolean

Adds a breakpoint to handle specific screen information

Kind: static method of responsive
Returns: boolean - Was the named breakpoint added?

responsive.addSubscriber(breakpointNames, subscriberFunction) ⇒ boolean

Adds a subscriber to one or more breakpoints Consumers can subscribe individually without this method See: smize.events.subscribe

Kind: static method of responsive
Returns: boolean - Was the subscription successful?

responsive.bindEventHandlers() ⇒ boolean

Binds the responsive event handlers to manage breakpoints This is consumer-initialized to ensure additional breakpoints are added first

Kind: static method of responsive
Returns: boolean - Were the event handlers bound?

responsive.getBreakpoint(breakpointName) ⇒ object

Returns the named breakpoint

Kind: static method of responsive
Returns: object - The breakpoint

responsive.getCurrentBreakpoints(viewport) ⇒ Array

Returns all breakpoints that match the current viewport

Kind: static method of responsive
Returns: Array - A collection of matching viewports

responsive.getSubscriberCount(breakpointName) ⇒ number

Returns a count of subscribers for a given breakpoint

Kind: static method of responsive
Returns: number - The subscriber count for the breakpoint

responsive.removeBreakpoint(breakpointName) ⇒ boolean

Removes the given breakpoint from the list of breakpoints to handle

Kind: static method of responsive
Returns: boolean - Was the named breakpoint removed?

smize.ui : object

Provides helper methods and generic user interface classes to be extended

Kind: static namespace of smize

• .ui : object
  • .bindModule(element) ⇒ boolean
  • .bindScope(scope, deferSelector) ⇒ boolean
  • .registerModule(moduleName, ClassReference, defaultConfiguration) ⇒ boolean

ui.bindModule(element) ⇒ boolean

Determines which module to bind to an element and performs binding

Kind: static method of ui
Returns: boolean - Was the element successfully bound?

ui.bindScope(scope, deferSelector) ⇒ boolean

Binds all elements within the provided scope with the [data-module] attribute to the appropriate module

Kind: static method of ui
Returns: boolean - Was the scope successfully bound?

ui.registerModule(moduleName, ClassReference, defaultConfiguration) ⇒ boolean

Registers a module for binding

Kind: static method of ui
Returns: boolean - Was the module successfully registered?

smize.utils : object

Provides generic utilities

Kind: static namespace of smize

• .utils : object
  • .arrayFromArrayLike(arrayLike) ⇒ array
  • .objectFromString(string) ⇒ object
  • .replaceTokens(originalString, tokenSources, removeRemainder) ⇒ string
  • .resolveBits(bits, expectedType, root) ⇒ object
  • .stringFromObject(obj) ⇒ string

utils.arrayFromArrayLike(arrayLike) ⇒ array

Creates an array from an array-like, including comma-separated strings

Kind: static method of utils
Returns: array - An array created from the array-like

utils.objectFromString(string) ⇒ object

Attempts to parse a valid object from a string representation

Kind: static method of utils
Returns: object - The parsed object or null

utils.replaceTokens(originalString, tokenSources, removeRemainder) ⇒ string

Replaces tokens in the {token} format with key values from one or more objects

Kind: static method of utils
Returns: string - The new string with all tokens replaced

utils.resolveBits(bits, expectedType, root) ⇒ object

Traverses an object to resolve the dot-notated bits as nested items

Kind: static method of utils
Returns: object - The type-correct bit or null

utils.stringFromObject(obj) ⇒ string

Attempts to create a string representation of an object

Kind: static method of utils
Returns: string - The string representation of the object or ''

smize.valid : object

Provides generic utilities for validation

Kind: static namespace of smize

• .valid : object
  • .isDocumentValid() ⇒ boolean
  • .isFalsy(value) ⇒ boolean
  • .isOfType(value, checkType) ⇒ boolean
  • .isTruthy(value) ⇒ boolean
  • .isValidArray(value) ⇒ boolean
  • .isValidCountryCode(countryCode) ⇒ boolean
  • .isValidObject(value) ⇒ boolean
  • .isValidString(value) ⇒ boolean
  • .isWindowValid() ⇒ boolean
  • .validBoolean(value, defaultValue) ⇒ boolean
  • .validNumber(value, defaultValue) ⇒ number
  • .validObject(value, defaultValue) ⇒ object
  • .validString(value, defaultValue) ⇒ string

valid.isDocumentValid() ⇒ boolean

Determines if the document object is available

Kind: static method of valid
Returns: boolean - Is document valid?

valid.isFalsy(value) ⇒ boolean

Quickly determine if a value is falsy

Kind: static method of valid
Returns: boolean - Was the value falsy?

valid.isOfType(value, checkType) ⇒ boolean

Checks that an object is of the desired type

Kind: static method of valid
Returns: boolean - Is the value of the requested type?

valid.isTruthy(value) ⇒ boolean

Quickly determine if a value is truthy

Kind: static method of valid
Returns: boolean - Was the value truthy?

valid.isValidArray(value) ⇒ boolean

Determines if an object is an array-like

Kind: static method of valid
Returns: boolean - Is the value an array-like?

valid.isValidCountryCode(countryCode) ⇒ boolean

Determines if a value is a valid country code string

Kind: static method of valid
Returns: boolean - Was the input a valid country code?

valid.isValidObject(value) ⇒ boolean

Determines is of type 'object' and non-null

Kind: static method of valid
Returns: boolean - Is the value a valid object?

valid.isValidString(value) ⇒ boolean

Determines is of type 'string' and non-empty

Kind: static method of valid
Returns: boolean - Is the value a string?

valid.isWindowValid() ⇒ boolean

Determines if the window object is available

Kind: static method of valid
Returns: boolean - Is window valid?

valid.validBoolean(value, defaultValue) ⇒ boolean

Generates a valid boolean

Kind: static method of valid
Returns: boolean - The resulting boolean value

valid.validNumber(value, defaultValue) ⇒ number

Generates a valid number

Kind: static method of valid
Returns: number - The resulting number value
Todo

• Eliminate try/catch

valid.validObject(value, defaultValue) ⇒ object

Generates a valid object

Kind: static method of valid
Returns: object - The resulting object
Todo

• Eliminate try/catch

valid.validString(value, defaultValue) ⇒ string

Generates a valid string

Kind: static method of valid
Returns: string - The resulting string value

smize.ns(bitParts, root) ⇒ object

Builds a namespace with strict rules around extension

Kind: static method of smize
Returns: object - A namespace instance to extend