PhetioProperty¶

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/axon/blob/main/js/PhetioProperty.ts for the most up-to-date information.

Overview¶

@author Michael Kauzmann (PhET Interactive Simulations)

Type PhetioProperty¶

When calling PhetioObject.addLinkedElement, the parameter must be a PhetioObject, so this type alias covers that ground and helps with cases like LocalizedStringProperty (and DynamicProperty in general) which satisfies the TProperty interface and is a PhetioObject. It is best to try to use the ReadOnlyProperty class hierarchy first, and this Type Alias can help cover cases where that doesn't work, see https://github.com/phetsims/tandem/issues/299

import type { PhetioProperty } from 'scenerystack/axon';

TProperty<T> & PhetioObject

Source Code¶

See the source for PhetioProperty.ts in the axon repository.