Interface SigFunctionInfo

interface SigFunctionInfo {
    callees: readonly string[];
    file?: string;
    line?: number;
    name: string;
    params: readonly SigParamInfo[];
    props: number;
    topic?: string;
}

Index

Properties

callees file? line? name params props topic?

Properties

`Readonly`callees

callees: readonly string[]

named callees (order/duplication irrelevant; deduped + sorted internally)

`Optional` `Readonly`file

file?: string

`Optional` `Readonly`line

line?: number

`Readonly`name

name: string

`Readonly`params

params: readonly SigParamInfo[]

`Readonly`props

props: number

bitfield of FnProp (must set FnProp.Exported for exported functions)

`Optional` `Readonly`topic

topic?: string

the Rd help topic (man-page name) documenting this function, when it differs from name

Interface SigFunctionInfo

Index

Properties

Properties

`Readonly`callees

`Optional` `Readonly`file

`Optional` `Readonly`line

`Readonly`name

`Readonly`params

`Readonly`props

`Optional` `Readonly`topic

Settings

On This Page

Interface SigFunctionInfo

Index

Properties

Properties

Readonlycallees

Optional Readonlyfile

Optional Readonlyline

Readonlyname

Readonlyparams

Readonlyprops

Optional Readonlytopic

Settings

On This Page

`Readonly`callees

`Optional` `Readonly`file

`Optional` `Readonly`line

`Readonly`name

`Readonly`params

`Readonly`props

`Optional` `Readonly`topic