ce-decorators/lib/propertyoptions.d.ts

Custom Element decorators for typescript

/**
 * Copyright (c) 2018 Mathis Zeiher
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
/**
 * PropertyType
 */
export declare type PropertyType = Function | RegExp | Boolean | Number | String | Object | Array<any>;
/**
 * to attribute converter type
 */
export declare type FromAttributeConverter = (value: unknown, type: PropertyType) => string;
/**
 * property converter
 */
export interface AttributePropConverter {
    fromAttribute: (value: unknown, type: PropertyType) => unknown;
    toAttribute: FromAttributeConverter;
}
/**
 * Custom converter
 */
export declare type ConverterType = FromAttributeConverter | AttributePropConverter;
/**
 * PropertyOptions
 */
export interface PropertyOptions {
    type?: PropertyType;
    reflectAsAttribute?: boolean;
    converter?: ConverterType;
}