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

    Interface LibraryFunctionInfo

    A loader of the library category, together with whether it attaches the package it names.

    LibraryFunctions

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

    Hierarchy (View Summary)

    Index
    additionalArgs? argIdx? argName? attaches defaultValue? ignoreIf? linkTo? name package? resolveValue? stringReplacements?
    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
    attaches: boolean

    Whether the call makes the package's exports reachable by their bare name, which is what tells a package that is loaded and used apart from one that is loaded and never touched. false for a loader that only readies a namespace to reach as pkg::fn, and for one whose argument is not a package at all.

    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"
        | "arg-set"

    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"
    stringReplacements?: Record<string, string>

    string replacements to apply to resolved values, e.g. { '': 'stdin' }

    Settings
    Member Visibility

    On This Page
    Properties