axe-core/lib/core/utils/check-helper.js

Accessibility engine for automated Web UI testing

import toArray from './to-array';
import DqElement from './dq-element';

/**
 * Helper to denote which checks are asyncronous and provide callbacks and pass data back to the CheckResult
 * @param  {CheckResult}   checkResult The target object
 * @param  {Function} callback    The callback to expose when `this.async()` is called
 * @return {Object}               Bound to `this` for a check's fn
 */
function checkHelper(checkResult, options, resolve, reject) {
  return {
    isAsync: false,
    async() {
      this.isAsync = true;
      return result => {
        if (result instanceof Error === false) {
          checkResult.result = result;
          resolve(checkResult);
        } else {
          reject(result);
        }
      };
    },
    data(data) {
      checkResult.data = data;
    },
    relatedNodes(nodes) {
      nodes = nodes instanceof window.Node ? [nodes] : toArray(nodes);
      checkResult.relatedNodes = nodes.map(element => {
        return new DqElement(element, options);
      });
    }
  };
}

export default checkHelper;