Interface ParameterReflection

interface ParameterReflection {
    flags: JSONOutput.ReflectionFlags;
    id: number;
    kind: ReflectionKind;
    name: string;
    variant: "param";
    comment?: JSONOutput.Comment;
    defaultValue?: string;
    type?:
        | JSONOutput.LiteralType
        | JSONOutput.UnknownType
        | JSONOutput.ReferenceType
        | JSONOutput.OptionalType
        | JSONOutput.ArrayType
        | JSONOutput.ConditionalType
        | JSONOutput.IndexedAccessType
        | JSONOutput.InferredType
        | JSONOutput.IntersectionType
        | JSONOutput.IntrinsicType
        | JSONOutput.MappedType
        | JSONOutput.PredicateType
        | JSONOutput.QueryType
        | JSONOutput.ReflectionType
        | JSONOutput.RestType
        | JSONOutput.TemplateLiteralType
        | JSONOutput.TupleType
        | NamedTupleMemberType
        | JSONOutput.TypeOperatorType
        | JSONOutput.UnionType;
}

Hierarchy

Omit<JSONOutput.Reflection, "variant">
S<Models.ParameterReflection, "variant" | "type" | "defaultValue">
- ParameterReflection

Index

Properties

flags id kind name variant comment? defaultValue? type?

Properties

flags

flags: JSONOutput.ReflectionFlags

id

id: number

Unique id of this reflection.

kind

kind: ReflectionKind

The kind of this reflection.

name

name: string

The symbol name of this reflection.

variant

variant: "param"

`Optional`comment

comment?: JSONOutput.Comment

The parsed documentation comment attached to this reflection.

`Optional`defaultValue

defaultValue?: string

`Optional`type

type?:
    | JSONOutput.LiteralType
    | JSONOutput.UnknownType
    | JSONOutput.ReferenceType
    | JSONOutput.OptionalType
    | JSONOutput.ArrayType
    | JSONOutput.ConditionalType
    | JSONOutput.IndexedAccessType
    | JSONOutput.InferredType
    | JSONOutput.IntersectionType
    | JSONOutput.IntrinsicType
    | JSONOutput.MappedType
    | JSONOutput.PredicateType
    | JSONOutput.QueryType
    | JSONOutput.ReflectionType
    | JSONOutput.RestType
    | JSONOutput.TemplateLiteralType
    | JSONOutput.TupleType
    | NamedTupleMemberType
    | JSONOutput.TypeOperatorType
    | JSONOutput.UnionType