type-enforcer/src/methods/types/methodThickness.js

Type enforcement library for javascript

import isThickness from '../../checks/isThickness';
import enforceThickness from '../../enforcer/types/enforceThickness';
import Thickness from '../../types/Thickness';
import { buildMethod, compareCustomType, mapEnforcerDefaultCoerceTrue } from './methodAny';

/**
 * Builds a chainable method for getting/setting a [Thickness](docs/Thickness.md)
 *
 * @function method.thickness
 * @extends method.any
 *
 * @arg {Object} [options] - Same as {@link method.any} with the following differences:
 * @arg {Function} [options.enforce=enforce.thickness]
 * @arg {Function} [options.compare=Thickness.isSame]
 * @arg {Boolean} [options.coerce=true] - If false then don't coerce the value
 *
 * @returns {Function}
 */
export default buildMethod({
	enforce: mapEnforcerDefaultCoerceTrue(enforceThickness),
	compare: compareCustomType(Thickness, isThickness)
});