@maverick-js/compiler/dist/types/analyze/meta/component.d.ts

Maverick toolchain including the analyzer and compiler.

import type ts from 'typescript';
export declare const TS_NODE: unique symbol;
export type TypeMeta = string;
export interface PropMeta {
    [TS_NODE]: ts.Node;
    name: string;
    type: TypeMeta;
    default?: string;
    docs?: string;
    doctags?: DocTagMeta[];
    required?: boolean;
    readonly?: boolean;
    attribute?: string;
    reflect?: boolean;
    internal?: boolean;
    deprecated?: boolean;
}
export interface ParameterMeta {
    [TS_NODE]?: ts.Node;
    name: string;
    type: TypeMeta;
    default?: string;
    optional?: boolean;
}
export interface MethodMeta {
    [TS_NODE]: ts.Node;
    name: string;
    parameters: ParameterMeta[];
    signature: {
        [TS_NODE]?: ts.Signature;
        type: string;
    };
    return: {
        [TS_NODE]?: ts.Type;
        type: string;
    };
    docs?: string;
    doctags?: DocTagMeta[];
    internal?: boolean;
    deprecated?: boolean;
}
export interface EventMeta {
    [TS_NODE]: ts.Node;
    name: string;
    type: TypeMeta;
    detail: string;
    docs?: string;
    doctags?: DocTagMeta[];
    bubbles?: boolean;
    composed?: boolean;
    cancellable?: boolean;
    internal?: boolean;
    deprecated?: boolean;
}
export interface CSSVarMeta {
    [TS_NODE]: ts.Node;
    name: string;
    default?: string;
    docs?: string;
    type?: TypeMeta;
    doctags?: DocTagMeta[];
    required?: boolean;
    readonly?: boolean;
    optional?: boolean;
    internal?: boolean;
    deprecated?: boolean;
}
export interface CSSPartMeta {
    [TS_NODE]: ts.Node;
    name: string;
    docs?: string;
}
export interface SlotMeta {
    [TS_NODE]: ts.Node;
    name?: string;
    docs?: string;
}
export interface StoreMeta {
    [TS_NODE]: ts.Node;
    factory: string;
    record: string;
}
export interface DocTagMeta {
    [TS_NODE]: ts.Node;
    name: string;
    text?: string;
}
export interface FileMeta {
    [TS_NODE]: ts.SourceFile;
    path: string;
}
export interface TagMeta {
    [TS_NODE]: ts.Node;
    name: string;
}
export interface MembersMeta {
    props?: PropMeta[];
    methods?: MethodMeta[];
    length: number;
}
export interface DefinitionMeta {
    [TS_NODE]: ts.ObjectLiteralExpression;
}
export interface ComponentMeta extends Record<string, unknown> {
    [TS_NODE]: ts.Node;
    file: FileMeta;
    name: string;
    tag: TagMeta;
    definition: DefinitionMeta;
    shadow?: boolean;
    docs?: string;
    doctags?: DocTagMeta[];
    props?: PropMeta[];
    events?: EventMeta[];
    cssvars?: CSSVarMeta[];
    cssparts?: CSSPartMeta[];
    slots?: SlotMeta[];
    members?: MembersMeta;
    store?: StoreMeta;
}