@eagleoutice/flowr - v2.10.2
    Preparing search index...

    Interface FunctionInfo

    Describes a function that may create a dependency

    interface FunctionInfo {
        additionalArgs?: Record<string, FunctionArgInfo>;
        argIdx?: number | "unnamed";
        argName?: string;
        defaultValue?: string;
        ignoreIf?:
            | "arg-missing"
            | "mode-only-read"
            | "mode-only-write"
            | "arg-true"
            | "arg-false";
        linkTo?: DependencyInfoLink[];
        name: string;
        package?: string;
        resolveValue?: boolean
        | "library";
    }

    Hierarchy (View Summary)

    Hierarchy-Diagram

    UML class diagram of FunctionInfo
    Index

    Properties

    additionalArgs? argIdx? argName? defaultValue? ignoreIf? linkTo? name package? resolveValue?

    Properties

    additionalArgs?: Record<string, FunctionArgInfo>

    additional info on arguments - e.g. for the mode flag

    argIdx?: number | "unnamed"

    the index if the argument can be positional, unnamed in case of something like ..., if the argument must be given with the name, please leave undefined

    argName?: string
    defaultValue?: string

    default value for the argument if no binding value is found, please be aware, that categories can define global defaults, these are overwritten by the per-function defaults

    ignoreIf?:
        | "arg-missing"
        | "mode-only-read"
        | "mode-only-write"
        | "arg-true"
        | "arg-false"

    the function is not to be counted as a dependency if the argument is missing

    linkTo?: DependencyInfoLink[]

    links to other function calls to get the dependency from there (e.g., with sink for print)

    name: string

    The name of the function

    package?: string

    Which package does the function belong to

    resolveValue?: boolean | "library"

    Settings

    Member Visibility

    On This Page

    Properties