Interface MethodReturnData

Data for a method's return type in MethodData#returns.

interface MethodReturnData {
    description: null | NodeContent;
    entityType: "methodReturn";
    type: string;
}

Hierarchy

Omit<CommonEntityData<typeof MethodReturn>, "name" | "signature" | "id">
- MethodReturnData

Index

Properties

description entityType type

Properties

description

description: null | NodeContent

The entity's description, if any.

entityType

entityType: "methodReturn"

The entity's type.

type

type: string

The return type.