TypeDoc API - v0.28.2

    Interface ParameterReflection

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

    Hierarchy

    Index

    Properties

    Unique id of this reflection.

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    variant: "param"

    The parsed documentation comment attached to this reflection.

    defaultValue?: string
    MMNEPVFCICPMFPCPTTAAATR