lazy-widgets/dist/decorators/FlagFields.d.ts

Typescript retained mode GUI for the HTML canvas API

/**
 * A decorator for a public field which sets calls a callback if the property's
 * value is changed.
 *
 * @typeParam V - The type of the field being watched
 * @param callback - The callback to call if the value changes. `this` is bound.
 * @category Decorator
 */
export declare function watchField<V>(callback: (oldValue: V) => void): PropertyDecorator;
/**
 * A {@link watchField} which sets a given flag to true.
 *
 * @param flagKey - The key of the flag property to set to true
 * @category Decorator
 */
export declare function flagField(flagKey: string | symbol): PropertyDecorator;
/**
 * A {@link watchField} which calls a method named `markWholeAsDirty` with no
 * arguments. It's recommended to only use this on {@link Widget} and its
 * subclasses, although technically you can use it in any class so long as it
 * has a `markWholeAsDirty` method.
 *
 * @category Decorator
 */
export declare const damageField: PropertyDecorator;
/**
 * A {@link flagField} where the flag key is `_layoutDirty`.
 *
 * @category Decorator
 */
export declare const layoutField: PropertyDecorator;
/**
 * A {@link watchField} which sets a given array of flags to true.
 *
 * @param flagKeys - An array containing the keys of each flag property to set to true
 * @category Decorator
 */
export declare function multiFlagField(flagKeys: Array<string | symbol>): PropertyDecorator;
/**
 * Similar to {@link watchField}, but for array fields, like tuples. Getting the
 * property returns a shallow copy of the tuple, setting the value uses a
 * shallow copy of the input value if the current value is not an array. If both
 * the new value and the current value are arrays, then the current value's
 * members are updated; no shallow copy is created.
 *
 * @param callback - The callback to call if the value changes. `this` is bound.
 * @param allowNonArrays - Allow values which are not arrays to be used?
 * @category Decorator
 */
export declare function watchArrayField(callback: () => void, allowNonArrays?: boolean): PropertyDecorator;
/**
 * A {@link watchArrayField} which sets a given flag to true.
 *
 * @param flagKey - The key of the flag property to set to true
 * @param allowNonArrays - Allow values which are not arrays to be used?
 * @category Decorator
 */
export declare function flagArrayField(flagKey: string, allowNonArrays?: boolean): PropertyDecorator;
/**
 * A mix between {@link damageField} and {@link watchArrayField}.
 *
 * @param allowNonArrays - Allow values which are not arrays to be used?
 * @category Decorator
 */
export declare function damageArrayField(allowNonArrays?: boolean): PropertyDecorator;
/**
 * A {@link flagArrayField} where the flag key is `_layoutDirty`.
 *
 * @param allowNonArrays - Allow values which are not arrays to be used?
 * @category Decorator
 */
export declare function layoutArrayField(allowNonArrays?: boolean): PropertyDecorator;
/**
 * A {@link watchArrayField} which sets a given array of flags to true.
 *
 * @param flagKeys - An array containing the keys of each flag property to set to true
 * @param allowNonArrays - Allow values which are not arrays to be used?
 * @category Decorator
 */
export declare function multiFlagArrayField(flagKeys: Array<string>, allowNonArrays?: boolean): PropertyDecorator;
/**
 * A {@link watchArrayField} where the '_layoutDirty' flag is set, and a damage
 * method is called in the same way as {@link damageField}.
 *
 * @param allowNonArrays - Allow values which are not arrays to be used?
 * @category Decorator
 */
export declare function damageLayoutArrayField(allowNonArrays?: boolean): PropertyDecorator;
/**
 * A decorator for a public field which is an alias for another field.
 *
 * @param fieldName - The name of the field to create an alias for.
 * @category Decorator
 */
export declare function accessorAlias(fieldName: string | symbol): PropertyDecorator;