Interface DecodedFunction

the decoded view of one function at one package version

interface DecodedFunction {
    callees: readonly BrandedIdentifier[];
    exported: boolean;
    file?: string;
    line: number;
    name: BrandedIdentifier;
    props: readonly string[];
    reexportOf?: string;
    signature: readonly SigParameter[];
    topic?: string;
}

Index

Properties

callees exported file? line name props reexportOf? signature topic?

Properties

`Readonly`callees

callees: readonly BrandedIdentifier[]

`Readonly`exported

exported: boolean

`Optional` `Readonly`file

file?: string

`Readonly`line

line: number

`Readonly`name

name: BrandedIdentifier

`Readonly`props

props: readonly string[]

`Optional` `Readonly`reexportOf

reexportOf?: string

the package this name is re-exported from, see SigFunctionInfo.reexportOf

`Readonly`signature

signature: readonly SigParameter[]

`Optional` `Readonly`topic

topic?: string

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