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

    Interface AbsoluteFilePathConfig

    interface AbsoluteFilePathConfig {
        absolutePathRegex: string | undefined;
        additionalPathFunctions: FunctionInfo[];
        ignoreUrls: boolean;
        include: { allStrings: boolean; constructed: boolean };
        useAsWd: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown

    Hierarchy-Diagram

    UML class diagram of AbsoluteFilePathConfig
    Index

    Properties

    absolutePathRegex additionalPathFunctions ignoreUrls include useAsWd

    Properties

    absolutePathRegex: string | undefined

    Extend the built-in absolute path recognition with additional regexes

    additionalPathFunctions: FunctionInfo[]

    The set of functions that should additionally be considered as using a file path. Entries in this array use the FunctionInfo format from the dependencies query.

    ignoreUrls: boolean

    Automatically ignore URLs (http/https/ftp) so they are not reported as absolute paths.

    include: { allStrings: boolean; constructed: boolean }

    Include paths that are built by functions, e.g., file.path()

    Type Declaration

    • allStrings: boolean

      Include every string, even if it is not used as a file path, to count, strings must have a length of at least 3 chars

    • constructed: boolean

      Whether to include paths that are constructed by functions

    useAsWd: string

    Which path the relative-path quick fix is built against: @project (project root, falling back to the script when there is no root), @script, @home, or a literal directory.

    Settings

    Member Visibility

    On This Page

    Properties