lume/src/xyz-values/XYZSizeModeValues.ts

Build next-level interactive web applications.

import {XYZStringValues} from './XYZStringValues.js'

export type SizeModeValue = 'literal' | 'l' | 'proportional' | 'p'

/**
 * @class XYZSizeModeValues - Extends [`XYZValues`](./XYZValues) to enforce that
 * values are one of the strings `"literal"` or `"proportional"`.
 *
 * @extends XYZValues
 */
// TODO it would be cool if we can have compiletime type errors when the values
// aren't SizeModeValues. At the moment we'll get only runtime errors.
export class XYZSizeModeValues extends XYZStringValues {
	override get default() {
		return {x: 'literal', y: 'literal', z: 'literal'}
	}

	get allowedValues() {
		return ['literal', 'l', 'proportional', 'p']
	}

	override checkValue(prop: 'x' | 'y' | 'z', value: SizeModeValue) {
		if (!super.checkValue(prop, value)) return false
		if (!this.allowedValues.includes(value))
			throw new TypeError(
				`Expected ${prop} to be one of 'literal' ('l' for short) or 'proportional' ('p' for short). Received: '${value}'`,
			)
		return true
	}
}