Theia API Documentation v1.72.1
    Preparing search index...

    Interface ShellQuotingFunctions

    Functions that provide shell quoting capabilities.

    interface ShellQuotingFunctions {
        characters: {
            escape?: string;
            needQuotes?: string;
            strong?: string;
            weak?: string;
        };
        escape?(this: any, arg: string): string;
        strong?(this: any, arg: string): string;
        weak?(this: any, arg: string): string;
    }
    Index

    Properties

    characters

    Methods

    escape? strong? weak?

    Properties

    characters: {
        escape?: string;
        needQuotes?: string;
        strong?: string;
        weak?: string;
    }

    Type Declaration

    • Optionalescape?: string

      The character used to escape sequences.

    • OptionalneedQuotes?: string

      Characters that require quotes, white space is always implied.

    • Optionalstrong?: string

      The character used to quote sequences, preventing variable expansion.

    • Optionalweak?: string

      The character used to quote sequences, allowing variable expansion.

    Methods

    • Should add escape-characters in front of forbidden characters.

      Parameters

      • this: any
      • arg: string

      Returns string

    • Should quote the argument in such a way that variables CANNOT be expanded.

      Parameters

      • this: any
      • arg: string

      Returns string

    • Should quote the argument in such a way that variables CAN be expanded.

      Parameters

      • this: any
      • arg: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods