type-enforcer/src/checks/isThickness.js

Type enforcement library for javascript

import Thickness from '../types/Thickness';
import { buildCustomTypeCheck } from './checks';

/**
 * Check if a value is a [Thickness](docs/Thickness.md)
 *
 * @example
 * ``` javascript
 * import { isThickness } from 'type-enforcer';
 *
 * isThickness(new Thickness());
 * // => true
 *
 * isThickness('12px 20px');
 * // => false
 *
 * isThickness('12px 20px', true);
 * // => true
 * ```
 *
 * @function isThickness
 *
 * @arg {*} value
 * @arg {Boolean} [coerce=false] - If true then see if the value can be coerced into a Thickness
 *
 * @returns {Boolean}
 */
export default buildCustomTypeCheck(Thickness);