@strapi/types/dist/schema/attribute/definitions/component.d.ts

Shared typescript types for Strapi internal use

import type * as Data from '../../../data';
import type * as UID from '../../../uid';
import type { Constants, If, Intersect } from '../../../utils';
import type { Attribute } from '../..';
export interface ComponentProperties<TComponentUID extends UID.Component, TRepeatable extends Constants.BooleanValue = Constants.False> {
    component: TComponentUID;
    repeatable?: TRepeatable;
}
/**
 * Represents a component Strapi attribute along with its options
 */
export type Component<TComponentUID extends UID.Component = UID.Component, TRepeatable extends Constants.BooleanValue = Constants.False> = Intersect<[
    Attribute.OfType<'component'>,
    ComponentProperties<TComponentUID, TRepeatable>,
    Attribute.ConfigurableOption,
    Attribute.MinMaxOption,
    Attribute.PrivateOption,
    Attribute.RequiredOption,
    Attribute.WritableOption,
    Attribute.VisibleOption
]>;
export type ComponentValue<TComponentUID extends UID.Component, TRepeatable extends Constants.BooleanValue> = Data.Component<TComponentUID> extends infer TComponentEntry ? If<TRepeatable, TComponentEntry[], TComponentEntry> : never;
export type GetComponentValue<TAttribute extends Attribute.Attribute> = TAttribute extends Component<infer TComponentUID, infer TRepeatable> ? ComponentValue<TComponentUID, TRepeatable> : never;
export type ComponentTarget<TAttribute extends Attribute.Attribute> = TAttribute extends Component<infer TComponentUID, Constants.BooleanValue> ? TComponentUID : never;
//# sourceMappingURL=component.d.ts.map