Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "packages"

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

PackageDeploySettingValue

PackageDeploySettingValue: string | PackageGitSettings

Possible git setting values for a package.

PackageDeploySettings

PackageDeploySettings: boolean | string | string[] | PackageDeployFileFilter

Types of a package deploy setting value.

PackageDeploySettingsResolver

PackageDeploySettingsResolver: function

A function that resolves deploy settings for a package.

param

The underlying package.

returns

The result with the settings.

Type declaration

PackageFastFileCheckFlagResolver

PackageFastFileCheckFlagResolver: function

A function that resolves the package flag, which indicates, if a "fast file check" should be made or not.

param

The underlying package.

returns

The result with the flag.

Type declaration

    • (pkg: Package): boolean | PromiseLike<boolean>

    • Parameters

      Returns boolean | PromiseLike<boolean>

PackageFileListResolver

PackageFileListResolver: function

Type declaration

PackageFileListResolverResult

PackageFileListResolverResult: string | string[]

Possible results of a package file list resolver.

PrepareForPackage

PrepareForPackage: function

A function that should be invoked to prepare something for a package.

param

underlying package.

Type declaration

    • (pkg: Package): void | PromiseLike<void>

    • Parameters

      Returns void | PromiseLike<void>

Variables

Const AUTO_DEPLOY_STATES

AUTO_DEPLOY_STATES: deploy_contracts.KeyValuePairs<Target>

Const KEY_PACKAGE_USAGE

KEY_PACKAGE_USAGE: "vscdrLastExecutedPackageActions" = "vscdrLastExecutedPackageActions"

Const KEY_PAUSE_FILES_FOR

KEY_PAUSE_FILES_FOR: "pauseFilesFor" = "pauseFilesFor"

The name of a key for 'pauseFilesFor' data.

Functions

autoDeployFile

findTargetsForFileOfPackage

getAllPackagesSorted

  • getAllPackagesSorted(): Package[]

  • Returns a sorted list of all available packages of all opened workspaces.

    Returns Package[]

    The list of all sorted packages.

getFastFileCheckFlag

  • getFastFileCheckFlag<TObj, TParentObj>(obj: TObj, flagResolver: function, parentObj: TParentObj, parentFlagResolver: function): boolean

  • Detects a "fast file check" flag value.

    Type parameters

    Parameters

    • obj: TObj

      The child object.

    • flagResolver: function

      The function that detects the flag value from the child object.

        • (o: TObj): boolean

        • Parameters

          • o: TObj

          Returns boolean

    • parentObj: TParentObj

      The parent object.

    • parentFlagResolver: function

      The function that detects the flag value from the parent object.

        • (po: TParentObj): boolean

        • Parameters

          • po: TParentObj

          Returns boolean

    Returns boolean

    The detected flag.

getPackageName

  • getPackageName(pkg: Package): string

  • Returns the name for a package.

    Parameters

    Returns string

    The name.

getPauseFilesForValue

  • getPauseFilesForValue(pkg: Package, currentValue: number): number

  • Returns the (next) 'pauseFilesFor' value by a package.

    Parameters

    • pkg: Package

      The current package.

    • currentValue: number

      The current value.

    Returns number

    The new value.

getTargetsOfPackage

  • getTargetsOfPackage(pkg: Package, targetResolver: deploy_targets.TargetResolver): Target[] | false

  • Returns the targets of a package.

    Parameters

    • pkg: Package

      The package.

    • targetResolver: deploy_targets.TargetResolver

      A function to receive optional targets.

    Returns Target[] | false

    The targets or (false) if at least one target could not be found.

importPackageFilesFromGit

  • Import files from git to a package.

    Parameters

    Returns Promise<string[]>

    The promise with the new list.

invokeForAutoTargetOperation

  • invokeForAutoTargetOperation(target: Target, action: function): Promise<void>

preparePackageForFileFilter

  • preparePackageForFileFilter<TPackage>(pkg: TPackage): TPackage

  • Prepares a package for use as file filter.

    Type parameters

    Parameters

    • pkg: TPackage

      The package to prepare.

    Returns TPackage

    The prepared package.

removeOnChange

  • removeOnChange(file: string): Promise<void>

  • Handles a file for "remove on change" feature.

    Parameters

    • file: string

      The file to check.

    Returns Promise<void>

resetPackageUsage

  • resetPackageUsage(context: vscode.ExtensionContext): void

  • Resets the package usage statistics.

    Parameters

    • context: vscode.ExtensionContext

      The extension context.

    Returns void

showPackageQuickPick

  • showPackageQuickPick(context: vscode.ExtensionContext, packages: Package | Package[], opts?: vscode.QuickPickOptions): Promise<Package | false>

  • Shows a quick pick for a list of packages.

    Parameters

    • context: vscode.ExtensionContext

      The extension context.

    • packages: Package | Package[]

      One or more packages.

    • Optional opts: vscode.QuickPickOptions

    Returns Promise<Package | false>

    The promise that contains the selected package (if selected) or (false) if no package is available.

waitForOtherAutoTargetOperations

  • waitForOtherAutoTargetOperations(target: Target): Promise<void>

Generated using TypeDoc