const: always

description: Retry on any failure (default).

description: Retry when the failure reason is unknown.

description: Retry when the script failed.

description: Retry on API failure.

description: Retry when the job got stuck or timed out.

description: Retry if there is a runner system failure (for example, job setup failed).

description: Retry if the runner is unsupported.

description: Retry if a delayed job could not be executed.

description: Retry if the script exceeded the maximum execution time set for the job.

description: Retry if the job is archived and can’t be run.

description: Retry if the job failed to complete prerequisite tasks.

description: Retry if the scheduler failed to assign the job to a runner.

description: Retry if there is a structural integrity problem detected.


markdownDescription: Specifies lists of commands to execute on the runner at certain stages of job execution. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#hooks).

type: object

type: string

type: array

markdownDescription: Specifies a list of commands to execute on the runner before updating the Git repository and any submodules. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#hookspre_get_sources_script).

key: hooks


description: Full name of the image that should be used. It should contain the Registry part if needed.

description: Command or script that should be executed as the container's entrypoint. It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.

default: always

enum: always never if-not-present

markdownDescription: Specifies how to pull the image in Runner. It can be one of `always`, `never` or `if-not-present`. The default value is `always`. [Learn more](https://docs.gitlab.com/ee/ci/yaml/#imagepull_policy).

markdownDescription: Specifies the docker image to use for the job or globally for all jobs. Job configuration takes precedence over global setting. Requires a certain kind of Gitlab runner executor. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#image).

key: image


type: string number array

description: Defines the variables for a specific job.

description: Defines different variables for jobs that are running in parallel.

description: Use the `needs:parallel:matrix` keyword to specify parallelized jobs needed to be completed for the job to run. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#needsparallelmatrix)


markdownDescription: Interruptible is used to indicate that a job should be canceled if made redundant by a newer pipeline run. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#interruptible).

type: boolean

key: interruptible


markdownDescription: Expression to evaluate whether additional attributes should be provided to the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#rulesif).

key: if


markdownDescription: Use `cache` to specify a list of files and directories to cache between jobs. You can only use paths that are in the local working copy. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cache)

markdownDescription: Use the `cache:paths` keyword to choose which files or directories to cache. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachepaths)

markdownDescription: List of keys to download cache from if no cache hit occurred for key

markdownDescription: Defines when to save the cache, based on the status of the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachewhen).

markdownDescription: Use `untracked: true` to cache all files that are untracked in your Git repository. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cacheuntracked)

markdownDescription: Use the `cache:key:files` keyword to generate a new key when one or two specific files change. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachekeyfiles)

markdownDescription: Use `cache:key:prefix` to combine a prefix with the SHA computed for `cache:key:files`. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachekeyprefix)

markdownDescription: Use the `cache:key` keyword to give each cache a unique identifying key. All jobs that use the same cache key use the same cache, including in different pipelines. Must be used with `cache:path`, or nothing is cached. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachekey).

markdownDescription: Use `unprotect: true` to set a cache to be shared between protected and unprotected branches.

default: pull-push

markdownDescription: Determines the strategy for downloading and updating the cache. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachepolicy)

key: cache


enum: on_success on_failure always never manual delayed

markdownDescription: Describes the conditions for when to run the job. Defaults to 'on_success'. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#when).

key: when


type: integer

description: Creates N instances of the job that run in parallel.

description: Splits up a single job into multiple that run in parallel. Provides `CI_NODE_INDEX` and `CI_NODE_TOTAL` environment variables to the jobs.

key: parallel


description: When a branch is pushed.

description: When a tag is pushed.

description: When a pipeline has been triggered by a second pipelines API (not triggers API).

description: When using CI services other than Gitlab

description: For multi-project triggers, created using the API with 'CI_JOB_TOKEN'.

description: Pipeline is triggered by a `git push` by the user

description: For scheduled pipelines.

description: For pipelines created using a trigger token.

description: For pipelines created using *Run pipeline* button in Gitlab UI (under your project's *Pipelines*).

description: String or regular expression to match against tag or branch names.

description: Filter job by different keywords that determine origin or state, or by supplying string/regex to check against branch/tag names.


markdownDescription: Defines scripts that should run *after* the job. Can be set globally or per job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#after_script).


type: string number

markdownDescription: If the variable is expandable or not. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesexpand).

markdownDescription: A list of predefined values that users can select from in the **Run pipeline** page when running a pipeline manually. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesoptions)

markdownDescription: Default value of the variable. If used with `options`, `value` must be included in the array. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesvalue)

markdownDescription: Explains what the variable is used for, what the acceptable values are. Variables with `description` are prefilled when running a pipeline manually. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesdescription).

markdownDescription: Defines default variables for all jobs. Job level property overrides global variables. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variables).

key: globalVariables


markdownDescription: Used to pass input values to included templates or components. [Learn More](https://docs.gitlab.com/ee/ci/yaml/includes.html#set-input-parameter-values-with-includeinputs).

key: inputs


markdownDescription: Allows you to configure a timeout for a specific job (e.g. `1 minute`, `1h 30m 12s`). [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#timeout).

key: timeout


markdownDescription: Used in conjunction with 'when: delayed' to set how long to delay before starting a job. e.g. '5', 5 seconds, 30 minutes, 1 week, etc. [Learn More](https://docs.gitlab.com/ee/ci/jobs/job_control.html#run-a-job-after-a-delay).


markdownDescription: Used to select runners from the list of available runners. A runner must have all tags listed here to run the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#tags).

key: tags


description: Setting this option to true will allow the job to fail while still letting the pipeline pass.

description: Exit code that are not considered failure. The job fails for any other exit code.

description: You can list which exit codes are not considered failures. The job fails for any other exit code.

markdownDescription: Allow job to fail. A failed job does not cause the pipeline to fail. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#allow_failure).


markdownDescription: Defines if the variable is expandable or not. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesexpand).

markdownDescription: Defines variables for a job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variables).

key: jobVariables


markdownDescription: Defines the pipeline name. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#workflowname).

key: workflowName


markdownDescription: Defines secrets to be injected as environment variables. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#secrets).

markdownDescription: The secret to be fetched from Vault (e.g. 'production/db/password@ops' translates to secret 'ops/data/production/db', field `password`). [Learn More](https://docs.gitlab.com/ee/ci/yaml/#secretsvault)

required: engine path field

required: name path

description: Specifies the JWT variable that should be used to authenticate with Hashicorp Vault.

markdownDescription: Configures the secret to be stored as either a file or variable type CI/CD variable. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#secretsfile)

key: secrets


description: The number of times the job will be retried if it fails. Defaults to 0 and can max be retried 2 times (3 times total).


markdownDescription: Use needs in rules to update job needs for specific conditions. When a condition matches a rule, the job's needs configuration is completely replaced with the needs in the rule. [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#rulesneeds).

description: Download artifacts of the job in needs.

description: Name of a job that is defined in the pipeline.

description: Whether the job needs to be present in the pipeline to run ahead of the current job.

key: rulesNeeds


markdownDescription: Defines variables for a rule result. [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#rulesvariables).

key: rulesVariables


markdownDescription: Defines JWTs to be injected as environment variables.


description: List of file paths.

description: Ref for comparing changes.

markdownDescription: Additional attributes will be provided to job if any of the provided paths matches a modified file. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#ruleschanges).

key: changes


description: A JSON Pointer path.

key: path


description: Console command name

title: Command name

key: commands


description: CVar name

title: Variable name

key: cvars


required: Key Operator Value Effect TolerationSeconds

key: Toleration


description: URL is the url to open in the browser after it is available

description: OpenConfig defines what to open after services have been started

key: OpenConfig


description:
The username of the registry. If this is empty, devspace will try
to receive the auth data from the local docker

description: Name is the pull secret name to deploy

description: The secret to create

description:
The registry to create the image pull secret for.
Empty string == docker hub
e.g. gcr.io

description: The service account to add the secret to

description:
The password to use for the registry. If this is empty, devspace will
try to receive the auth data from the local docker

description: The optional email to use

description: PullSecretConfig defines a pull secret that should be created by DevSpace

key: PullSecretConfig


description: Default is the default value for this flag

description: Short is optional and is the shorthand name for this flag. E.g. 'g' converts to '-g'

enum: bool int string stringArray

description: Type is the type of the flag. Defaults to `bool`

description: Name is the name of the flag

description: Description is the description as shown in `devspace run-pipeline my-pipe -h`

description: PipelineFlag defines an extra pipeline flag

key: PipelineFlag


description: WorkDir is the working directory that is used to execute the command in.

description:
DisableScreen will disable screen which is used by DevSpace by default to preserve
sessions if connections interrupt or the session is lost.

description:
If enabled is true, DevSpace will use the terminal. Can be also
used to disable the terminal if set to false. DevSpace makes sure
that within a pipeline only one dev configuration can open a terminal
at a time and subsequent dev terminals will fail.

description:
DisableReplace tells DevSpace to not replace the pod or adjust its settings
to make sure the pod is sleeping when opening a terminal

description:
Command is the command that should be executed on terminal start.
This command is executed within a shell.

description: DisableTTY will disable a tty shell for terminal command execution

description: Terminal describes the terminal options

key: Terminal


description:
DisableReplace prevents DevSpace from actually replacing the pod with modifications so that
the pod starts up correctly.

description: Enabled can be used to enable attaching to a container

description: DisableTTY is used to tell DevSpace to not use a TTY connection for attaching

key: Attach


group: git

description:
Git is the remote repository to download the artifact from. You can either use
https projects or ssh projects here, but need to make sure git can pull the project.
This option is mutually exclusive with the path option.

group_name: Source: Git Repository

description:
DisableShallow can be used to turn off shallow clones as these are the default used
by devspace

description: SubPath is a path within the git repository where the artifact lies in

description: Enabled specifies if the given import should be enabled

description: Tag is the tag to pull

description: CloneArgs are additional arguments that should be supplied to the git CLI

description: Branch is the git branch to pull

group: path

description:
Path is the local path where DevSpace can find the artifact.
This option is mutually exclusive with the git option.

group_name: Source: Local Filesystem

description: DisablePull will disable pulling every time DevSpace is reevaluating this source

description: Revision is the git revision to pull

description: Import specifies the source of the devspace config to merge

key: Import


description:
Command is the name of the command that should be available in the remote container. DevSpace
will create a small script for that inside the container that redirect command execution to
the local computer.

description: SkipContainerEnv will not forward the container environment variables to the local command

description: GitCredentials configures a git credentials helper inside the container that proxies local git credentials

description: Env are extra environment variables to set for the command

description:
LocalCommand can be used to run a different command than specified via the command option. By
default, this will be assumed to be the same as command.

key: ProxyCommand


required: apiVersion kind name

description: Kind is the kind of the target resource (eg: Deployment, Service ...)

description: Name is the name of the target resource

description: ApiVersion is the Kubernetes api of the target resource

description: Target describes where to apply a config patch

key: Target


group: execution

description: OverwriteVars specifies if DevSpace should pass the parent variables to the dependency

default: deploy

description: Pipeline is the pipeline to deploy by default. Defaults to 'deploy'

group_name: Execution

description: Name is used internally

description: Namespace specifies the namespace this dependency should be deployed to

description: Vars are variables that should be passed to the dependency

description: Disabled excludes this dependency from variable resolution and pipeline runs

description: Tag is the tag to pull

description: Branch is the git branch to pull

description: IgnoreDependencies defines if dependencies of the dependency should be excluded

description: Revision is the git revision to pull

description: DependencyConfig defines the devspace dependency

key: DependencyConfig


description:
Path defines the path to the restart helper that might be used if certain config
options are enabled

description: Inject signals DevSpace to inject the restart helper

key: RestartHelper


description: Rootless if enabled will create a rootless builder deployment.

description:
Name is the name of the builder to use. If omitted, DevSpace will try to create
or reuse a builder in the form devspace-$NAMESPACE

description:
NoRecreate. By default, DevSpace will try to recreate the builder if the builder configuration
in the devspace.yaml differs from the actual builder configuration. If this is
true, DevSpace will not try to do that.

description: Image is the docker image to use for the BuildKit deployment

description:
Namespace where to create the builder deployment in. Defaults to the current
active namespace.

description: NodeSelector is the node selector to use for the BuildKit deployment

description:
NoCreate. By default, DevSpace will try to create a new builder if it cannot be found.
If this is true, DevSpace will fail if the specified builder cannot be found.

description: CreateArgs are additional args to create the builder with.

description:
NoLoad if enabled, DevSpace will not try to load the built image into the local docker
daemon if skip push is defined

description: BuildKitInClusterConfig holds the buildkit builder config

key: BuildKitInClusterConfig


required: key path

description:
The relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'.

description:
Optional: mode bits to use on this file, must be a value between 0
and 0777. If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.
+optional

description: The key to project.

key: KanikoAdditionalMountKeyToPath


description: Requests are the requests part of the resources

description: Limits are the limits part of the resources

description: PodResources describes the resources section of the started kaniko pod

key: PodResources


description: VersionArgs are the arguments to retrieve the version of the command

description: Version constraint of the command that should be installed

description: Name is the name of the command that should be installed

description: VersionRegEx is the regex that is used to parse the version

key: RequireCommand


required: op path

description: Path is the config path to apply the patch to

description: Value is the value to use for this patch.

description: Operation is the path operation to do. Can be either replace, add or remove

description: PatchConfig describes a config patch and how it should be applied

key: PatchConfig


description:
After is executed after the command was run. It is executed also when
the command was interrupted which will set the env variable COMMAND_INTERRUPT
to true as well as when the command errored which will set the error string to
COMMAND_ERROR.

description: Description describes what the command is doing and can be seen in `devspace list commands`

description: Section can be used to group similar commands together in `devspace list commands`

description:
Args are optional and if defined, command is not executed within a shell
and rather directly.

description:
AppendArgs will append arguments passed to the DevSpace command automatically to
the specified command.

description: Internal commands are not show in list and are usable through run_command

description: Command is the command that should be executed. For example: 'echo 123'

description: Name is the name of a command that is used via `devspace run NAME`

description: CommandConfig defines the command specification

key: CommandConfig


group: repo

description: Username is the username to authenticate to the chart repo. When using an OCI chart, used for registry auth

description:
Git is the remote repository to download the artifact from. You can either use
https projects or ssh projects here, but need to make sure git can pull the project.
This option is mutually exclusive with the path option.

description: Name is the name of the helm chart to deploy. Can also be a local path or an oci url

group_name: Source: Helm Repository

description:
DisableShallow can be used to turn off shallow clones as these are the default used
by devspace

description: SubPath is a path within the git repository where the artifact lies in

description: RepoURL is the url of the repo to deploy the chart from

description: Version is the version of the helm chart to deploy

description: CloneArgs are additional arguments that should be supplied to the git CLI

description: Branch is the git branch to pull

description: Tag is the tag to pull

description:
Path is the local path where DevSpace can find the artifact.
This option is mutually exclusive with the git option.

description: DisablePull will disable pulling every time DevSpace is reevaluating this source

description: Password is the password to authenticate to the chart repo, When using an OCI chart, used for registry auth

description: Revision is the git revision to pull

description: ChartConfig defines the helm chart options

key: ChartConfig


description: Download is the download limit in kilo bytes per second

description: Upload is the upload limit in kilo bytes per second

description: BandwidthLimits defines the struct for specifying the sync bandwidth limits

key: BandwidthLimits


description: OnChange will determine when the command should be rerun

description:
Command to execute to build the image. You can use ${runtime.images.my-image.image} and ${runtime.image.my-image.tag}
to reference the image and tag that should get built.

description: CustomConfig tells the DevSpace CLI to build with a custom build script

key: CustomConfig


required: name value

description: Name of the environment variable

description: Value of the environment variable

key: EnvVar


description: Name is the name to show for this exec in the logs

description: FailOnError specifies if the sync should fail if the command fails

description: Args are arguments to pass to the command

description:
Command is the command to execute. If no args are specified this is executed
within a shell.

description: OnChange is an array of file patterns that trigger this command execution

description:
Local specifies if the command should be executed locally instead of within the
container

description:
Once executes this command only once in the container's life. Can be used to initialize
a container before starting it, but after everything was synced.

key: SyncExec


description: LastLines is the amount of lines to print of the running container initially

description: Enabled can be used to enable printing container logs

key: Logs


description: StorageClassName of the persistent volume. Default is your cluster's configured default storage class

description: Enable enables persistence for the local registry

description: Size of the persistent volume for local docker registry storage. Default is `5Gi`

description: LocalRegistryPersistence configures persistence settings for the local registry

key: LocalRegistryPersistence


required: name version

description: Version constraint of the plugin that should be installed

description: Name of the plugin that should be installed

key: RequirePlugin


description:
Command is the command to use to retrieve the value for this variable. If no
args are specified the command is run within a pseudo shell.

description: Args are optional arguments for the command

description:
OperatingSystem is optional and defines the operating system this
command should be executed on

key: VariableCommand


description:
BindAddress is the address DevSpace should listen on. Optional and defaults
to localhost.

description:
Port is a port mapping that maps the localPort:remotePort. So if
you port forward the remote port will be available at the local port.
If you do reverse port forwarding, the local port will be available
at the remote port in the container. If only port is specified, local and
remote port are the same.

description: PortMapping defines the ports for a PortMapping

key: PortMapping


description:
UseInclude tells DevSpace to use a the file ~/.ssh/devspace_config for its ssh entries. DevSpace
will also create an import for its own entries inside ~/.ssh/config, this is a cleaner way,
but unfortunately not all SSH clients support this.

description: RemoteAddress is the address to listen to inside the container

description:
Enabled can be used to enable the ssh server within the container. By default,
DevSpace will generate the required keys and create an entry in your ~/.ssh/config
for this container that can be used via `ssh dev-config-name.dev-project-name.devspace`

description: LocalPort is the local port to forward from, if empty will be random

description: LocalHostname is the local ssh host to write to the ~/.ssh/config

key: SSH


description: StorageClassName is the storage type DevSpace should use for this persistent volume

description: AccessModes are the access modes DevSpace should use for the persistent volume

description: ReadOnly specifies if the volume should be read only

description:
Name is the name of the PVC that should be created. If a PVC with that name
already exists, DevSpace will use that PVC instead of creating one.

description: Size is the size of the created persistent volume in Kubernetes size notation like 5Gi

description: PersistenceOptions are general persistence options DevSpace should use for all persistent paths within a single dev configuration

key: PersistenceOptions


description: DisableFallback allows you to turn off kaniko building if docker isn't installed

description:
PreferMinikube allows you to turn off using the minikube docker daemon if the minikube
context is used.

description: UseCLI specifies if DevSpace should use the docker cli for building

description: Args are additional arguments to pass to the docker cli

description: DockerConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost

key: DockerConfig


required: Tablename Identifier Module PermissionKey

description: Row identifier without Row suffix

description: Table name

description: Module name

description: Permission key

title: Table

key: Table


enum: navigate script click rightclick text screenshot time select files waitload getresource extract setmethod addheader setheader deleteheader setbody waitevent keyboard debug sleep waitvisible

description: Type of actions to perform

title: action to perform


description: Data is the data to send as the input

title: data to send as input

description: Optional name of the data read to provide matching on

title: optional name for data read


enum: hex text

description: description=Type of input specified in data field

title: type is the type of input data


enum: regex kval xpath json dsl

description: Type of the extractor

title: type of the extractor


description: Type of the signature

title: type of the signature


enum: info low medium high critical unknown

description: Seriousness of the implications of the template

title: severity of the template


description: Regex of parameter keys to fuzz

title: keys regex to fuzz

description: Keys of parameters to fuzz

title: keys of parameters to fuzz

description: Part of request rule to fuzz

title: part of rule

description: Regex of parameter values to fuzz

title: values regex to fuzz

enum: single multiple

description: Mode of request rule to fuzz

title: mode of rule

enum: replace prefix postfix infix

description: Type of fuzzing rule to perform

title: type of rule

description: Payloads to perform fuzzing substitutions with

title: payloads of fuzz rule


enum: off default custom

description: userAgent for the headless http request

title: userAgent for the headless


enum: word regex binary status size dsl

description: Type of the matcher

title: type of the matcher


enum: A NS DS CNAME SOA PTR MX TXT AAAA CAA TLSA ANY

description: Type is the type of DNS request to make

title: type of DNS request to make


description: Additional variables for the request

title: variables for the request


enum: batteringram pitchfork clusterbomb

description: Type of the attack

title: type of the attack


enum: GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH PURGE DEBUG

description: Method is the HTTP Request Method

title: method is the HTTP request method


enum: Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmara Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Timbuktu Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/Buenos_Aires America/Argentina/Catamarca America/Argentina/ComodRivadavia America/Argentina/Cordoba America/Argentina/Jujuy America/Argentina/La_Rioja America/Argentina/Mendoza America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Atikokan America/Atka America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Ensenada America/Fort_Nelson America/Fort_Wayne America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Louisville America/Kentucky/Monticello America/Knox_IN America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Nuuk America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Acre America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Rosario America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Shiprock America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Virgin America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/South_Pole Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Ashkhabad Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Chongqing Asia/Chungking Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Harbin Asia/Hebron Asia/Ho_Chi_Minh Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Istanbul Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Kashgar Asia/Kathmandu Asia/Katmandu Asia/Khandyga Asia/Kolkata Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macao Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Tel_Aviv Asia/Thimbu Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ujung_Pandang Asia/Ulaanbaatar Asia/Ulan_Bator Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yangon Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Faroe Atlantic/Jan_Mayen Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Canberra Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/LHI Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/North Australia/NSW Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Australia/Yancowinna Brazil/Acre Brazil/DeNoronha Brazil/East Brazil/West Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon Chile/Continental Chile/EasterIsland Cuba Egypt Eire Etc/GMT Etc/GMT+0 Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT-0 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/GMT0 Etc/Greenwich Etc/UCT Etc/Universal Etc/UTC Etc/Zulu Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Nicosia Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Tiraspol Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich GB GB-Eire Hongkong Iceland Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Iran Israel Jamaica Japan Kwajalein Libya Mexico/BajaNorte Mexico/BajaSur Mexico/General Navajo NZ NZ-CHAT Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Chuuk Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kanton Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Pohnpei Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Samoa Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis Pacific/Yap Poland Portugal PRC ROC Singapore US/Alaska US/Aleutian US/Arizona US/Central US/East-Indiana US/Eastern US/Hawaii US/Indiana-Starke US/Michigan US/Mountain US/Pacific US/Samoa

key: timezone


type: string array

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

key: script


type: string object

default: default

enum: default build

enum: project package

description: Restrict this dependency to matching only a Project or a Package

key: dependencies


key: compilationOptions


description: By default the 'Text' will be the 'Name' reformatted as sentence casing. It will be formatted as: 'Represents a {text} constant value.' To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. '{{Xxx}}').

title: The overriding text for use in comments.

title: The unique constant name.

description: The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code.

title: The .NET (C#) code for the constant value.

description: The 'Const' object is used to define a .NET (C#) constant value for an 'Entity'.

title: 'Const' object (entity-driven)

key: Const


description: Mapped properties are a special Reference Data property type that ensure value uniqueness; this allows the likes of additional to/from mappings to occur between systems where applicable.

title: Indicates whether the property should use the underlying Reference Data mapping capabilities.

title: The unique (immutable) field number required to enable gRPC support.

description: A 'Mapper' is used to map a data source value to/from a .NET complex 'Type' (i.e. class with one or more properties).

title: The database property 'Mapper' class name where 'Entity.AutoImplement' is selected.

description: Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.

title: The overriding argument name.

description: By default the 'Text' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).

description: Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.

title: The overriding private name.

title: The underlying gRPC data type; will be inferred where not specified.

title: Indicates whether to emit the default value when serializing.

enum: UseDefault None DateOnly DateTimeLocal DateTimeUtc DateTimeUnspecified

description: Defaults to 'UseDefault'. This is only applied where the 'Type' is 'DateTime'.

title: The 'DateTime' transformation to be performed on 'Set' and 'CleanUp'.

title: Indicates whether the data 'Converter' is a generic class and will automatically use the corresponding property 'Type' as the generic 'T'.

title: Indicates that 'CleanUp' is not to be performed for the property within the 'Entity.CleanUp' method.

description: Defaults to 'JsonName' where not specified.

title: The override JSON property name where outputting as a data model.

enum: Map Ignore Skip

description: Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.

title: The Cosmos 'Mapper' approach for the property.

description: By default the 'ModelText' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).

title: The overriding model text for use in comments.

description: Will be inferred (default to 'true') where the 'Type' is 'ChangeLog' or the 'Type' is found as another 'Entity' within the code-generation configuration file.

title: Indicates that the property 'Type' is another generated entity / collection and therefore specific capabilities can be assumed (e.g. 'CopyFrom' and 'Clone').

title: Indicates whether the 'UniqueKey' property value is automatically generated by the data source on 'Create'.

description: This is also used to simplify the parameter specification for an Entity Operation by inferrence.

title: Indicates whether the property is considered part of the unique (primary) key.

title: The 'IPropertyMapperConverter' to perform 'Type' to 'string' conversion for writing to and parsing from the query string.

description: Defaults to 'ArgumentName' where not specified (i.e. camelCase); however, where the property is 'ETag' it will default to the 'Config.ETagJsonName'.

title: The JSON property name.

enum: string int Guid

description: Defaults to 'string' (being the 'ReferenceDataBase.Code') where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.' or '^'. Note: an 'Id' of type 'string' is currently not supported; the use of the 'Code' is the recommended approach.

title: The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).

description: This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example.

title: Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').

description: Should be formatted as 'Type' + '^' + 'Name'; e.g. 'IGuidIdentifierGenerator^GuidIdGen'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored. See 'Beef.Entities.IInt32IdentifierGenerator', 'Beef.Entities.IInt64IdentifierGenerator', 'Beef.Entities.IGuidIdentifierGenerator' or 'Beef.Entities.IStringIdentifierGenerator' for underlying implementation requirements.

title: The Identifier Generator Type to generate the identifier on create via Dependency Injection.

enum: UseDefault None Start End Both

description: Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.

title: The 'string' trimming of white space characters to be performed on 'Set' and 'CleanUp'.

title: Indicates whether the property is inherited and therefore should not be output within the generated Entity class.

description: Note that the 'IsEntity' property is also required to enable.

title: Indicates whether the value should bubble up property changes versus only recording within the sub-entity itself.

enum: UseDefault None NullToEmpty EmptyToNull

title: The 'string' transformation to be performed on 'Set' and 'CleanUp'.

description: Overrides the inferred database type; i.e. can specify 'Date' or 'DateTime2', for .NET Type 'System.DateTime'.

title: The database 'DbType' override (versus inferring from the corresponding .NET Type).

description: Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'

title: The .NET 'Type'.

title: Indicates that the value is immutable and therefore cannot be changed once set.

description: This is only applicable where the 'Entity.EntityScope' is 'Autonomous'. In this instance the 'Property' will be excluded from the 'Common' entity declaration.

title: Indicates whether the property is for internal use only; declared in Business entities only.

title: The Entity Framework 'Mapper' approach for the property.

title: The OData 'Mapper' approach for the property.

title: The names of the secondary property(s), comma delimited, that are to be notified on a property change.

description: This will implement 'IPartitionKey' for the generated entity.

title: Indicates whether the property is considered part of the Partition Key.

title: Indicates whether the property should be ignored (excluded) from the database 'Mapper' generated output.

description: This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true').

title: Indicates whether a corresponding 'Text' property is added when generating a Reference Data property, overriding the 'Entity.RefDataText' selection.

title: Indicates whether an instance of the 'Type' is to be automatically created/instantiated when the property is first accessed (i.e. lazy instantiation).

title: The JSON property name for the corresponding data model (see 'Entity.DataModel').

description: All properties are serialized by default.

title: Indicates whether the property is not to be serialized.

title: The HttpAgent 'Mapper' approach for the property.

description: Defaults to the 'Name' as sentence case.

title: The display name used in the likes of error messages for the property.

title: The unique property name.

title: Indicates whether the .NET 'Type' should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'.

description: Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used.

title: The C# code to default the value.

description: All properties are included by default.

title: Indicates whether the property should be ignored (excluded) from the 'Data'-layer / data 'Mapper' generated output.

description: Defaults to the property 'Name'. Represents the column name for a 'Database', or the correspinding property name for the other options.

title: The data name where Entity.AutoImplement is selected.

enum: Any AnyExceptCreate AnyExceptUpdate AnyExceptGet Get Create Update Delete

description: Defaults to 'Any'.

title: The operations types ('ExecutionContext.OperationType') selection to enable inclusion and exclusion of property mapping.

description: A 'Converter' is used to convert a data source value to/from a .NET 'Type' where no standard data conversion can be applied. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'DataConverterIsGeneric' to 'true'.

title: The data 'Converter' class name where 'Entity.AutoImplement' is selected.

title: The property annotation (e.g. attribute) declaration code.

description: The 'Property' object defines an 'Entity' property and its charateristics.

title: 'Property' object (entity-driven)

key: Property


enum: All ToManagerSet ToManagerCollSet

description: Defaults to 'All'. To further describe, 'All' passes the parameter through all layeys, 'ToManagerSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' parameter, 'ToManagerCollSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' collection parameter. Where using the 'UniqueKey' option to automatically set 'Parameters', and the 'Operation.Type' is 'Create' or 'Update' it will default to 'ToManagerSet'.

title: The option that determines the layers in which the parameter is passed.

title: The unique parameter name.

title: Indicates whether the .NET 'Type should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'.

title: The C# code to default the value.

description: By default the 'Text' will be the 'Name' reformatted as sentence casing.

title: The overriding text for use in comments.

title: Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').

description: Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.

title: The overriding private name.

description: Defaults to 'string' where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.'.

title: The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).

title: Indicates whether a 'ValidationException' should be thrown when the parameter value has its default value (null, zero, etc).

title: The underlying gRPC data type; will be inferred where not specified.

description: Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.

title: The overriding argument name.

title: The fluent-style method-chaining C# validator code to append to 'IsMandatory' and 'Validator' (where specified).

title: The name of the .NET 'Type' that will perform the validation.

title: Indicates whether the data 'Converter' is a generic class and will automatically use the corresponding property 'Type' as the generic 'T'.

enum: FromQuery FromBody FromRoute FromEntityProperties

description: Defaults to 'FromQuery'; unless the parameter 'Type' has also been defined as an 'Entity' within the code-gen config file then it will default to 'FromEntityProperties'. Specifies that the parameter will be declared with corresponding 'FromQueryAttribute', 'FromBodyAttribute' or 'FromRouteAttribute' for the Web API method. The 'FromEntityProperties' will declare all properties of the 'Entity' as query parameters.

title: The option for how the parameter will be delcared within the Web API Controller.

description: A 'Converter' is used to convert a data source value to/from a .NET 'Type' where the standard data type conversion is not applicable.

title: The data 'Converter' class name where specific data conversion is required.

title: The 'Property.Name' within the parent 'Entity' to copy (set) the configuration/characteristics from where not already defined.

title: The .NET 'Type'.

description: Defaults to 'IValidator<{Type}>' where the '{Type}' is 'Type'.

title: The name of the .NET Interface that the 'Validator' implements/inherits.

description: The 'Parameter' object defines an 'Operation' parameter and its charateristics.

title: 'Parameter' object (entity-driven)

key: Parameter


description: Path to base configuration file to inherit from (requires TypeScript version 2.1 or later), or array of base files, with the rightmost files having the greater priority (requires TypeScript version 5.0 or later).

key: extendsDefinition


description: Auto type (.d.ts) acquisition options for this project. Requires TypeScript version 2.1 or later.

description: Specifies a list of type declarations to be included in auto type acquisition. Ex. ["jquery", "lodash"]

description: Enable auto type acquisition

description: Specifies a list of type declarations to be excluded from auto type acquisition. Ex. ["jquery", "lodash"]

key: typeAcquisitionDefinition


description: Specifies a list of files to be excluded from compilation. The 'exclude' property only affects the files included via the 'include' property and not the 'files' property. Glob patterns require TypeScript version 2.0 or later.

key: excludeDefinition


markdownDescription:
Build all projects, including those that appear to be up to date

See more: https://www.typescriptlang.org/tsconfig#force

markdownDescription:
Enable verbose logging

See more: https://www.typescriptlang.org/tsconfig#verbose

description: Enable verbose logging

markdownDescription:
Log paths used during the `moduleResolution` process.

See more: https://www.typescriptlang.org/tsconfig#traceResolution

markdownDescription:
Save .tsbuildinfo files to allow for incremental compilation of projects.

See more: https://www.typescriptlang.org/tsconfig#incremental

markdownDescription:
Have recompiles in projects that use `incremental` and `watch` mode assume that changes within a file will only affect files directly depending on it.

See more: https://www.typescriptlang.org/tsconfig#assumeChangesOnlyAffectDirectDependencies

key: buildOptionsDefinition


description: Project reference.

description: Path to referenced tsconfig or to folder containing tsconfig.

description: Referenced projects. Requires TypeScript version 3.0 or later.

key: referencesDefinition


description: Specifies a list of glob patterns that match files to be included in compilation. If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. Requires TypeScript version 2.0 or later.

key: includeDefinition


description: Enable Compile-on-Save for this project.

key: compileOnSaveDefinition


description: Settings for the watch mode in TypeScript.

markdownDescription:
Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively.

See more: https://www.typescriptlang.org/tsconfig#synchronousWatchDirectory

markdownDescription:
Remove a list of files from the watch mode's processing.

See more: https://www.typescriptlang.org/tsconfig#excludeFiles

markdownDescription:
Specify how the TypeScript watch mode works.

See more: https://www.typescriptlang.org/tsconfig#watchFile

markdownDescription:
Specify how directories are watched on systems that lack recursive file-watching functionality.

See more: https://www.typescriptlang.org/tsconfig#watchDirectory

markdownDescription:
Specify what approach the watcher should use if the system runs out of native file watchers.

See more: https://www.typescriptlang.org/tsconfig#fallbackPolling

markdownDescription:
Remove a list of directories from the watch process.

See more: https://www.typescriptlang.org/tsconfig#excludeDirectories

key: watchOptionsDefinition


description: Instructs the TypeScript compiler how to compile .ts files.

markdownDescription:
Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.

See more: https://www.typescriptlang.org/tsconfig#emitBOM

description: Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.

markdownDescription:
Ensure that each file can be safely transpiled without relying on other imports.

See more: https://www.typescriptlang.org/tsconfig#isolatedModules

description: Ensure that each file can be safely transpiled without relying on other imports.

default: useFsEvents

enum: useFsEvents fixedPollingInterval dynamicPriorityPolling fixedChunkSizePolling

description: Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.

markdownDescription:
Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.

See more: https://www.typescriptlang.org/tsconfig#disableSizeLimit

description: Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.

enum: auto legacy force

description: Specify how TypeScript determine a file as module.

markdownDescription:
When type checking, take into account `null` and `undefined`.

See more: https://www.typescriptlang.org/tsconfig#strictNullChecks

description: When type checking, take into account `null` and `undefined`.

markdownDescription:
Check for class properties that are declared but not set in the constructor.

See more: https://www.typescriptlang.org/tsconfig#strictPropertyInitialization

description: Check for class properties that are declared but not set in the constructor.

markdownDescription:
Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output.

See more: https://www.typescriptlang.org/tsconfig#outFile

markdownDescription:
Disable strict checking of generic signatures in function types.

See more: https://www.typescriptlang.org/tsconfig#noStrictGenericChecks

description: Disable strict checking of generic signatures in function types.

markdownDescription:
Enable color and formatting in output to make compiler errors easier to read

See more: https://www.typescriptlang.org/tsconfig#pretty

description: Enable color and formatting in output to make compiler errors easier to read

markdownDescription:
Disable wiping the console in watch mode

See more: https://www.typescriptlang.org/tsconfig#preserveWatchOutput

description: Disable wiping the console in watch mode

markdownDescription:
Allow importing helper functions from tslib once per project, instead of including them per-file.

See more: https://www.typescriptlang.org/tsconfig#importHelpers

description: Allow importing helper functions from tslib once per project, instead of including them per-file.

markdownDescription:
Ensure overriding members in derived classes are marked with an override modifier.

See more: https://www.typescriptlang.org/tsconfig#noImplicitOverride

description: Ensure overriding members in derived classes are marked with an override modifier.

markdownDescription:
Emit ECMAScript-standard-compliant class fields.

See more: https://www.typescriptlang.org/tsconfig#useDefineForClassFields

description: Emit ECMAScript-standard-compliant class fields.

markdownDescription:
Differentiate between undefined and not present when type checking

See more: https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes

description: Differentiate between undefined and not present when type checking

description: Watch input files.

markdownDescription:
Include sourcemap files inside the emitted JavaScript.

See more: https://www.typescriptlang.org/tsconfig#inlineSourceMap

description: Include sourcemap files inside the emitted JavaScript.

markdownDescription:
Make keyof only return strings instead of string, numbers or symbols. Legacy option.

See more: https://www.typescriptlang.org/tsconfig#keyofStringsOnly

description: Make keyof only return strings instead of string, numbers or symbols. Legacy option.

markdownDescription:
Include source code in the sourcemaps inside the emitted JavaScript.

See more: https://www.typescriptlang.org/tsconfig#inlineSources

description: Include source code in the sourcemaps inside the emitted JavaScript.

markdownDescription:
Use the package.json 'exports' field when resolving package imports.

See more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonExports

description: Use the package.json 'exports' field when resolving package imports.

markdownDescription:
Set the newline character for emitting files.

See more: https://www.typescriptlang.org/tsconfig#newLine

enum: crlf lf

pattern: ^(CRLF|LF|crlf|lf)$

description: Set the newline character for emitting files.

markdownDescription:
Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'

See more: https://www.typescriptlang.org/tsconfig#jsxFactory

description: Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'

markdownDescription:
Conditions to set in addition to the resolver-specific defaults when resolving imports.

See more: https://www.typescriptlang.org/tsconfig#customConditions

description: Conditions to set in addition to the resolver-specific defaults when resolving imports.

markdownDescription:
Enable error reporting in type-checked JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#checkJs

description: Enable error reporting in type-checked JavaScript files.

description: Have recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it. Requires TypeScript version 3.8 or later.

markdownDescription:
Disable truncating types in error messages.

See more: https://www.typescriptlang.org/tsconfig#noErrorTruncation

description: Disable truncating types in error messages.

markdownDescription:
Create sourcemaps for d.ts files.

See more: https://www.typescriptlang.org/tsconfig#declarationMap

description: Create sourcemaps for d.ts files.

markdownDescription:
Raise an error when a function parameter isn't read

See more: https://www.typescriptlang.org/tsconfig#noUnusedParameters

description: Raise an error when a function parameter isn't read

markdownDescription:
Disable emitting file from a compilation.

See more: https://www.typescriptlang.org/tsconfig#noEmit

description: Disable emitting file from a compilation.

markdownDescription:
Only output d.ts files and not JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#emitDeclarationOnly

description: Only output d.ts files and not JavaScript files.

markdownDescription:
Specify what module code is generated.

See more: https://www.typescriptlang.org/tsconfig#module

description: Specify what module code is generated.

markdownDescription:
Disable adding 'use strict' directives in emitted JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#noImplicitUseStrict

description: Disable adding 'use strict' directives in emitted JavaScript files.

markdownDescription:
Use the package.json 'imports' field when resolving imports.

See more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonImports

description: Use the package.json 'imports' field when resolving imports.

markdownDescription:
Specify a list of language service plugins to include.

See more: https://www.typescriptlang.org/tsconfig#plugins

description: Plugin name.

description: Specify a list of language service plugins to include.

default: .tsbuildinfo

markdownDescription:
Specify the folder for .tsbuildinfo incremental compilation files.

See more: https://www.typescriptlang.org/tsconfig#tsBuildInfoFile

description: Specify the folder for .tsbuildinfo incremental compilation files.

markdownDescription:
Print all of the files read during the compilation.

See more: https://www.typescriptlang.org/tsconfig#listFiles

description: Print all of the files read during the compilation.

markdownDescription:
Enable error reporting for codepaths that do not explicitly return in a function.

See more: https://www.typescriptlang.org/tsconfig#noImplicitReturns

description: Enable error reporting for codepaths that do not explicitly return in a function.

markdownDescription:
Disable preferring source files instead of declaration files when referencing composite projects

See more: https://www.typescriptlang.org/tsconfig#disableSourceOfProjectReferenceRedirect

description: Disable preferring source files instead of declaration files when referencing composite projects

markdownDescription:
Output more detailed compiler performance information after building.

See more: https://www.typescriptlang.org/tsconfig#extendedDiagnostics

description: Output more detailed compiler performance information after building.

markdownDescription:
Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.

See more: https://www.typescriptlang.org/tsconfig#esModuleInterop

description: Print names of files that are part of the compilation and then stop processing.

markdownDescription:
Add `undefined` to a type when accessed using an index.

See more: https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess

description: Add `undefined` to a type when accessed using an index.

markdownDescription:
Disable including any library files, including the default lib.d.ts.

See more: https://www.typescriptlang.org/tsconfig#noLib

description: Disable including any library files, including the default lib.d.ts.

markdownDescription:
Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.

See more: https://www.typescriptlang.org/tsconfig#maxNodeModuleJsDepth

type: number

description: Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.

markdownDescription:
Specify the location where debugger should locate map files instead of generated locations.

See more: https://www.typescriptlang.org/tsconfig#mapRoot

description: Specify the location where debugger should locate map files instead of generated locations.

markdownDescription:
Create source map files for emitted JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#sourceMap

description: Create source map files for emitted JavaScript files.

markdownDescription:
Enforces using indexed accessors for keys declared using an indexed type

See more: https://www.typescriptlang.org/tsconfig#noPropertyAccessFromIndexSignature

description: Enforces using indexed accessors for keys declared using an indexed type

markdownDescription:
Disable emitting declarations that have `@internal` in their JSDoc comments.

See more: https://www.typescriptlang.org/tsconfig#stripInternal

description: Disable emitting declarations that have `@internal` in their JSDoc comments.

default: react

markdownDescription:
Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx`.

See more: https://www.typescriptlang.org/tsconfig#jsxImportSource

description: Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx`.

markdownDescription:
Emit a v8 CPU profile of the compiler run for debugging.

See more: https://www.typescriptlang.org/tsconfig#generateCpuProfile

description: Emit a v8 CPU profile of the compiler run for debugging.

markdownDescription:
Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting.

See more: https://www.typescriptlang.org/tsconfig#verbatimModuleSyntax

markdownDescription:
Suppress `noImplicitAny` errors when indexing objects that lack index signatures.

See more: https://www.typescriptlang.org/tsconfig#suppressImplicitAnyIndexErrors

description: Suppress `noImplicitAny` errors when indexing objects that lack index signatures.

markdownDescription:
Emit more compliant, but verbose and less performant JavaScript for iteration.

See more: https://www.typescriptlang.org/tsconfig#downlevelIteration

description: Emit more compliant, but verbose and less performant JavaScript for iteration.

markdownDescription:
Disable error reporting for unused labels.

See more: https://www.typescriptlang.org/tsconfig#allowUnusedLabels

description: Disable error reporting for unused labels.

default: classic

enum: Classic Node Node16 NodeNext Bundler

markdownDescription:
Specify how TypeScript looks up a file from a given module specifier.

See more: https://www.typescriptlang.org/tsconfig#moduleResolution

description: Specify how TypeScript looks up a file from a given module specifier.

markdownDescription:
Default catch clause variables as `unknown` instead of `any`.

See more: https://www.typescriptlang.org/tsconfig#useUnknownInCatchVariables

description: Default catch clause variables as `unknown` instead of `any`.

markdownDescription:
Enable error reporting when a local variables aren't read.

See more: https://www.typescriptlang.org/tsconfig#noUnusedLocals

description: Enable error reporting when a local variables aren't read.

default: remove

enum: remove preserve error

description: Specify emit/checking behavior for imports that are only used for types.

markdownDescription:
Preserve unused imported values in the JavaScript output that would otherwise be removed

See more: https://www.typescriptlang.org/tsconfig#preserveValueImports

description: Preserve unused imported values in the JavaScript output that would otherwise be removed

markdownDescription:
Specify the base directory to resolve non-relative module names.

See more: https://www.typescriptlang.org/tsconfig#baseUrl

description: Specify the base directory to resolve non-relative module names.

markdownDescription:
Enable all strict type checking options.

See more: https://www.typescriptlang.org/tsconfig#strict

description: Enable all strict type checking options.

markdownDescription:
Enable importing .json files

See more: https://www.typescriptlang.org/tsconfig#resolveJsonModule

description: Enable importing .json files

markdownDescription:
Disable emitting comments.

See more: https://www.typescriptlang.org/tsconfig#removeComments

description: Disable emitting comments.

description: Enable tracing of the name resolution process. Requires TypeScript version 2.0 or later.

markdownDescription:
Enable constraints that allow a TypeScript project to be used with project references.

See more: https://www.typescriptlang.org/tsconfig#composite

description: Enable constraints that allow a TypeScript project to be used with project references.

markdownDescription:
Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.

See more: https://www.typescriptlang.org/tsconfig#allowJs

description: Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.

markdownDescription:
Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set.

See more: https://www.typescriptlang.org/tsconfig#allowImportingTsExtensions

markdownDescription:
Allow accessing UMD globals from modules.

See more: https://www.typescriptlang.org/tsconfig#allowUmdGlobalAccess

description: Allow accessing UMD globals from modules.

markdownDescription:
Disable reporting of excess property errors during the creation of object literals.

See more: https://www.typescriptlang.org/tsconfig#suppressExcessPropertyErrors

description: Disable reporting of excess property errors during the creation of object literals.

markdownDescription:
Skip type checking all .d.ts files.

See more: https://www.typescriptlang.org/tsconfig#skipLibCheck

description: Skip type checking all .d.ts files.

markdownDescription:
Generate .d.ts files from TypeScript and JavaScript files in your project.

See more: https://www.typescriptlang.org/tsconfig#declaration

description: Generate .d.ts files from TypeScript and JavaScript files in your project.

markdownDescription:
Set the JavaScript language version for emitted JavaScript and include compatible library declarations.

See more: https://www.typescriptlang.org/tsconfig#target

description: Set the JavaScript language version for emitted JavaScript and include compatible library declarations.

default: React

markdownDescription:
Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.

See more: https://www.typescriptlang.org/tsconfig#reactNamespace

description: Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.

markdownDescription:
Specify the root path for debuggers to find the reference source code.

See more: https://www.typescriptlang.org/tsconfig#sourceRoot

description: Specify the root path for debuggers to find the reference source code.

markdownDescription:
Specify the root folder within your source files.

See more: https://www.typescriptlang.org/tsconfig#rootDir

description: Specify the root folder within your source files.

markdownDescription:
Disable erasing `const enum` declarations in generated code.

See more: https://www.typescriptlang.org/tsconfig#preserveConstEnums

description: Disable erasing `const enum` declarations in generated code.

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling fixedInterval priorityInterval dynamicPriority fixedChunkSize

description: Specify the polling strategy to use when the system runs out of or doesn't support native file watchers. Requires TypeScript version 3.8 or later.

markdownDescription:
Specify the output directory for generated declaration files.

See more: https://www.typescriptlang.org/tsconfig#declarationDir

description: Specify the output directory for generated declaration files.

markdownDescription:
Opt a project out of multi-project reference checking when editing.

See more: https://www.typescriptlang.org/tsconfig#disableSolutionSearching

description: Opt a project out of multi-project reference checking when editing.

markdownDescription:
Allow 'import x from y' when a module doesn't have a default export.

See more: https://www.typescriptlang.org/tsconfig#allowSyntheticDefaultImports

description: Allow 'import x from y' when a module doesn't have a default export.

markdownDescription:
Disable emitting files if any type checking errors are reported.

See more: https://www.typescriptlang.org/tsconfig#noEmitOnError

description: Disable emitting files if any type checking errors are reported.

markdownDescription:
Enable error reporting for expressions and declarations with an implied `any` type..

See more: https://www.typescriptlang.org/tsconfig#noImplicitAny

description: Enable error reporting for expressions and declarations with an implied `any` type..

markdownDescription:
Reduce the number of projects loaded automatically by TypeScript.

See more: https://www.typescriptlang.org/tsconfig#disableReferencedProjectLoad

description: Reduce the number of projects loaded automatically by TypeScript.

description: Enable incremental compilation. Requires TypeScript version 3.4 or later.

markdownDescription:
Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.

See more: https://www.typescriptlang.org/tsconfig#noResolve

description: Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.

markdownDescription:
Disable resolving symlinks to their realpath. This correlates to the same flag in node.

See more: https://www.typescriptlang.org/tsconfig#preserveSymlinks

description: Disable resolving symlinks to their realpath. This correlates to the same flag in node.

description: Path mapping to be computed relative to baseUrl option.

markdownDescription:
Specify a set of entries that re-map imports to additional lookup locations.

See more: https://www.typescriptlang.org/tsconfig#paths

description: Specify a set of entries that re-map imports to additional lookup locations.

markdownDescription:
Specify a set of bundled library declaration files that describe the target runtime environment.

See more: https://www.typescriptlang.org/tsconfig#lib

description: Specify a set of bundled library declaration files that describe the target runtime environment.

markdownDescription:
When assigning functions, check to ensure parameters and the return values are subtype-compatible.

See more: https://www.typescriptlang.org/tsconfig#strictFunctionTypes

description: When assigning functions, check to ensure parameters and the return values are subtype-compatible.

markdownDescription:
Specify multiple folders that act like `./node_modules/@types`.

See more: https://www.typescriptlang.org/tsconfig#typeRoots

description: Specify multiple folders that act like `./node_modules/@types`.

markdownDescription:
No longer supported. In early versions, manually set the text encoding for reading files.

See more: https://www.typescriptlang.org/tsconfig#charset

description: No longer supported. In early versions, manually set the text encoding for reading files.

markdownDescription:
Emit design-type metadata for decorated declarations in source files.

See more: https://www.typescriptlang.org/tsconfig#emitDecoratorMetadata

description: Emit design-type metadata for decorated declarations in source files.

markdownDescription:
Specify an output folder for all emitted files.

See more: https://www.typescriptlang.org/tsconfig#outDir

description: Specify an output folder for all emitted files.

markdownDescription:
Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.

See more: https://www.typescriptlang.org/tsconfig#jsxFragmentFactory

description: Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.

markdownDescription:
Enable error reporting when `this` is given the type `any`.

See more: https://www.typescriptlang.org/tsconfig#noImplicitThis

description: Enable error reporting when `this` is given the type `any`.

markdownDescription:
Ensure 'use strict' is always emitted.

See more: https://www.typescriptlang.org/tsconfig#alwaysStrict

description: Ensure 'use strict' is always emitted.

markdownDescription:
Enable importing files with any extension, provided a declaration file is present.

See more: https://www.typescriptlang.org/tsconfig#allowImportingTsExtensions

description: Enable importing files with any extension, provided a declaration file is present.

enum: preserve react react-jsx react-jsxdev react-native

description: Specify what JSX code is generated.

markdownDescription:
Specify type package names to be included without being referenced in a source file.

See more: https://www.typescriptlang.org/tsconfig#types

description: Specify type package names to be included without being referenced in a source file.

markdownDescription:
Allow multiple folders to be treated as one when resolving modules.

See more: https://www.typescriptlang.org/tsconfig#rootDirs

description: Allow multiple folders to be treated as one when resolving modules.

markdownDescription:
Skip type checking .d.ts files that are included with TypeScript.

See more: https://www.typescriptlang.org/tsconfig#skipDefaultLibCheck

description: Skip type checking .d.ts files that are included with TypeScript.

markdownDescription:
Disable generating custom helper functions like `__extends` in compiled output.

See more: https://www.typescriptlang.org/tsconfig#noEmitHelpers

description: Disable generating custom helper functions like `__extends` in compiled output.

markdownDescription:
Check that the arguments for `bind`, `call`, and `apply` methods match the original function.

See more: https://www.typescriptlang.org/tsconfig#strictBindCallApply

description: Check that the arguments for `bind`, `call`, and `apply` methods match the original function.

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling useFsEvents useFsEventsOnParentDirectory fixedChunkSizePolling

description: Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.

markdownDescription:
Enable error reporting for fallthrough cases in switch statements.

See more: https://www.typescriptlang.org/tsconfig#noFallthroughCasesInSwitch

description: Enable error reporting for fallthrough cases in switch statements.

markdownDescription:
Ensure that casing is correct in imports.

See more: https://www.typescriptlang.org/tsconfig#forceConsistentCasingInFileNames

description: Ensure that casing is correct in imports.

markdownDescription:
Output compiler performance information after building.

See more: https://www.typescriptlang.org/tsconfig#diagnostics

description: Output compiler performance information after building.

markdownDescription:
Disable error reporting for unreachable code.

See more: https://www.typescriptlang.org/tsconfig#allowUnreachableCode

description: Disable error reporting for unreachable code.

markdownDescription:
Print the names of emitted files after a compilation.

See more: https://www.typescriptlang.org/tsconfig#listEmittedFiles

description: Print the names of emitted files after a compilation.

markdownDescription:
Enable experimental support for TC39 stage 2 draft decorators.

See more: https://www.typescriptlang.org/tsconfig#experimentalDecorators

description: Enable experimental support for TC39 stage 2 draft decorators.


description: If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. When a 'files' property is specified, only those files and those specified by 'include' are included.

key: filesDefinition