Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Package

A package.

Hierarchy

Index

Properties

Properties

__button

__button: vscode.StatusBarItem

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

The optional status bar button.

__cache

__cache: CacheProvider

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

The cache for that item.

__id

__id: any

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the ID of that item.

__index

__index: number

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the zero-based of that item.

__searchValue

__searchValue: any

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

A value for comparison.

__workspace

__workspace: Workspace

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the underlying workspace.

Optional applyValuesTo

applyValuesTo: object

A list of property names and their values that should be applied to that object.

Type declaration

  • [prop: string]: any

Optional button

button: PackageButton | boolean | string

Deines a package button for the status bar.

Optional deployOnChange

deployOnChange: PackageDeploySettings

Settings for 'deploy on change' feature.

Optional deployOnSave

deployOnSave: PackageDeploySettings

Settings for 'deploy on save' feature.

Optional description

description: string

A description.

Optional exclude

exclude: string | string[]

One or more (glob) patterns that describes the files to EXCLUDE.

Optional fastCheckOnChange

fastCheckOnChange: boolean

Indicates if 'fast file check' should be used for 'deploy on change' in that package.

Optional fastCheckOnSave

fastCheckOnSave: boolean

Indicates if 'fast file check' should be used for 'deploy on save' in that package.

Optional fastCheckOnSync

fastCheckOnSync: boolean

Indicates if 'fast file check' should be used for 'sync when open' in that package.

Optional fastFileCheck

fastFileCheck: boolean

Default value for other, not-set "fast file check" settings.

Optional files

files: string | string[]

One or more (glob) patterns that describes the files to INCLUDE.

Optional git

git: PackageDeploySettingValue

Settings for importing files via git.

Optional if

if: string | string[]

One or more (JavaScript) conditions that check if that item is available or not.

Optional isHidden

isHidden: boolean

Is hidden or not.

Optional name

name: string

The name.

Optional pauseFilesFor

pauseFilesFor: number

The number of milliseconds to wait before an auto operation can be done for a file again.

Optional platforms

platforms: string | string[]

One or more platform names, the object is available for.

Optional removeOnChange

removeOnChange: PackageDeploySettings

Deletes a file of this package, if it has been deleted from a workspace.

Optional syncWhenOpen

syncWhenOpen: boolean | string | SyncWhenOpenSetting

Activates or deactivates "sync when open" feature for that package.

Optional targets

targets: string | string[]

One or more target.

Optional useFastGlob

useFastGlob: boolean

Use 'fast-glob' instead of 'node-glob' or not.

Generated using TypeDoc