opacityValidator • tldraw Docs

A validator for opacity values.

This validator ensures that opacity values are numbers between 0 and 1 (inclusive). Values outside this range will cause a validation error. The validator provides runtime type checking for opacity properties throughout the editor.

opacityValidator: T.Validator<number>

Example

import { opacityValidator } from '@tldraw/tlschema'

// Valid opacity values
try {
  const validOpacity1 = opacityValidator.validate(0.5) // ✓
  const validOpacity2 = opacityValidator.validate(1.0) // ✓
  const validOpacity3 = opacityValidator.validate(0.0) // ✓
} catch (error) {
  console.error('Validation failed:', error.message)
}

// Invalid opacity values
try {
  opacityValidator.validate(-0.1) // ✗ Throws error
  opacityValidator.validate(1.5) // ✗ Throws error
} catch (error) {
  console.error('Invalid opacity:', error.message)
}

Parameters

Name	Description
`n`	The number to validate as an opacity value