key: versionControlDetails

description: Specifies the information necessary to retrieve a desired revision from a version control system.


key: uri

description: The absolute URI of the repository.

type: string

format: uri


key: revisionId

description: A string that uniquely and permanently identifies the revision within the repository.


key: branch

description: The name of a branch containing the revision.


key: tag

description: A tag that has been applied to the revision.


key: timestamp

description: The date and time at which the revision was created.

format: date-time


key: properties

description: Key/value pairs that provide additional information about the revision.

type: object

type: array


key: tags

description: A set of distinct strings that provide additional information.


key: $schema

description: The URI of the JSON schema corresponding to the version.


key: version

description: The SARIF format version of this log file.


key: runs

description: The set of runs contained in this log file.


description: The URI of the JSON schema corresponding to the version of the external property file format.


description: The SARIF format version of this external properties object.


key: guid

description: A stable, unique identifier for this external properties object, in the form of a GUID.


key: runGuid

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.


key: conversion

description: A conversion object that will be merged with an external run.


key: graphs

description: An array of graph objects that will merged with an external run.


key: externalizedProperties

description: Key/value pairs that provide additional information that will be merged with an external run.


key: artifacts

description: An array of artifact objects that will be merged with an external run.


key: invocations

description: Describes the invocation of the analysis tool that will be merged with an external run.


key: logicalLocations

description: An array of logical locations such as namespaces, types or functions that will be merged with an external run.


key: threadFlowLocations

description: An array of threadFlowLocation objects that will be merged with an external run.


key: results

description: An array of result objects that will be merged with an external run.


key: taxonomies

description: Tool taxonomies that will be merged with an external run.


key: driver

description: The analysis tool object that will be merged with an external run.


key: extensions

description: Tool extensions that will be merged with an external run.


key: policies

description: Tool policies that will be merged with an external run.


key: translations

description: Tool translations that will be merged with an external run.


key: addresses

description: Addresses that will be merged with with an external run.


key: webRequests

description: Requests that will be merged with an external run.


key: webResponses

description: Responses that will be merged with an external run.


key: properties

description: Key/value pairs that provide additional information about the external properties.


description: Configuration file defining a dimension type for a data pack for Minecraft.

type: boolean

type: number

type: integer


key: name

description: The resource location used for the dimension type.


key: ultrawarm

description: Whether the dimensions behaves like the nether (water evaporates and sponges dry) or not. Also lets stalactites drip lava and causes lava to spread faster and thinner.


key: natural

description: When true, nether portals can spawn zombified piglins. When false, compasses spin randomly, and using a bed to set the respawn point or sleep, is disabled.


description: The multiplier applied to coordinates when traveling to the dimension.


description: Whether the dimension has skylight access or not.


description: Whether the dimension has a bedrock ceiling or not.


description: How much light the dimension has.


description: If this is set to a number, the time of the day is the specified value.


description: Whether piglins shake and transform to zombified piglins.


description: When false, the bed blows up when trying to sleep.


description: Whether players can charge and use respawn anchors.


description: Whether players with the Bad Omen effect can cause a raid.


description: The maximum height to which chorus fruits and nether portals can bring players within this dimension. This excludes portals that were already built above the limit as they still connect normally.


description: The minimum height in which blocks can exist within this dimension.


key: height

description: The total height in which blocks can exist within this dimension.


key: infiniburn

description: A resource location defining what block tag to use for infiniburn.


key: effects

description: Determines the dimension effect used for this dimension.


key: generated

description: Generated is the date the lock file was last generated.


key: digest

description: Digest is a hash of the dependencies in Chart.yaml.


key: dependencies

description:
In Helm, one chart may depend on any number of other charts. These dependencies can be dynamically linked using the dependencies field in Chart.yaml or brought in to the charts/ directory and managed manually.
The charts required by the current chart are defined as a list in the dependencies field.

required: name version repository


description: The name of the chart


key: version

description: The version of the chart


key: repository

description: The repository URL or alias


key: message

description: Custom message that will be used in errors and warnings


key: severity

description: Message status

enum: warning error


key: ignoreProperties

description: Ignore units in the values of declarations with the specified properties


key: at-rule-blacklist

description: Specify a blacklist of disallowed at-rules


key: at-rule-empty-line-before

description: Require or disallow an empty line before at-rules

type: null string array

type: string object

enum: after-same-name inside-block blockless-after-same-name-blockless blockless-after-blockless first-nested

enum: after-comment first-nested inside-block blockless-after-same-name-blockless blockless-after-blockless


key: at-rule-name-case

description: Specify lowercase or uppercase for at-rules names


key: at-rule-name-newline-after

description: Require a newline after at-rule names


key: at-rule-name-space-after

description: Require a single space after at-rule names


key: at-rule-no-unknown

description: Disallow unknown at-rules

type: null boolean array

type: boolean object


key: at-rule-no-vendor-prefix

description: Disallow vendor prefixes for at-rules


key: at-rule-semicolon-newline-after

description: Require a newline after the semicolon of at-rules


key: at-rule-whitelist

description: Specify a whitelist of allowed at-rules


key: block-closing-brace-empty-line-before

description: Require or disallow an empty line before the closing brace of blocks


key: block-closing-brace-newline-after

description: Require a newline or disallow whitespace after the closing brace of blocks


key: block-closing-brace-newline-before

description: Require a newline or disallow whitespace before the closing brace of blocks


key: block-closing-brace-space-after

description: Require a single space or disallow whitespace after the closing brace of blocks


key: block-closing-brace-space-before

description: Require a single space or disallow whitespace before the closing brace of blocks


key: block-no-empty

description: Disallow empty blocks


key: block-no-single-line

description: Disallow single-line blocks


key: block-opening-brace-newline-after

description: Require a newline after the opening brace of blocks


key: block-opening-brace-newline-before

description: Require a newline or disallow whitespace before the opening brace of blocks


key: block-opening-brace-space-after

description: Require a single space or disallow whitespace after the opening brace of blocks


key: block-opening-brace-space-before

description: Require a single space or disallow whitespace before the opening brace of blocks


key: color-hex-case

description: Specify lowercase or uppercase for hex colors


key: color-hex-length

description: Specify short or long notation for hex colors


key: color-named

description: Require (where possible) or disallow named colors


key: color-no-hex

description: Disallow hex colors


key: color-no-invalid-hex

description: Disallow invalid hex colors


key: comment-empty-line-before

description: Require or disallow an empty line before comments


key: except

description: Reverse the primary option for comments that are nested and the first child of their parent node


key: ignore

description: Don't require an empty line between comments


key: comment-no-empty

description: Disallow empty comments


key: comment-whitespace-inside

description: Require or disallow whitespace on the inside of comment markers


key: comment-word-blacklist

description: Specify a blacklist of disallowed words within comments


key: custom-media-pattern

description: Specify a pattern for custom media query names


key: custom-property-empty-line-before

description: Require or disallow an empty line before custom properties

enum: after-comment inside-single-line-block


description: Reverse the primary option for custom properties that come after a comment, custom property or first child of their parent node


description: Ignore custom properties that are preceded by comments or inside single-line blocks


key: custom-property-no-outside-root

description: Disallow custom properties outside of `:root` rules


key: custom-property-pattern

description: Specify a pattern for custom properties


key: declaration-bang-space-after

description: Require a single space or disallow whitespace after the bang of declarations


key: declaration-bang-space-before

description: Require a single space or disallow whitespace before the bang of declarations


key: declaration-colon-newline-after

description: Require a newline or disallow whitespace after the colon of declarations


key: declaration-colon-space-after

description: Require a single space or disallow whitespace after the colon of declarations


key: declaration-colon-space-before

description: Require a single space or disallow whitespace before the colon of declarations


key: declaration-empty-line-before

description: Require or disallow an empty line before declarations


key: declaration-no-important

description: Disallow `!important` within declarations


key: declaration-property-unit-blacklist

description: Specify a blacklist of disallowed property and unit pairs within declarations


key: declaration-property-unit-whitelist

description: Specify a whitelist of allowed property and unit pairs within declarations


key: declaration-property-value-blacklist

description: Specify a blacklist of disallowed property and value pairs within declarations


key: declaration-property-value-whitelist

description: Specify a whitelist of allowed property and value pairs within declarations


description: Disallow duplicate properties within declaration blocks


key: declaration-block-no-ignored-properties

description: Disallow property values that are ignored due to another property value in the same rule


description: Disallow longhand properties that can be combined into one shorthand property


Disallow shorthand properties that override related longhand properties


key: declaration-block-properties-order

description: Specify the order of properties within declaration blocks

type: string array object

enum: top bottom bottomAlphabetical ignore

enum: strict flexible


key: unspecified

description: These options only apply if you've defined your own array of properties


Require a newline or disallow whitespace after the semicolons of declaration blocks


Require a newline or disallow whitespace before the semicolons of declaration blocks


key: declaration-block-semicolon-space-after

description: Require a single space or disallow whitespace after the semicolons of declaration blocks


Require a single space or disallow whitespace before the semicolons of declaration blocks


Limit the number of declaration within a single line declaration block


key: declaration-block-trailing-semicolon

description: Require or disallow a trailing semicolon within declaration blocks


key: font-family-name-quotes

description: Specify whether or not quotation marks should be used around font family names


key: font-weight-notation

description: Require numeric or named (where possible) `font-weight` values. Also, when named values are expected, require only valid names


key: function-blacklist

description: Specify a blacklist of disallowed functions


key: function-calc-no-unspaced-operator

description: Disallow an unspaced operator within `calc` functions


key: function-comma-newline-after

description: Require a newline or disallow whitespace after the commas of functions


key: function-comma-newline-before

description: Require a newline or disallow whitespace before the commas of functions


key: function-comma-space-after

description: Require a single space or disallow whitespace after the commas of functions


key: function-comma-space-before

description: Require a single space or disallow whitespace before the commas of functions


Disallow direction values in `linear-gradient()` calls that are not valid according to the standard syntax


key: function-max-empty-lines

description: Limit the number of adjacent empty lines within functions


key: function-name-case

description: Specify lowercase or uppercase for function names


key: items

description: Ignore case of function names


key: function-parentheses-newline-inside

description: Require a newline or disallow whitespace on the inside of the parentheses of functions


key: function-parentheses-space-inside

description: Require a single space or disallow whitespace on the inside of the parentheses of functions


key: function-url-data-uris

description: Require or disallow data URIs for urls


key: function-url-no-scheme-relative

description: Disallow scheme-relative urls


key: function-url-quotes

description: Require or disallow quotes for urls


key: function-url-scheme-whitelist

description: Specify a whitelist of allowed url schemes


key: function-whitelist

description: Specify a whitelist of allowed functions


key: function-whitespace-after

description: Require or disallow whitespace after functions


key: indentation

description: Specify indentation

type: null integer string array

type: integer string object

enum: twice once-at-root-twice-in-block

enum: block param value

enum: inside-parens param value


key: indentInsideParens

description: If `true`, the closing brace of a block (rule or at-rule) will be expected at the same indentation level as the block's inner nodes


key: except

description: Do not indent for these things


key: ignore

description: Ignore the indentation inside parentheses


key: max-empty-lines

description: Limit the number of adjacent empty lines


key: max-line-length

description: Limit the length of a line

type: null integer array

type: integer object

type: string array

enum: non-comments comments


key: max-nesting-depth

description: Limit the allowed nesting depth

enum: blockless-at-rules pseudo-classes


key: no-browser-hacks

description: Disallow browser hacks that are irrelevant to the browsers you are targeting


key: no-descending-specificity

description: Disallow selectors of lower specificity from coming after overriding selectors of higher specificity


key: no-duplicate-selectors

description: Disallow duplicate selectors within a stylesheet


key: no-empty-source

description: Disallow empty sources


key: no-eol-whitespace

description: Disallow end-of-line whitespace


key: no-extra-semicolons

description: Disallow extra semicolons


key: no-indistinguishable-colors

description: Disallow colors that are suspiciously close to being identical


key: whitelist

description: An array of color pairs to ignore. Each pair is an array with two items


key: no-invalid-double-slash-comments

description: Disallow double-slash comments `(//...)` which are not supported by CSS and could lead to unexpected results


key: no-missing-end-of-source-newline

description: Disallow missing end-of-source newlines


key: no-unknown-animations

description: Disallow animation names that do not correspond to a `@keyframes` declaration


key: unicode-bom

description: Require or disallow Unicode BOM


key: no-unsupported-browser-features

description: Disallow features that are unsupported by the browsers that you are targeting


key: keyframe-declaration-no-important

description: Disallow !important within keyframe declarations


key: length-zero-no-unit

description: Disallow units for zero lengths


key: media-feature-colon-space-after

description: Require a single space or disallow whitespace after the colon in media features


key: media-feature-colon-space-before

description: Require a single space or disallow whitespace before the colon in media features


key: media-feature-name-case

description: Specify lowercase or uppercase for media feature names


key: media-feature-name-no-unknown

description: Disallow unknown media feature names


key: media-feature-name-no-vendor-prefix

description: Disallow vendor prefixes for media feature names


key: media-feature-no-missing-punctuation

description: Disallow missing punctuation for non-boolean media features


key: media-feature-parentheses-space-inside

description: Require a single space or disallow whitespace on the inside of the parentheses within media features


Require a single space or disallow whitespace after the range operator in media features


Require a single space or disallow whitespace before the range operator in media features


key: media-query-list-comma-newline-after

description: Require a newline or disallow whitespace after the commas of media query lists


key: media-query-list-comma-newline-before

description: Require a newline or disallow whitespace before the commas of media query lists


key: media-query-list-comma-space-after

description: Require a single space or disallow whitespace after the commas of media query lists


key: media-query-list-comma-space-before

description: Require a single space or disallow whitespace before the commas of media query lists


key: number-leading-zero

description: Require or disallow a leading zero for fractional numbers less than 1


key: number-max-precision

description: Limit the number of decimal places allowed in numbers


key: number-no-trailing-zeros

description: Disallow trailing zeros in numbers


key: property-blacklist

description: Specify a blacklist of disallowed properties


key: property-case

description: Specify lowercase or uppercase for properties


key: property-no-unknown

description: Disallow unknown properties


key: checkPrefixed

description: If `true`, this rule will check vendor-prefixed properties


key: property-no-vendor-prefix

description: Disallow vendor prefixes for properties


key: property-whitelist

description: Specify a whitelist of allowed properties


key: root-no-standard-properties

description: Disallow standard properties inside `:root` rules


key: rule-nested-empty-line-before

description: Require or disallow an empty line before nested rules


key: except

description: Reverse the primary option if the rule is the first in a block


key: ignore

description: Ignore rules that come after a comment


key: rule-non-nested-empty-line-before

description: Require or disallow an empty line before non-nested rules


Require a single space or disallow whitespace on the inside of the brackets within attribute selector


key: selector-attribute-operator-blacklist

description: Specify a blacklist of disallowed attribute operators


key: selector-attribute-operator-space-after

description: Require a single space or disallow whitespace after operators within attribute selectors


Require a single space or disallow whitespace before operators within attribute selectors


key: selector-attribute-operator-whitelist

description: Specify a whitelist of allowed attribute operators


key: selector-attribute-quotes

description: Require or disallow quotes for attribute values


key: selector-class-pattern

description: Specify a pattern for class selectors


key: resolveNestedSelectors

description: This option will resolve nested selectors with `&` interpolation


key: selector-combinator-space-after

description: Require a single space or disallow whitespace after the combinators of selectors


key: selector-combinator-space-before

description: Require a single space or disallow whitespace before the combinators of selectors


Disallow non-space characters for descendant combinators of selectors


key: selector-id-pattern

description: Specify a pattern for id selectors


key: selector-max-compound-selectors

description: Limit the number of compound selectors in a selector


key: selector-max-specificity

description: Limit the specificity of selectors


key: selector-nested-pattern

description: Specify a pattern for the selectors of rules nested within rules


key: selector-no-attribute

description: Disallow attribute selectors


key: selector-no-combinator

description: Disallow combinators in selectors


key: selector-no-id

description: Disallow id selectors


key: selector-no-qualifying-type

description: Disallow qualifying a selector by type

enum: attribute class id


key: selector-no-type

description: Disallow type selectors

enum: compounded descendant


key: selector-no-universal

description: Disallow the universal selector


key: selector-no-vendor-prefix

description: Disallow vendor prefixes for selectors


key: selector-pseudo-class-case

description: Specify lowercase or uppercase for pseudo-class selectors


key: selector-pseudo-class-no-unknown

description: Disallow unknown pseudo-class selectors


Require a single space or disallow whitespace on the inside of the parentheses within pseudo-class selectors


key: selector-pseudo-class-whitelist

description: Specify a whitelist of allowed pseudo-class selectors


key: selector-pseudo-element-case

description: Specify lowercase or uppercase for pseudo-element selectors


key: selector-pseudo-element-colon-notation

description: Specify single or double colon notation for applicable pseudo-elements


key: selector-pseudo-element-no-unknown

description: Disallow unknown pseudo-element selectors


key: selector-root-no-composition

description: Disallow the composition of :root in selectors


key: selector-type-case

description: Specify lowercase or uppercase for type selectors


key: selector-type-no-unknown

description: Disallow unknown type selectors


key: selector-max-empty-lines

description: Limit the number of adjacent empty lines within selectors


key: selector-list-comma-newline-after

description: Require a newline or disallow whitespace after the commas of selector lists


key: selector-list-comma-newline-before

description: Require a newline or disallow whitespace before the commas of selector lists


key: selector-list-comma-space-after

description: Require a single space or disallow whitespace after the commas of selector lists


key: selector-list-comma-space-before

description: Require a single space or disallow whitespace before the commas of selector lists


key: shorthand-property-no-redundant-values

description: Disallow redundant values in shorthand properties


key: string-no-newline

description: Disallow (unescaped) newlines in strings


key: string-quotes

description: Specify single or double quotes around strings


key: stylelint-disable-reason

description: Require a reason comment before or after `stylelint-disable` comments


key: time-no-imperceptible

description: Disallow `animation` and `transition` less than or equal to 100ms


key: unit-blacklist

description: Specify a blacklist of disallowed units


key: unit-case

description: Specify lowercase or uppercase for units


key: unit-no-unknown

description: Disallow unknown units


key: unit-whitelist

description: Specify a whitelist of allowed units


key: value-keyword-case

description: Specify lowercase or uppercase for keywords values


key: ignoreKeywords

description: Ignore case of keywords values


key: value-no-vendor-prefix

description: Disallow vendor prefixes for values


key: value-list-comma-newline-after

description: Require a newline or disallow whitespace after the commas of value lists


key: value-list-comma-newline-before

description: Require a newline or disallow whitespace before the commas of value lists


key: value-list-comma-space-after

description: Require a single space or disallow whitespace after the commas of value lists


key: value-list-comma-space-before

description: Require a single space or disallow whitespace before the commas of value lists


key: value-list-max-empty-lines

description: Limit the number of adjacent empty lines within value lists


key: extends

description: Your configuration can extend an existing configuration(s) (whether your own or a third-party config)


key: plugins

description: Plugins are rules or sets of rules built by the community that support methodologies, toolsets, non-standard CSS features, or very specific use cases


key: customSyntax

description: Specify a custom syntax to use on your code.


key: overrides

description: Provide rule and behavior overrides for files that match particular glob patterns.


key: processors

description: Processors are functions that hook into stylelint's pipeline, modifying code on its way into stylelint and modifying results on their way out


key: ignoreDisables

description: Ignore stylelint-disable (e.g. /* stylelint-disable block-no-empty */) comments.


key: ignoreFiles

description: Provide a glob or array of globs to ignore specific files


key: defaultSeverity

description: The default severity level for all rules that do not have a severity specified in their secondary options


key: reportDescriptionlessDisables

description: Report stylelint-disable comments without a description.


key: reportInvalidScopeDisables

description: Report stylelint-disable comments that don't match rules that are specified in the configuration object.


key: reportNeedlessDisables

description: Report stylelint-disable comments that don't actually match any lints that need to be disabled


key: env

description: Sets the extractStyles property based on the value of NODE_ENV


key: extractStyles

description: Enables/disables extraction of styles to a standalone CSS file using extract-text-webpack-plugin


key: appStyles

description: Import your custom styles here. Usually this endpoint file contains a list of @imports of your application styles.


key: bootstrapCustomizations

description: The .scss file path to be loaded after Bootstrap's _variables.scss file


key: bootstrapVersion

description: The major version of Bootstrap being used


key: loglevel

description: The verbosity of logging. Exclude this property to disable.


key: preBootstrapCustomizations

description: The .scss file path to be loaded before Bootstrap's _variables.scss file


key: scripts

description: Excludes/includes Bootstrap's JavaScript modules


key: styleLoaders

description: An array of Webpack loader names. Order matters, and sass-loader is required.

default: style css sass


key: styles

description: Excludes/includes Bootstrap's CSS modules


key: useCustomIconFontPath

description: Set to true if using a custom icon font and you need to specify its path in your Sass files


key: useFlexbox

description: Enables/disables the flexbox model available in Bootstrap 4


description: Settings file for Ubuntu Autoinstall

required: username hostname password


description: Schema for the swc configuration file

enum: transform-template-literals transform-literals transform-function-name transform-arrow-functions transform-block-scoped-functions transform-classes transform-object-super transform-shorthand-properties transform-duplicate-keys transform-computed-properties transform-for-of transform-sticky-regex transform-dotall-regex transform-unicode-regex transform-spread transform-parameters transform-destructuring transform-block-scoping transform-typeof-symbol transform-new-target transform-regenerator transform-exponentiation-operator transform-async-to-generator proposal-async-generator-functions proposal-object-rest-spread proposal-unicode-property-regex proposal-json-strings proposal-optional-catch-binding transform-named-capturing-groups-regex transform-member-expression-literals transform-property-literals transform-reserved-words proposal-nullish-coalescing-operator proposal-optional-chaining proposal-class-properties proposal-numeric-separator proposal-private-methods transform-unicode-escapes

enum: chrome ie edge firefox safari node ios samsung opera android electron phantom operaMobile

enum: usage entry

enum: commonjs amd umd es6

enum: automatic classic

default: classic


key: featureOrModule

description: CoreJS Module


description: Feature


key: envQuery

description: Query


description: single query


description: multiple queries


key: envQueryOrVersion

description: QueryOrVersion


key: entryPoint

description: Defines an entry point


key: skip

description: Skipped es-features. e.g.: 'core-js/modules/foo'


key: targets

description: EsModules


description: Versions


description: HashMap


key: test

description: Matches the files to include


key: exclude

description: Matches the files to exclude


key: minify

description: If true, swc will minify the output


key: module

description: Describes how swc will transpile the input


key: strict

description: If true, the __esModule property won't be added to the export


key: strictMode

description: If true, swc emits the 'use strict' directive


key: lazy

description: If true, lazy-initialize non local imports (not starting with ./)


description: Lazy-initialize all imports matching one of the given strings


key: items

description: RegEx matching file(s)


key: noInterop

description: Disable the use of interopRequireDefault


key: moduleId

description: If emitting amd-modules and specified, swc emits a named amd module


key: jsc

description: Main Jsc configuration


key: parser

description: Configures the parser


key: jsx

description: If true, transform jsx


key: numericSeparator

description: Support numeric separator proposal (Stage 3)


key: classPrivateProperty

description: Support private class properties


key: privateMethod

description: Support private class methods


key: classProperty

description: Support class properties


key: functionBind

description: Support function bind expression


key: decorators

description: Enable decorators


key: tsx

description: If true, transform tsx


description: If true, transform decorators


key: dts

description: [DISABLED] If true, emit .d.ts files. This flag is currently skipped by serde.


key: noEarlyErrors

description: [DISABLED] This flag is currently skipped by serde.


key: decoratorMetadata

description: If true, decorator metadata is emitted. Make sure "Reflect" is present.


key: useDefineForClassFields

description:
If false, the old behaviour is used and _defineProperty is not generated for class properties.
https://swc.rs/docs/configuration/compilation#jsctransformusedefineforclassfields


key: externalHelpers

description: If true, this option will reduce the filesize by importing from an external module


key: preserveAllComments

description: If true, all comments will be preserved during compilation


key: target

description: Specifies the target environment


key: loose

description: If true, swc generates more efficient code


key: keepClassNames

description:
Preserve original class names
https://swc.rs/docs/configuration/compilation#jsckeepclassnames


key: paths

description: Should reflect "paths" property in project's tsconfig.json . See https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping


key: baseUrl

description: Should reflect "baseUrl" property in project's tsconfig.json . See https://www.typescriptlang.org/docs/handbook/module-resolution.html#base-url


key: minify

description:
Minification options
https://swc.rs/docs/configuration/minification


key: experimental

description:
Experimental options
https://swc.rs/docs/configuration/compilation#jscexperimental


key: keepImportAssertions

description: Preserve import assertions if true. This is experimental because import assertions are not covered by ecmascript specifications yet.


key: plugins

description: A list of plugins to load


key: items

description: A tuple with a plugin name and its options


description: Plugin name


description: Plugin options


key: files

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: exclude

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: include

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: compileOnSave

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


key: extends

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: force

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


key: verbose

description: Enable verbose logging


key: incremental

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


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


key: traceResolution

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


key: watchOptions

description: Settings for the watch mode in TypeScript.


key: watchFile

description: Specify how the TypeScript watch mode works.


key: watchDirectory

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


key: fallbackPolling

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


key: synchronousWatchDirectory

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


key: excludeFiles

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


key: excludeDirectories

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


key: compilerOptions

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

default: .tsbuildinfo

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

default: React

default: react

enum: Classic Node Node16 NodeNext Bundler

enum: crlf lf

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

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling fixedInterval priorityInterval dynamicPriority fixedChunkSize

enum: useFsEvents fixedPollingInterval dynamicPriorityPolling fixedChunkSizePolling

default: useFsEvents

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling useFsEvents useFsEventsOnParentDirectory fixedChunkSizePolling

enum: auto legacy force


key: allowArbitraryExtensions

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


key: allowImportingTsExtensions

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


key: charset

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


key: composite

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


key: customConditions

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


key: declaration

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


key: declarationDir

description: Specify the output directory for generated declaration files.


key: diagnostics

description: Output compiler performance information after building.


key: disableReferencedProjectLoad

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


key: noPropertyAccessFromIndexSignature

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


key: emitBOM

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


key: emitDeclarationOnly

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


key: exactOptionalPropertyTypes

description: Differentiate between undefined and not present when type checking


key: incremental

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


key: tsBuildInfoFile

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


key: inlineSourceMap

description: Include sourcemap files inside the emitted JavaScript.


key: inlineSources

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


key: jsx

description: Specify what JSX code is generated.


key: reactNamespace

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


key: jsxFactory

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


key: jsxFragmentFactory

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


key: jsxImportSource

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


key: listFiles

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


key: mapRoot

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


key: module

description: Specify what module code is generated.


key: moduleResolution

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


key: newLine

description: Set the newline character for emitting files.


key: noEmit

description: Disable emitting file from a compilation.


key: noEmitHelpers

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


key: noEmitOnError

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


key: noImplicitAny

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


key: noImplicitThis

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


key: noUnusedLocals

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


key: noUnusedParameters

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


key: noLib

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


key: noResolve

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


key: noStrictGenericChecks

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


key: skipDefaultLibCheck

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


key: skipLibCheck

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


key: outFile

description: 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.


key: outDir

description: Specify an output folder for all emitted files.


key: preserveConstEnums

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


key: preserveSymlinks

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


key: preserveValueImports

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


key: preserveWatchOutput

description: Disable wiping the console in watch mode


key: pretty

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


key: removeComments

description: Disable emitting comments.


key: rootDir

description: Specify the root folder within your source files.


key: isolatedModules

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


key: sourceMap

description: Create source map files for emitted JavaScript files.


key: sourceRoot

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


key: suppressExcessPropertyErrors

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


key: suppressImplicitAnyIndexErrors

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


key: stripInternal

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


key: target

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


key: useUnknownInCatchVariables

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


key: watch

description: Watch input files.


key: fallbackPolling

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.


key: watchDirectory

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


key: watchFile

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


key: experimentalDecorators

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


key: emitDecoratorMetadata

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


key: allowUnusedLabels

description: Disable error reporting for unused labels.


key: noImplicitReturns

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


key: noUncheckedIndexedAccess

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


key: noFallthroughCasesInSwitch

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


key: noImplicitOverride

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


key: allowUnreachableCode

description: Disable error reporting for unreachable code.


key: forceConsistentCasingInFileNames

description: Ensure that casing is correct in imports.


key: generateCpuProfile

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


key: baseUrl

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


key: paths

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


key: items

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


key: plugins

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


key: name

description: Plugin name.


key: rootDirs

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


key: typeRoots

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


key: types

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


key: traceResolution

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


key: allowJs

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


key: noErrorTruncation

description: Disable truncating types in error messages.


key: allowSyntheticDefaultImports

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


key: noImplicitUseStrict

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


key: listEmittedFiles

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


key: disableSizeLimit

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


key: lib

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


key: moduleDetection

description: Specify how TypeScript determine a file as module.


key: strictNullChecks

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


key: maxNodeModuleJsDepth

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


key: importHelpers

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


key: importsNotUsedAsValues

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

default: remove

enum: remove preserve error


key: alwaysStrict

description: Ensure 'use strict' is always emitted.


key: strict

description: Enable all strict type checking options.


key: strictBindCallApply

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


key: downlevelIteration

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


key: checkJs

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


key: strictFunctionTypes

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


key: strictPropertyInitialization

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


key: esModuleInterop

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


key: allowUmdGlobalAccess

description: Allow accessing UMD globals from modules.


key: keyofStringsOnly

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


key: useDefineForClassFields

description: Emit ECMAScript-standard-compliant class fields.


key: declarationMap

description: Create sourcemaps for d.ts files.


key: resolveJsonModule

description: Enable importing .json files


key: resolvePackageJsonExports

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


key: resolvePackageJsonImports

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


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.


key: extendedDiagnostics

description: Output more detailed compiler performance information after building.


key: listFilesOnly

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


key: disableSourceOfProjectReferenceRedirect

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


key: disableSolutionSearching

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


key: verbatimModuleSyntax

description: 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.


key: typeAcquisition

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


key: enable

description: Enable auto type acquisition


key: include

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


key: exclude

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


key: references

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


key: items

description: Project reference.


key: path

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


key: ts-node

description:
ts-node options.  See also: https://typestrong.org/ts-node/docs/configuration

ts-node offers TypeScript execution and REPL for node.js, with source map support.

default: typescript

enum: explicit node

type: string number

default: First of: `tsconfig.json` "rootDir" if specified, directory containing `tsconfig.json`, or cwd if no `tsconfig.json` is loaded.


key: compiler

description: Specify a custom TypeScript compiler.

type: string


key: compilerHost

description: Use TypeScript's compiler host API instead of the language service API.


key: compilerOptions

description: JSON object to merge with TypeScript `compilerOptions`.

type: object


key: emit

description: Emit output files into `.ts-node` directory.


key: esm

description:
Enable native ESM support.

For details, see https://typestrong.org/ts-node/docs/imports#native-ecmascript-modules


key: experimentalReplAwait

description:
Allows the usage of top level await in REPL.

Uses node's implementation which accomplishes this with an AST syntax transformation.

Enabled by default when tsconfig target is es2018 or above. Set to false to disable.

**Note**: setting to `true` when tsconfig target is too low will throw an Error.  Leave as `undefined`
to get default, automatic behavior.


key: experimentalResolver

description:
Enable experimental features that re-map imports and require calls to support:
`baseUrl`, `paths`, `rootDirs`, `.js` to `.ts` file extension mappings,
`outDir` to `rootDir` mappings for composite projects and monorepos.

For details, see https://github.com/TypeStrong/ts-node/issues/1514


key: experimentalSpecifierResolution

description:
Like node's `--experimental-specifier-resolution`, , but can also be set in your `tsconfig.json` for convenience.

For details, see https://nodejs.org/dist/latest-v18.x/docs/api/esm.html#customizing-esm-specifier-resolution-algorithm


key: files

description:
Load "files" and "include" from `tsconfig.json` on startup.

Default is to override `tsconfig.json` "files" and "include" to only include the entrypoint script.


key: ignore

description:
Paths which should not be compiled.

Each string in the array is converted to a regular expression via `new RegExp()` and tested against source paths prior to compilation.

Source paths are normalized to posix-style separators, relative to the directory containing `tsconfig.json` or to cwd if no `tsconfig.json` is loaded.

Default is to ignore all node_modules subdirectories.

type: array


key: ignoreDiagnostics

description: Ignore TypeScript warnings by diagnostic code.


key: logError

description: Logs TypeScript errors to stderr instead of throwing exceptions.

type: boolean


key: moduleTypes

description:
Override certain paths to be compiled and executed as CommonJS or ECMAScript modules.
When overridden, the tsconfig "module" and package.json "type" fields are overridden, and
the file extension is ignored.
This is useful if you cannot use .mts, .cts, .mjs, or .cjs file extensions;
it achieves the same effect.

Each key is a glob pattern following the same rules as tsconfig's "include" array.
When multiple patterns match the same file, the last pattern takes precedence.

`cjs` overrides matches files to compile and execute as CommonJS.
`esm` overrides matches files to compile and execute as native ECMAScript modules.
`package` overrides either of the above to default behavior, which obeys package.json "type" and
tsconfig.json "module" options.


key: preferTsExts

description:
Re-order file extensions so that TypeScript imports are preferred.

For example, when both `index.js` and `index.ts` exist, enabling this option causes `require('./index')` to resolve to `index.ts` instead of `index.js`


key: pretty

description: Use pretty diagnostic formatter.


key: require

description:
Modules to require, like node's `--require` flag.

If specified in `tsconfig.json`, the modules will be resolved relative to the `tsconfig.json` file.

If specified programmatically, each input string should be pre-resolved to an absolute path for
best results.


key: scope

description: Scope compiler to files within `scopeDir`.


key: skipIgnore

description: Skip ignore check, so that compilation will be attempted for all files with matching extensions.


key: swc

description:
Transpile with swc instead of the TypeScript compiler, and skip typechecking.

Equivalent to setting both `transpileOnly: true` and `transpiler: 'ts-node/transpilers/swc'`

For complete instructions: https://typestrong.org/ts-node/docs/transpilers


key: transpileOnly

description: Use TypeScript's faster `transpileModule`.


key: transpiler

description: Specify a custom transpiler for use with transpileOnly


key: typeCheck

description: **DEPRECATED** Specify type-check is enabled (e.g. `transpileOnly == false`).


key: cve-id

description: CVE IDs for the template


key: cwe-id

description: CWE IDs for the template


key: cvss-metrics

description: CVSS Metrics for the template


key: cvss-score

description: CVSS Score for the template

type: number


key: epss-score

description: EPSS Score for the template


key: epss-percentile

description: EPSS Percentile for the template


key: cpe

description: CPE for the template


key: name

description: Name is a short summary of what the template does


key: author

description: Author is the author of the template


key: tags

description: Any tags for the template


key: description

description: In-depth explanation on what the template does

examples: Bower is a package manager which stores package information in the bower.json file


key: reference

description: Links relevant to the template


key: metadata

description: Additional metadata fields for the template


key: classification

description: Classification information for the template


key: remediation

description: In-depth explanation on how to fix the issues found by the template

examples: Change the default administrative username and password of Apache ActiveMQ by editing the file jetty-realm.properties


description: Seriousness of the implications of the template

enum: info low medium high critical unknown


description: userAgent for the headless http request

enum: off default custom


description: Name of the extractor


key: regex

description: Regex to extract from part


key: group

description: Group to extract from regex

type: integer


key: kval

description: Kval pairs to extract from response


key: json

description: JSON JQ expressions to evaluate from response part


key: xpath

description: XPath allows using xpath expressions to extract items from html response


key: attribute

description: Optional attribute to extract from response XPath


key: dsl

description: Optional attribute to extract from response dsl


key: part

description: Part of the request response to extract data from


key: internal

description: Internal when set to true will allow using the value extracted in the next request for some protocols


key: case-insensitive

description: use case insensitive extract


key: to

description: save extracted values to file


description: Type of the extractor

enum: regex kval xpath json dsl


key: type

description: Type of the matcher


key: condition

description: Condition between the matcher variables

enum: and or


description: Part of response to match data from


key: negative

description: Negative specifies if the match should be reversed. It will only match if the condition is not true


key: name

description: Name of the matcher


key: status

description: Status to match for the response


key: size

description: Size is the acceptable size for the response


key: words

description: Words contains word patterns required to be present in the response part


key: regex

description: Regex contains regex patterns required to be present in the response part


key: binary

description: Binary are the binary patterns required to be present in the response part


description: DSL are the dsl expressions that will be evaluated as part of nuclei matching rules


key: encoding

description: Optional encoding for the word fields


description: use case insensitive match


key: match-all

description: match all matcher values ignoring condition


description: Type of the matcher

enum: word regex binary status size dsl


description: Type of fuzzing rule to perform

enum: replace prefix postfix infix


description: Part of request rule to fuzz


key: mode

description: Mode of request rule to fuzz

enum: single multiple


key: keys

description: Keys of parameters to fuzz


key: keys-regex

description: Regex of parameter keys to fuzz


key: values

description: Regex of parameter values to fuzz


key: fuzz

description: Payloads to perform fuzzing substitutions with


description: Type of the attack

enum: batteringram pitchfork clusterbomb


description: Additional variables for the request


description: Type is the type of DNS request to make

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


key: matchers

description: Detection mechanism to identify whether the request was successful by doing pattern matching


key: extractors

description: Extractors contains the extraction mechanism for the request to identify and extract parts of the response


key: matchers-condition

description: Conditions between the matchers


key: id

description: ID is the optional ID of the DNS Request


key: name

description: Name is the Hostname to make DNS request for


key: type

description: Type is the type of DNS request to make


key: class

description: Class is the class of the DNS request

enum: inet csnet chaos hesiod none any


key: retries

description: Retries is the number of retries for the DNS request


key: trace

description: Trace performs a trace operation for the target.


key: trace-max-recursion

description: TraceMaxRecursion is the number of max recursion allowed for trace operations


key: attack

description: Attack is the type of payload combinations to perform


key: payloads

description: Payloads contains any payloads for the current request


key: recursion

description: Recursion determines if resolver should recurse all records to get fresh results


key: resolvers

description: Define resolvers to use within the template


key: extensions

description: List of extensions to perform matching on


key: denylist

description: List of files


description: ID is the optional ID for the request


key: max-size

description: Maximum size of the file to run request on


key: archive

description: Process compressed archives without unpacking


key: mime-type

description: Filter files by mime-type


key: no-recursive

description: Specifies whether to not do recursive checks if folders are provided


key: id

description: Optional ID of the headless request


key: steps

description: List of actions to run for headless request


User agent for the headless request


description: Custom user agent for the headless request


key: stop-at-first-match

description: Stop the execution after a match is found


key: matchers

description: Detection mechanism to identify whether the request was successful by doing pattern matching


key: extractors

description: Extractors contains the extraction mechanism for the request to identify and extract parts of the response


key: matchers-condition

description: Conditions between the matchers


key: fuzzing

description: Fuzzing describes rule schema to fuzz headless requests


key: cookie-reuse

description: Optional setting that enables cookie reuse


key: args

description: Args contain arguments for the headless action


key: name

description: Name is the name assigned to the headless action


key: description

description: Description of the headless action


key: action

description: Type of actions to perform


description: Type of actions to perform

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


description: Method is the HTTP Request Method

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


key: path

description: Path(s) to send http requests to


key: raw

description: HTTP Requests in Raw Format


description: ID for the HTTP Request


description: Optional name for the HTTP Request


key: attack

description: Attack is the type of payload combinations to perform


key: method

description: Method is the HTTP Request Method


key: body

description: Body is an optional parameter which contains HTTP Request body


key: payloads

description: Payloads contains any payloads for the current request


key: headers

description: Headers contains HTTP Headers to send with the request


description: Number of times to send a request in Race Condition Attack


key: max-redirects

description: Maximum number of redirects that should be followed


key: pipeline-concurrent-connections

description: Number of connections to create during pipelining


key: pipeline-requests-per-connection

description: Number of requests to send per connection when pipelining


key: threads

description: Threads specifies number of threads to use sending requests. This enables Connection Pooling


key: max-size

description: Maximum size of http response body to read in bytes


key: fuzzing

description: Fuzzing describes rule schema to fuzz http requests


key: signature

description: Signature is the HTTP Request signature Method


key: cookie-reuse


key: read-all

description: Enables force reading of entire unsafe http request body


key: redirects

description: Specifies whether redirects should be followed by the HTTP Client


key: host-redirects

description: Specifies whether redirects to the same host should be followed by the HTTP Client


key: pipeline

description: Pipeline defines if the attack should be performed with HTTP 1.1 Pipelining


key: unsafe

description: Unsafe specifies whether to use rawhttp engine for sending Non RFC-Compliant requests


key: race

description: Race determines if all the request have to be attempted at the same time (Race Condition)


key: req-condition

description: Automatically assigns numbers to requests and preserves their history


key: stop-at-first-match

description: Stop the execution after a match is found


key: skip-variables-check

description: Skips the check for unresolved variables in request


key: iterate-all

description: Iterates all the values extracted from internal extractors


key: digest-username

description: Optional parameter which specifies the username for digest auth


key: digest-password

description: Optional parameter which specifies the password for digest auth


key: disable-path-automerge

description: Disable merging target url path with raw request path


description: Type of the signature


key: data

description: Data is the data to send as the input


key: type

description: Type of input specified in data field


key: read

description: Number of bytes to read from socket


key: name

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


description: description=Type of input specified in data field

enum: hex text


key: id

description: ID of the network request


key: host

description: Host to send network requests to


key: attack

description: Attack is the type of payload combinations to perform


key: payloads

description: Payloads contains any payloads for the current request


key: inputs

description: Inputs contains any input/output for the current request


key: read-size

description: Size of response to read at the end. Default is 1024 bytes


key: read-all

description: Read all response stream till the server stops sending


key: matchers

description: Detection mechanism to identify whether the request was successful by doing pattern matching


key: extractors

description: Extractors contains the extraction mechanism for the request to identify and extract parts of the response


key: matchers-condition

description: Conditions between the matchers


key: address

description: Address contains address for the request


description: Minimum tls version - automatic if not specified.


description: Max tls version - automatic if not specified.


description: Scan Mode - auto if not specified.

enum: ctls ztls auto


description: Data is the data to send as the input


key: headers

description: Headers contains headers for the request


key: query

description: Query contains query for the request


key: server

description: Server contains the server url to execute the WHOIS request on


description: The Unique ID for the template


key: info

description: Info contains metadata for the template


key: requests

description: HTTP requests to make for the template


key: http

description: HTTP requests to make for the template


key: dns

description: DNS requests to make for the template


key: file

description: File requests to make for the template


key: network

description: Network requests to make for the template


key: tcp


key: headless

description: Headless requests to make for the template


key: ssl

description: SSL requests to make for the template


key: websocket

description: Websocket requests to make for the template


key: whois

description: WHOIS requests to make for the template


key: workflows

description: List of workflows to execute for template


key: self-contained

description: Mark Requests for the template as self-contained


key: stop-at-first-match

description: Stop at first match for the template


key: signature

description: Signature is the HTTP Request signature Method


key: variables

description: Variables contains any variables for the current request


key: constants

description: constants contains any constant for the template


key: name

description: Name of items to match


key: condition

description: Condition between the names


key: subtemplates

description: Templates to run after match


key: template

description: Template or directory to execute as part of workflow


key: tags

description: Tags to run template based on


key: matchers

description: Matchers perform name based matching to run subtemplates for a workflow


description: Subtemplates are ran if the template field Template matches


description:
Settings of the current application
https://bashly.dannyb.co/usage/settings/#settings

default: src

default: lib

enum: development production

default: development

default: sh


description:
A directory with source files of the current script
https://bashly.dannyb.co/usage/settings/#source_dir


description:
A path to bashly.yml of the current script
https://bashly.dannyb.co/usage/settings/#config_path


description:
A directory of the current script
https://bashly.dannyb.co/usage/settings/#target_dir


description:
A directory to common library files of the current script
https://bashly.dannyb.co/usage/settings/#lib_dir


description:
A directory to nested command files of the current script
https://bashly.dannyb.co/usage/settings/#commands_dir


key: strict

description:
Bash initialiation options of the current script
https://bashly.dannyb.co/usage/settings/#strict


description:
Whether to use tabs in the the current script
https://bashly.dannyb.co/usage/settings/#tab_indent


description:
Whether to expand short flags of the current script
https://bashly.dannyb.co/usage/settings/#compact_short_flags


key: env

description:
Whether to include development related comments in the current script
https://bashly.dannyb.co/usage/settings/#env


description:
A partial snippet extension of the current script
https://bashly.dannyb.co/usage/settings/#partials_extension


description:
Usage colors of the current script
https://bashly.dannyb.co/usage/settings/#usage_colors


key: caption

description:
A caption color of the current script
https://bashly.dannyb.co/usage/settings/#usage_colors


key: command

description:
A command color of the current script
https://bashly.dannyb.co/usage/settings/#usage_colors


key: arg

description:
An argument color of the current script
https://bashly.dannyb.co/usage/settings/#usage_colors


key: flag

description:
A flag color of the current script
https://bashly.dannyb.co/usage/settings/#usage_colors


An environment variable color of the current script
https://bashly.dannyb.co/usage/settings/#usage_colors


description: MTA extension descriptor schema v3.3

required: _schema-version ID extends


description: The name of the existing hook that will be modified by this extension.


key: parameters

description: Configuration parameters that are used when executing the hook to the target runtime environment.


key: requires

description: List of the existing required dependencies that will be modified by this extension.


description: The name of the existing required dependencies that will be modified.


description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the hook at runtime. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string


description: Used to indicate to an MTA processing tool (e.g. a deployer), which schema version was taken as the base when authoring a descriptor.


key: ID

description: A globally unique ID of this MTA extension descriptor. Unlimited string of unicode characters.


key: extends

description: A globally unique ID of the MTA or the MTA extension which shall be extended by this descriptor.


key: description

description: A non-translatable description of this MTA extension. This is not a text for application users.


key: provider

description: The provider or vendor.


description: Global parameters that will be added to the application.


key: hooks

description: A list of the existing hooks that will be modified by the extension.


key: modules

description: List of the existing modules that will be modified by the extension.


key: name

description: The module name which must match an existing module defined by the deployment descriptor.


key: properties

description: A collection of key-value pairs that are available to the module at runtime.


description: Configuration parameters that are used when deploying the module to the target runtime environment.


description: List of the existing required dependencies that will be modified by the extension.


description: The dependency name which must match an existing required dependency defined by the deployment descriptor.


description: Required properties can be mapped from provided properties. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string


description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the module at runtime. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string


key: provides

description: List of the existing provided dependencies that will be modified by the extension.


description: The dependency name which must match an existing provided dependency defined by the deployment descriptor.


description: Property names and values make up the configuration data which is to be provided to requiring modules at runtime


key: resources

description: List of the existing resources that will be modified by the extension.


description: The resource name which must match an existing resource defined by the deployment descriptor.


key: active

description: If a resource is declared to be active, it is allocated and bound according to declared requirements. Default value is true.


description: Property names and values make up the configuration data which is to be provided to requiring modules at runtime.


description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to requiring modules at runtime. Untyped resources cannot have parameters.


description: List of existing hooks that will be modified by the extension.


description: The name of the existing required dependency that will be modified.


description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the resource at runtime. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string


key: module-types

description: A list of existing module type definitions that will be modified by the extension.


description: The name of the existing module type that will be modified.


description: A collection of key-value pairs that will be inherited by all modules of this type.


description: Configuration parameters that will be inherited in all modules of this type.


key: resource-types

description: A list of existing resource type definitions that will be modified by the extension.


description: The name of the existing resource type that will be modified.


description: Configuration parameters that will be inherited in all resources of this type.


description: Tikibase configuration data


key: $schema

description: link to the JSON-Schema definition for this file


key: bidiLinks

description: enables bi-directional links


key: ignore

description: Names of filesystem entries to ignore in this directory.


key: sections

description: the allowed section titles


key: standaloneDocs

description: whether documents without links are allowed


key: titleRegEx

description: regex with a single capture group to extract a shorter title for links to notes


description: This is a JSON schema representation of the schema.org Action schema: https://schema.org/ContactPoint

format: regex

pattern: ContactPoint

enum: HearingImpairedSupported TollFree

format: email


description: override the @context property to ensure the schema.org URI is used


description: override the @type property to ensure ContactPoint is used


key: areaServed

description: The geographic area where a service or offered item is provided. Supersedes serviceArea.


key: items

description: AdministrativeArea


description: GeoShape


description: Place


description: AdministrativeArea


description: GeoShape


description: Place


key: availableLanguage

description: A language someone may use with the item. Please use one of the language codes from the IETF BCP 47 standard. See also inLanguage


description: Language


description: Language


key: contactOption

description: An option available on this contact point (e.g. a toll-free number or support for hearing-impaired callers).


key: contactType

description: A person or organization can have different contact points, for different purposes. For example, a sales contact point, a PR contact point and so on. This property is used to specify the kind of contact point.


key: email

description: Email address.


key: faxNumber

description: The fax number.


key: hoursAvailable

description: The hours during which this service or contact is available. (OpeningHoursSpecification)


key: productSupported

description: The product or service this support contact point is related to (such as product support for a particular product line). This can be a specific product or product line (e.g. "iPhone") or a general category of products or services (e.g. "smartphones").


description: Product


description: Product


key: telephone

description: The telephone number.


description: A comment to ignore


key: name

description: The egg's name


key: author

description: The egg's author


key: description

description: The egg's description


key: features

description: A list of features to use


description: Object containing key-value pairs of a pretty Docker image name and its URL


key: startup

description: Command to run on startup

x-intellij-language-injection: Shell Script


key: config

description: Object to store configuration


key: scripts

description: A list of possible scripts to execute


key: container

description: Container to run script in


key: entrypoint

description: Entrypoint of script


key: variables

description: Object of variables that can be used to change the startup command


description: Name of the variable.


description: Description of the variable.


description: The environment variable that corresponds to this variable. This can be referenced in the startup command.


description: Default value of the variable.


description: Setting to true allows a user to view the field on the front-end, as well as the assigned value of that variable. They will be able to see it replaced in their startup command.


description: Set to true if the variable is editable by the user


key: rules

description: Rules to validate the variable against.


description: A document describing calculations to be done on biomechanical data for presentation in a report.

line_endings: unix

type: string array null

type: string boolean

required: convert from to


key: parameter

description: A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.


key: space


key: event


key: marker


key: segment


key: steps

description: A step node takes an input and some options and outputs a value.


key: items

description:
The angle step performs slightly different operation depending on the type and number of inputs.

Note: _For cases where multiple inputs are given of varying lengths, the returning array will be the maximum length and the last value will be repeated for the shorter inputs to fill the gap._

One input: `` Computes the euler angle of the specified segment, in degrees.

Two inputs: (, ) | (, ) Given two segments: Computes the relative (euler) angle between the specified segments, in degrees.

Given two vectors: Computes relative angle between the specified vectors, in radians.

Three inputs: , ,  Computes the angle between the two vectors defined by the specified points (v0 -> v1, v1 -> v2), in radians. The points can be specified as arrays or with named vector signals (ie markers).

Given the inputs v1, v2 and v3, the resulting angle is given by:

angleBetween(v1 - v0, v1 - v2)

Four inputs: , , ,  Computes the angle between the two lines formed by (v0 -> v1, v2 -> v3), in radians. The points can be specified as arrays or with named vector signals (ie markers).


key: angle


description:
This step calculates the joint angular velocity based on the textbook Research Methods in Biomechanics (2nd Edition).

You can visit http://www.kwon3d.com/theory/euler/avel.html for more details.

This is different from calculating the first-order derivate of the joint angle because each axis of the joint angle are different from the axes of the segment coordinate systems.

**Please consider which implementation would be correct to use in your instance**.


key: angularVelocity


key: useRotationOrder

description:
If set to false it means that the angular velocity between the segment and refernce segment is transformed to be expressed into the resolution coordinate system.

If set to true it means that angular velocity between the segment and refernce segment is transformed to be expressed into the joint coordinate system using the Euler/Cardan sequence.


description: Performs the same computation as angle, but does not handle three or four inputs.


key: jointAngle


description: Performs the same computation as angularVelocity.


key: jointAngleVelocity


description: Counts the number of values in the input, i.e. the number of frames in a series, or the number of values in a scalar or event input.


key: count


description: Outputs the max value of the input.


key: max

description: Outputs the max value of the input.


key: frames

description: If set to true, this step returns the frame index for the maximum value of the input. If using cycles, it will return a frame per cycle.


description: Outputs the mean value of the input.


key: mean

description: Outputs the mean value of the input.


description: Outputs the median value of the input.


key: median

description: Outputs the median value of the input.


description: Outputs the minimum value of the input.


key: min

description: Outputs the minimum value of the input.


description: If set to true, this step returns the frame index for the minimum value of the input. If using cycles, it will return a frame per cycle.


description: Outputs the range between the minimum and maximum value of the input.


key: range


description: Outputs the Root Mean Square (root of the average squared deviations) between two arrays.


key: rms


description: Outputs the standard deviation value of the input.


key: standardDeviation


key: stdDev


description: Outputs the sum of all values of the input.


key: sum


key: items

description: Adds the input operands.


key: add

description: Adds the input operands.


description: Divides the input operands.


key: divide

description: Divides the input operands.


description: Multiplies the input operands.


key: multiply

description: Multiplies the input operands.


description: Subtracts the input operands.


key: subtract

description: Subtracts the input operands.


description:
Accepts marker or segment sequences and calculates the distance between the points (Euclidian norm).

It assumes that the values are comparable by index. If the sequence length differs, the calculation will be done up until the shortest length of the input sequences.


key: distance


description: Accepts a vector or a segment sequence and calculates the magnitude of it (Euclidian norm).


key: magnitude


description:
Takes three marker or segment sequences and returns the plane which intersects all three points.

It assumes that the values are comparable by index. If the sequence length differs, the calculation will be done up until the shortest length of the input sequences.


key: plane


description:
Orthogonally projects a point onto a plane and returns the location of the projected point.

Note: *The plane will remain in the space used when creating it, applying a space to the project step will apply the space to the vector / segment, but the plane will be left untouched.*


key: project


description: Calculates the unit vector i.e. the new vector has the same direction of the input vector but its norm equals 1.


key: unitVector


description: Outputs the absolute value for each value in the input signal.


key: abs


description: For each value of the input, converts it according to the units defined in the from and to options.


key: convert


key: from

description: Defines the unit to convert from.


key: to

description: Defines the unit to convert to.


description: Outputs the difference between each value in the input. Since this compares value n with n+1, the output signal will be shorter by one item.


key: diff


description:
Calculates the dot product between two vectors.

The output length will be equal to the length of the first vector sequence.

The second vector sequence needs to be singular or equal to the first vector sequence in length.

A lone vector in the second input will be used to calculate the dot product between itself and all vectors contained in the first vector sequence.


key: dotProduct


key: dot


key: items

description:
Outputs a resulting signal of the same type as the input signal where gaps are filled using interpolation.

Note: *Gaps at the beginning or end of the signal will not be interpolated.*


key: gapFill


description: Returns the cumulative integral between neighboring frames in a data series, using the trapezoidal rule. It returns a series by default.


key: integral


key: scalar

description: Returns the integral as a single value scalar.


key: useCycles

description:
If the signal has cycles defined, the integral step will be run separately over each signal, and a list of values are returned, one for each cycle.

To avoid this behaviour, set useCycles to false.

For information on how to set event cycles on a signal, see the eventMask step.


description: Outputs the negated value for each value in the input signal.


key: negate


description:
Outputs a resulting signal of the same type as the input signal where every value is rounded to the specific precision.

The precision is specified as the number of decimal places to include in the result.


key: round


description:
Derives the input signal to the second order.

Note: _Due to the temporal nature of this operation, the resulting first and last frames will be null._

Note: _This operation will split the series on gaps and derive each "slice" individually. The first and last frame on each "slice" will be null._


key: acceleration


description:
Derives the input signal to the order defined in input 2. If input 2 is not set, the signal is derived to order 1.

Only the first and second order is supported.

Note: _Due to the temporal nature of this operation, the resulting first and last frames will be null._

Note: _This operation will split the series on gaps and derive each "slice" individually. The first and last frame on each "slice" will be null._


key: derivative


description:
Derives the input signal to the first order.

Note: _Due to the temporal nature of this operation, the resulting first and last frame will be null._

Note: _This operation will split the series on gaps and derive each "slice" individually. The first and last frame on each "slice" will be null._


key: velocity


description: Runs a Butterworth IIR high-pass filter over the input data.


key: highpass


key: extrapolate

description:
Extrapolation buffer. Defines how many frames to add on either side of the series, useful if the filter handles the edges of the series strangely.

Leading and trailing NaN values are removed before extrapolation, i.e., extrapolation begins from the first and last real value. NaN values are then re-inserted in the original places for the output.

Extrapolation is made by looking at the first and second values, and the last and second-to-last values, respectively. The buffer is then filled with values linearly extrapolated from these two points.


key: iterations

description: Defines how many times to apply the filter in sequence. If the iterations is set to anything other than 1, the filter will be applied multiple times, using the output of the previous iteration as the input for the next.


key: cutoff

description: Defines around what frequency to limit the filter. The filter will attenuate frequencies below this value.


key: order

description: Defines the filter order. The higher the order, the steeper the attenuation slope will be.


description: Runs a Butterworth IIR low-pass filter over the input data.


key: lowpass


description: Defines around what frequency to limit the filter. The filter will attenuate frequencies above this value.


description: Outputs the arc cosine (or inverse cosine) for each value in the input signal.


key: acos


key: items

description: Outputs the arcsine (or inverse sine) for each value in the input signal.


key: asin


description: Outputs the arctangent (or inverse sine) for each value in the input signal.


key: atan


description: Outputs the the angle (in radians) from the X axis to a point for each value in the input signal.


description: Outputs the cosine for each value in the input signal.


key: cos


description: Outputs the hyperbolic cosine for each value in the input signal.


key: cosh


description: Outputs the cotangent for each value in the input signal.


key: cotan


description: Outputs the sine for each value in the input signal.


key: sin


description: Outputs the hyperbolic sine for each value in the input signal.


key: sinh


description: Outputs the tangent for each value in the input signal.


key: tan


description: Outputs the hyperbolic tangent for each value in the input signal.


key: tanh


description:
Runs a logical expression. The return value is determined by the result of the expression, and the then and else options.

The following operators are supported:

  >=

Parentheses can be used to influence the order of evaluation.

Only numbers and single-element arrays can be part of the expression.

required: if then else


key: if


description: Imports an event by name.


key: event

description: Imports an event by name.


description: Generic import of any input by name.


key: import

description: Generic import of any input by name.


description: Imports a marker series by name or creates a new signal with a custom origin.


key: marker


key: origin

description: This option can be used to create a new marker signal, with a custom x, y and z coordinate.


description: Imports a segment series by name.


key: segment

description: Imports a segment series by name.


description:
This step takes 2 event inputs and outputs an array of durations (in seconds).

Inputs 1 and 2 will be combined into pairs - from values in input 1 to values in input 2.

The duration is calculated using the frame rate from either the "from", or "to" input event.


key: eventDuration


key: items

description:
This is a step which takes a signal and 2 event inputs and outputs a filtered signal with values only appearing in between the events.

Inputs 2 and 3 will be combined into pairs from values in input 2 to values in input 3.

These pairs can be used to filter the values in input 1.

These event pairs, or cycles are also stored on the resulting signal, which can be used in aggregations to aggregate over event cycles. The signal will keep the cycle information no matter if the signal was truncated or not.

If the signal input is an event, only event frames that is within the span of one of the event pairs will be returned.

The optional parameter replacement will, if set, replace masked values with the given value. If replacement is not set and truncate is true – the masked values will be removed. The replacement property has no effect when the signal input is an event.

If replacement is not set and truncate is false (default behavior), the output signal is untouched, except that the event cycles are annotated on the signal.

type: string number array


key: eventMask


key: keep

description:
An index or an array of indices of events in each cycle to keep. This allows you to keep only a subset of event instances in each cycle.

Negative numbers can be used to count from the end of the cycle, e.g. -1 is the last event in the cycle.

Note: This only applies to event inputs.


key: replacement

description:
Replacement value to use for masked values. If not set, masked values will be removed from the output signal.

The replacement property has no effect when the signal input is an event.


key: truncate

description:
Whether or not the signal should be truncated, i.e., if values that were not within an "event pair" should be removed or not.

This will only apply if replacement does not have a value.


description:
This step takes an event input and converts each frame value to a time value (in seconds).

The time is calculated using the frame rate from the signal.


key: eventTime


description:
This step allows you to easily pick out frames from an event only when they appear in a specific sequence of other events.

The main input of this step is the event you want to select frames from.

The required option sequence defines a sequence of events to happen in order. This option requires at least one instance of the main input event (otherwise, no event would be able to be picked from the sequence).

Multiple instances of the main input event can be supplied to the sequence to enable more complex patterns of events.

The optional option exclude defines events that cannot occur in a sequence. If it does, the sequence is invalidated, meaning no events will be picked from this sequence.

The exclude option cannot contain any signals defined in the sequence option.

The optional option cyclic defines whether or not the sequence should be treated as cyclic, i.e., if the sequence starts and ends with the same events, those events are included in the next "match-finding" iteration of the sequence. This is useful for refining event cycles where the end event is the start event of the next cycle.

The cyclic option is true by default and has to be explicitly set to false to disable.

required: refineEvent sequence


key: refineEvent


key: sequence

description: A sequence of events. This must include at least one instance of the main input event.


key: exclude

description: Event(s) that will invalidate an event sequence if found within it.


key: cyclic

description: Whether or not to treat sequences as cyclic (true as default).


description:
Find peaks inside a signal based on peak properties.

At first, it will detect any peak-like features in the signal. If any of the options distance, height, prominence, or width is defined, it will use those properties to filter out peaks that match the criteria.

As a last step, if the sequence option is used, it will match the peaks against a sequence to return a subset of the peaks.

As a general rule, the peakFinder step is sensitive to noise in the data, so if noise is expected, first run the data through a low-pass filter.

Based on the SciPy find_peaks function.


key: peakFinder


key: distance

description:
Required minimal horizontal distance (>= 1) in samples between neighbouring peaks.

Smaller peaks are removed first until the condition is fulfilled for all remaining peaks.


key: height

description: Required height of peaks. Either a number or a 2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required height.


key: prominence

description: Required prominence of peaks. Either a number or a 2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required prominence.


key: relHeight

description:
Used for calculation of the peaks width, thus it is only used if width is given.

Chooses the relative height at which the peak width is measured as a percentage of its prominence. 1.0 calculates the width of the peak at its lowest contour line while 0.5 evaluates at half the prominence height. Must be at least 0.


description:
Allows to classify peaks using a pattern and select peaks from the pattern to use as the output.

See below for further information.


key: ranges

description:
Classification of the peak heights. This option expects a string consisting of 1-character labels separated by a boundary value.

The boundary values represent a percentage between 0 – 100 which defined the end of the previous label's range and the beginning of the next label's range.

The entire range 0 – 100 represents the difference between the lowest peak and the highest peak. All peaks will be somewhere in this range, and the ranges option allows you to customize how the peaks are labelled.

The default ranges value is: L 50 H. This labels the peaks that end up in the bottom 50% of the peak heights as L, and the remaining top 50% as H.

The syntax, L 50 H, is equivalent to writing 0 L 50 H 100.

The outer boundaries 0 and 100 is assumed though and are not required.

If you would like to classify the peaks into three groups, the bottom 25% as L, the top 25% and H, and anything in between as M, you can supply the following string: L 25 M 75 H.

The labels used should each be 1 character long, but can be whatever you want as long as it corresponds to the pattern used in the pattern option.


key: pattern

description:
A pattern describing a sequence of classified peak heights using the labels defined in the ranges option.

If you have supplied the ranges string L 50 H, and you want to find the following sequence of peaks: "a low peak followed by a low peak followed by a high peak, you can define the pattern as LLH.

Each matching pattern sequence is stored and the pattern indices in keep determines which of the peaks that are returned.


description:
An array of indices from the pattern labels to keep in the output. The index is zero-based, i.e., the first item in the sequence pattern is 0, the last in the sequence is the (length of the pattern) - 1.

If the pattern was defined as LLH and we wanted to keep only the first (low) peak in each matching sequence, we would set keep to [0].

Conversely if we wanted to keep the last (high) peak in each sequence, the keep should be [2].

To keep both the first and last peaks in the sequence, the keep option should be set to [0, 2].

Peaks in the sequence pattern not indexed by keep will be ignored in the output.


key: width

description:
Required width of peaks in samples. Either a number or a
2-element array. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required width.


key: window

description:
Used for calculation of the peaks prominences, thus it is only used if one of the arguments prominence or width is given.

A window length in samples that optionally limits the evaluated area for each peak to a subset of x. The peak is always placed in the middle of the window therefore the given length is rounded up to the next odd integer. This parameter can speed up the calculation.


key: items

description:
This step will register an event for every frame where the signal passes the specified threshold value.

By default, an event is registered when the signal crosses the threshold in either an ascending or descending direction.

By configuring the direction option, you can specify a certain direction that will trigger the event; up (ascending) or down (descending).


key: threshold


key: value

description: The threshold value to use.