From 8f2d45eafdbc54b6231b3b0fba5f1bdf3c57c667 Mon Sep 17 00:00:00 2001 From: Yaroslav Admin Date: Thu, 4 Oct 2018 21:06:39 +0200 Subject: [PATCH] Added types for Karma 3.0 (#29386) * Added type definitions for karma 3.0 * Fixed lint errors * Suppressed error instead of disabling rule completely --- types/karma/index.d.ts | 56 ++-- types/karma/karma-tests.ts | 33 +-- types/karma/package.json | 6 + types/karma/tslint.json | 78 +----- types/karma/v1/index.d.ts | 485 ++++++++++++++++++++++++++++++++++ types/karma/v1/karma-tests.ts | 130 +++++++++ types/karma/v1/tsconfig.json | 26 ++ types/karma/v1/tslint.json | 79 ++++++ 8 files changed, 764 insertions(+), 129 deletions(-) create mode 100644 types/karma/package.json create mode 100644 types/karma/v1/index.d.ts create mode 100644 types/karma/v1/karma-tests.ts create mode 100644 types/karma/v1/tsconfig.json create mode 100644 types/karma/v1/tslint.json diff --git a/types/karma/index.d.ts b/types/karma/index.d.ts index 4b71c0a723..ba258f0997 100644 --- a/types/karma/index.d.ts +++ b/types/karma/index.d.ts @@ -1,15 +1,17 @@ -// Type definitions for karma 1.7 +// Type definitions for karma 3.0 // Project: https://github.com/karma-runner/karma // Definitions by: Tanguy Krotoff // James Garbutt +// Yaroslav Admin // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 /// -// See Karma public API https://karma-runner.github.io/0.13/dev/public-api.html +// See Karma public API https://karma-runner.github.io/latest/dev/public-api.html import Promise = require('bluebird'); import https = require('https'); +import { Appender } from 'log4js'; declare namespace karma { interface Karma { @@ -57,17 +59,17 @@ declare namespace karma { interface LauncherStatic { generateId(): string; - //TODO: injector should be of type `di.Injector` + // TODO: injector should be of type `di.Injector` new (emitter: NodeJS.EventEmitter, injector: any): Launcher; } interface Launcher { Launcher: LauncherStatic; - //TODO: Can this return value ever be typified? + // TODO: Can this return value ever be typified? launch(names: string[], protocol: string, hostname: string, port: number, urlRoot: string): any[]; - kill(id: string, callback: Function): boolean; + kill(id: string, callback: () => void): boolean; restart(id: string): boolean; - killAll(callback: Function): void; + killAll(callback: () => void): void; areAllCaptured(): boolean; markCaptured(id: string): void; } @@ -80,15 +82,13 @@ declare namespace karma { run(options?: ConfigOptions | ConfigFile, callback?: ServerCallback): void; } - interface Stopper { /** - * This function will signal a running server to stop. The equivalent of karma stop. - */ + * This function will signal a running server to stop. The equivalent of karma stop. + */ stop(options?: ConfigOptions, callback?: ServerCallback): void; } - interface TestResults { disconnected: boolean; error: boolean; @@ -98,6 +98,8 @@ declare namespace karma { } interface Server extends NodeJS.EventEmitter { + // TODO: Figure out how to convert Server to class and remove suppression + // tslint:disable-next-line:no-misused-new new (options?: ConfigOptions | ConfigFile, callback?: ServerCallback): Server; /** * Start the server @@ -113,23 +115,21 @@ declare namespace karma { */ refreshFiles(): Promise; - on(event: string, listener: Function): this; + on(event: string, listener: (...args: any[]) => void): this; /** * Listen to the 'run_complete' event. */ on(event: 'run_complete', listener: (browsers: any, results: TestResults) => void): this; - ///** - // * Backward-compatibility with karma-intellij bundled with WebStorm. - // * Deprecated since version 0.13, to be removed in 0.14 - // */ - //static start(): void; + /** + * Backward-compatibility with karma-intellij bundled with WebStorm. + * Deprecated since version 0.13, to be removed in 0.14 + */ + // static start(): void; } - interface ServerCallback { - (exitCode: number): void; - } + type ServerCallback = (exitCode: number) => void; interface Config { set: (config: ConfigOptions) => void; @@ -144,16 +144,6 @@ declare namespace karma { configFile: string; } - // taken from log4js 1.x typings which are gone... - interface Log4jsAppenderConfigBase { - type: string; - category?: string; - layout?: { - type: string; - [key: string]: any - } - } - interface ConfigOptions { /** * @description Enable or disable watching files and executing the tests whenever one of these files changes. @@ -258,7 +248,7 @@ declare namespace karma { * @default [] * @description List of files/patterns to load in the browser. */ - files?: (FilePattern | string)[]; + files?: Array; /** * @default [] * @description List of test frameworks you want to use. Typically, you will set this to ['jasmine'], ['mocha'] or ['qunit']... @@ -294,7 +284,7 @@ declare namespace karma { * @default [{type: 'console'}] * @description A list of log appenders to be used. See the documentation for [log4js] for more information. */ - loggers?: Log4jsAppenderConfigBase[]; + loggers?: { [name: string]: Appender } | Appender[]; /** * @default [] * @description List of names of additional middleware you want the @@ -342,7 +332,7 @@ declare namespace karma { * but your interactive debugging does not. * */ - preprocessors?: { [name: string]: string | string[] } + preprocessors?: { [name: string]: string | string[] }; /** * @default 'http:' * Possible Values: @@ -359,7 +349,7 @@ declare namespace karma { * @default {} * @description A map of path-proxy pairs. */ - proxies?: { [path: string]: string } + proxies?: { [path: string]: string }; /** * @default true * @description Whether or not Karma or any browsers should raise an error when an inavlid SSL certificate is found. diff --git a/types/karma/karma-tests.ts b/types/karma/karma-tests.ts index a8adc36f45..4114a77b02 100644 --- a/types/karma/karma-tests.ts +++ b/types/karma/karma-tests.ts @@ -1,39 +1,34 @@ import gulp = require('gulp'); import karma = require('karma'); - function runKarma(singleRun: boolean): void { // MEMO: `start` method is deprecated since 0.13. It will be removed in 0.14. karma.server.start({ configFile: __dirname + '/karma.conf.js', - singleRun: singleRun + singleRun }); } gulp.task('test:unit:karma', gulp.parallel('build:test:unit', () => runKarma(true))); - - karma.server.start({port: 9876}, (exitCode: number) => { console.log('Karma has exited with ' + exitCode); process.exit(exitCode); }); - karma.runner.run({port: 9876}, (exitCode: number) => { console.log('Karma has exited with ' + exitCode); process.exit(exitCode); }); -karma.stopper.stop({port: 9876}, function(exitCode) { +karma.stopper.stop({port: 9876}, (exitCode) => { if (exitCode === 0) { - console.log('Server stop as initiated') + console.log('Server stop as initiated'); } - process.exit(exitCode) + process.exit(exitCode); }); -//var Server = require('karma').Server; => cannot use this syntax otherwise Server is of type any -var server = new karma.Server({logLevel: 'debug', port: 9876}, function(exitCode: number) { +const server = new karma.Server({logLevel: 'debug', port: 9876}, (exitCode: number) => { console.log('Karma has exited with ' + exitCode); process.exit(exitCode); }); @@ -42,7 +37,7 @@ server.start(); server.refreshFiles(); -server.on('browser_register', function (browser: any) { +server.on('browser_register', (browser: any) => { console.log('A new browser was registered'); }); @@ -54,19 +49,15 @@ server.on('run_complete', (browsers, results) => { results.success = 10; }); -//var runner = require('karma').runner; => cannot use this syntax otherwise runner is of type any -karma.runner.run({port: 9876}, function(exitCode: number) { +karma.runner.run({port: 9876}, (exitCode: number) => { console.log('Karma has exited with ' + exitCode); process.exit(exitCode); }); -// +const captured: boolean = karma.launcher.areAllCaptured(); -var captured: boolean = karma.launcher.areAllCaptured(); - - -// Example of configuration file karma.conf.ts, see http://karma-runner.github.io/0.13/config/configuration-file.html -module.exports = function(config: karma.Config) { +// Example of configuration file karma.conf.ts, see http://karma-runner.github.io/latest/config/configuration-file.html +module.exports = (config: karma.Config) => { config.set({ logLevel: config.LOG_DEBUG, basePath: '..', @@ -83,6 +74,10 @@ module.exports = function(config: karma.Config) { } ], + loggers: { + custom: { type: 'file', filename: 'log.txt' } + }, + reporters: [ 'progress', 'coverage' diff --git a/types/karma/package.json b/types/karma/package.json new file mode 100644 index 0000000000..3daac433d0 --- /dev/null +++ b/types/karma/package.json @@ -0,0 +1,6 @@ +{ + "private": true, + "dependencies": { + "log4js": "^3.0.0" + } +} diff --git a/types/karma/tslint.json b/types/karma/tslint.json index a41bf5d19a..f93cf8562a 100644 --- a/types/karma/tslint.json +++ b/types/karma/tslint.json @@ -1,79 +1,3 @@ { - "extends": "dtslint/dt.json", - "rules": { - "adjacent-overload-signatures": false, - "array-type": false, - "arrow-return-shorthand": false, - "ban-types": false, - "callable-types": false, - "comment-format": false, - "dt-header": false, - "eofline": false, - "export-just-namespace": false, - "import-spacing": false, - "interface-name": false, - "interface-over-type-literal": false, - "jsdoc-format": false, - "max-line-length": false, - "member-access": false, - "new-parens": false, - "no-any-union": false, - "no-boolean-literal-compare": false, - "no-conditional-assignment": false, - "no-consecutive-blank-lines": false, - "no-construct": false, - "no-declare-current-package": false, - "no-duplicate-imports": false, - "no-duplicate-variable": false, - "no-empty-interface": false, - "no-for-in-array": false, - "no-inferrable-types": false, - "no-internal-module": false, - "no-irregular-whitespace": false, - "no-mergeable-namespace": false, - "no-misused-new": false, - "no-namespace": false, - "no-object-literal-type-assertion": false, - "no-padding": false, - "no-redundant-jsdoc": false, - "no-redundant-jsdoc-2": false, - "no-redundant-undefined": false, - "no-reference-import": false, - "no-relative-import-in-test": false, - "no-self-import": false, - "no-single-declare-module": false, - "no-string-throw": false, - "no-unnecessary-callback-wrapper": false, - "no-unnecessary-class": false, - "no-unnecessary-generics": false, - "no-unnecessary-qualifier": false, - "no-unnecessary-type-assertion": false, - "no-useless-files": false, - "no-var-keyword": false, - "no-var-requires": false, - "no-void-expression": false, - "no-trailing-whitespace": false, - "object-literal-key-quotes": false, - "object-literal-shorthand": false, - "one-line": false, - "one-variable-per-declaration": false, - "only-arrow-functions": false, - "prefer-conditional-expression": false, - "prefer-const": false, - "prefer-declare-function": false, - "prefer-for-of": false, - "prefer-method-signature": false, - "prefer-template": false, - "radix": false, - "semicolon": false, - "space-before-function-paren": false, - "space-within-parens": false, - "strict-export-declare-modifiers": false, - "trim-file": false, - "triple-equals": false, - "typedef-whitespace": false, - "unified-signatures": false, - "void-return": false, - "whitespace": false - } + "extends": "dtslint/dt.json" } diff --git a/types/karma/v1/index.d.ts b/types/karma/v1/index.d.ts new file mode 100644 index 0000000000..4b71c0a723 --- /dev/null +++ b/types/karma/v1/index.d.ts @@ -0,0 +1,485 @@ +// Type definitions for karma 1.7 +// Project: https://github.com/karma-runner/karma +// Definitions by: Tanguy Krotoff +// James Garbutt +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +/// + +// See Karma public API https://karma-runner.github.io/0.13/dev/public-api.html +import Promise = require('bluebird'); +import https = require('https'); + +declare namespace karma { + interface Karma { + /** + * `start` method is deprecated since 0.13. It will be removed in 0.14. + * Please use + * + * server = new Server(config, [done]) + * server.start() + * + * instead. + */ + server: DeprecatedServer; + Server: Server; + runner: Runner; + stopper: Stopper; + launcher: Launcher; + VERSION: string; + constants: Constants; + } + + interface Constants { + VERSION: string; + DEFAULT_PORT: number; + DEFAULT_HOSTNAME: string; + DEFAULT_LISTEN_ADDR: string; + LOG_DISABLE: string; + LOG_ERROR: string; + LOG_WARN: string; + LOG_INFO: string; + LOG_DEBUG: string; + LOG_LOG: string; + LOG_PRIORITIES: string[]; + COLOR_PATTERN: string; + NO_COLOR_PATTERN: string; + CONSOLE_APPENDER: { + type: string; + layout: { + type: string; + pattern: string; + }; + }; + EXIT_CODE: string; + } + + interface LauncherStatic { + generateId(): string; + //TODO: injector should be of type `di.Injector` + new (emitter: NodeJS.EventEmitter, injector: any): Launcher; + } + + interface Launcher { + Launcher: LauncherStatic; + //TODO: Can this return value ever be typified? + launch(names: string[], protocol: string, hostname: string, port: number, urlRoot: string): any[]; + kill(id: string, callback: Function): boolean; + restart(id: string): boolean; + killAll(callback: Function): void; + areAllCaptured(): boolean; + markCaptured(id: string): void; + } + + interface DeprecatedServer { + start(options?: any, callback?: ServerCallback): void; + } + + interface Runner { + run(options?: ConfigOptions | ConfigFile, callback?: ServerCallback): void; + } + + + interface Stopper { + /** + * This function will signal a running server to stop. The equivalent of karma stop. + */ + stop(options?: ConfigOptions, callback?: ServerCallback): void; + } + + + interface TestResults { + disconnected: boolean; + error: boolean; + exitCode: number; + failed: number; + success: number; + } + + interface Server extends NodeJS.EventEmitter { + new (options?: ConfigOptions | ConfigFile, callback?: ServerCallback): Server; + /** + * Start the server + */ + start(): void; + /** + * Get properties from the injector + * @param token + */ + get(token: string): any; + /** + * Force a refresh of the file list + */ + refreshFiles(): Promise; + + on(event: string, listener: Function): this; + + /** + * Listen to the 'run_complete' event. + */ + on(event: 'run_complete', listener: (browsers: any, results: TestResults) => void): this; + + ///** + // * Backward-compatibility with karma-intellij bundled with WebStorm. + // * Deprecated since version 0.13, to be removed in 0.14 + // */ + //static start(): void; + } + + interface ServerCallback { + (exitCode: number): void; + } + + interface Config { + set: (config: ConfigOptions) => void; + LOG_DISABLE: string; + LOG_ERROR: string; + LOG_WARN: string; + LOG_INFO: string; + LOG_DEBUG: string; + } + + interface ConfigFile { + configFile: string; + } + + // taken from log4js 1.x typings which are gone... + interface Log4jsAppenderConfigBase { + type: string; + category?: string; + layout?: { + type: string; + [key: string]: any + } + } + + interface ConfigOptions { + /** + * @description Enable or disable watching files and executing the tests whenever one of these files changes. + * @default true + */ + autoWatch?: boolean; + /** + * @description When Karma is watching the files for changes, it tries to batch multiple changes into a single run + * so that the test runner doesn't try to start and restart running tests more than it should. + * The configuration setting tells Karma how long to wait (in milliseconds) after any changes have occurred + * before starting the test process again. + * @default 250 + */ + autoWatchBatchDelay?: number; + /** + * @default '' + * @description The root path location that will be used to resolve all relative paths defined in files and exclude. + * If the basePath configuration is a relative path then it will be resolved to + * the __dirname of the configuration file. + */ + basePath?: string; + /** + * @default 2000 + * @description How long does Karma wait for a browser to reconnect (in ms). + *

+ * With a flaky connection it is pretty common that the browser disconnects, + * but the actual test execution is still running without any problems. Karma does not treat a disconnection + * as immediate failure and will wait browserDisconnectTimeout (ms). + * If the browser reconnects during that time, everything is fine. + *

+ */ + browserDisconnectTimeout?: number; + /** + * @default 0 + * @description The number of disconnections tolerated. + *

+ * The disconnectTolerance value represents the maximum number of tries a browser will attempt + * in the case of a disconnection. Usually any disconnection is considered a failure, + * but this option allows you to define a tolerance level when there is a flaky network link between + * the Karma server and the browsers. + *

+ */ + browserDisconnectTolerance?: number; + /** + * @default 10000 + * @description How long will Karma wait for a message from a browser before disconnecting from it (in ms). + *

+ * If, during test execution, Karma does not receive any message from a browser within + * browserNoActivityTimeout (ms), it will disconnect from the browser + *

+ */ + browserNoActivityTimeout?: number; + /** + * @default [] + * Possible Values: + *
    + *
  • Chrome (launcher comes installed with Karma)
    • + *
  • ChromeCanary (launcher comes installed with Karma)
    • + *
  • PhantomJS (launcher comes installed with Karma)
    • + *
  • Firefox (launcher requires karma-firefox-launcher plugin)
    • + *
  • Opera (launcher requires karma-opera-launcher plugin)
    • + *
  • Internet Explorer (launcher requires karma-ie-launcher plugin)
    • + *
  • Safari (launcher requires karma-safari-launcher plugin)
    • + *
+ * @description A list of browsers to launch and capture. When Karma starts up, it will also start up each browser + * which is placed within this setting. Once Karma is shut down, it will shut down these browsers as well. + * You can capture any browser manually by opening the browser and visiting the URL where + * the Karma web server is listening (by default it is http://localhost:9876/). + */ + browsers?: string[]; + /** + * @default 60000 + * @description Timeout for capturing a browser (in ms). + *

+ * The captureTimeout value represents the maximum boot-up time allowed for a + * browser to start and connect to Karma. If any browser does not get captured within the timeout, Karma + * will kill it and try to launch it again and, after three attempts to capture it, Karma will give up. + *

+ */ + captureTimeout?: number; + client?: ClientOptions; + /** + * @default true + * @description Enable or disable colors in the output (reporters and logs). + */ + colors?: boolean; + /** + * @default 'Infinity' + * @description How many browsers Karma launches in parallel. + * Especially on services like SauceLabs and Browserstack, it makes sense only to launch a limited + * amount of browsers at once, and only start more when those have finished. Using this configuration, + * you can specify how many browsers should be running at once at any given point in time. + */ + concurrency?: number; + customLaunchers?: { [key: string]: CustomLauncher }; + /** + * @default [] + * @description List of files/patterns to exclude from loaded files. + */ + exclude?: string[]; + /** + * @default [] + * @description List of files/patterns to load in the browser. + */ + files?: (FilePattern | string)[]; + /** + * @default [] + * @description List of test frameworks you want to use. Typically, you will set this to ['jasmine'], ['mocha'] or ['qunit']... + * Please note just about all frameworks in Karma require an additional plugin/framework library to be installed (via NPM). + */ + frameworks?: string[]; + /** + * @default 'localhost' + * @description Hostname to be used when capturing browsers. + */ + hostname?: string; + /** + * @default {} + * @description Options object to be used by Node's https class. + * Object description can be found in the + * [NodeJS.org API docs](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener) + */ + httpsServerOptions?: https.ServerOptions; + /** + * @default config.LOG_INFO + * Possible values: + *
    + *
  • config.LOG_DISABLE
    • + *
  • config.LOG_ERROR
    • + *
  • config.LOG_WARN
    • + *
  • config.LOG_INFO
    • + *
  • config.LOG_DEBUG
    • + *
+ * @description Level of logging. + */ + logLevel?: string; + /** + * @default [{type: 'console'}] + * @description A list of log appenders to be used. See the documentation for [log4js] for more information. + */ + loggers?: Log4jsAppenderConfigBase[]; + /** + * @default [] + * @description List of names of additional middleware you want the + * Karma server to use. Middleware will be used in the order listed. + * You must have installed the middleware via a plugin/framework + * (either inline or via NPM). Additional information can be found in + * [plugins](http://karma-runner.github.io/2.0/config/plugins.html). + * The plugin must provide an express/connect middleware function + * (details about this can be found in the + * [Express](http://expressjs.com/guide/using-middleware.html) docs). + */ + middleware?: string[]; + /** + * @default {} + * @description Redefine default mapping from file extensions to MIME-type. + * Set property name to required MIME, provide Array of extensions (without dots) as it's value. + */ + mime?: {[type: string]: string[]}; + /** + * @default ['karma-*'] + * @description List of plugins to load. A plugin can be a string (in which case it will be required + * by Karma) or an inlined plugin - Object. + * By default, Karma loads all sibling NPM modules which have a name starting with karma-*. + * Note: Just about all plugins in Karma require an additional library to be installed (via NPM). + */ + plugins?: any[]; + /** + * @default 9876 + * @description The port where the web server will be listening. + */ + port?: number; + /** + * @default {'**\/*.coffee': 'coffee'} + * @description A map of preprocessors to use. + * + * Preprocessors can be loaded through [plugins]. + * + * Note: Just about all preprocessors in Karma (other than CoffeeScript and some other defaults) + * require an additional library to be installed (via NPM). + * + * Be aware that preprocessors may be transforming the files and file types that are available at run time. For instance, + * if you are using the "coverage" preprocessor on your source files, if you then attempt to interactively debug + * your tests, you'll discover that your expected source code is completely changed from what you expected. Because + * of that, you'll want to engineer this so that your automated builds use the coverage entry in the "reporters" list, + * but your interactive debugging does not. + * + */ + preprocessors?: { [name: string]: string | string[] } + /** + * @default 'http:' + * Possible Values: + *
    + *
  • http:
    • + *
  • https:
    • + *
+ * @description Protocol used for running the Karma webserver. + * Determines the use of the Node http or https class. + * Note: Using 'https:' requires you to specify httpsServerOptions. + */ + protocol?: string; + /** + * @default {} + * @description A map of path-proxy pairs. + */ + proxies?: { [path: string]: string } + /** + * @default true + * @description Whether or not Karma or any browsers should raise an error when an inavlid SSL certificate is found. + */ + proxyValidateSSL?: boolean; + /** + * @default 0 + * @description Karma will report all the tests that are slower than given time limit (in ms). + * This is disabled by default (since the default value is 0). + */ + reportSlowerThan?: number; + /** + * @default ['progress'] + * Possible Values: + *
    + *
  • dots
    • + *
  • progress
    • + *
+ * @description A list of reporters to use. + * Additional reporters, such as growl, junit, teamcity or coverage can be loaded through plugins. + * Note: Just about all additional reporters in Karma (other than progress) require an additional library to be installed (via NPM). + */ + reporters?: string[]; + /** + * @default false + * @description Continuous Integration mode. + * If true, Karma will start and capture all configured browsers, run tests and then exit with an exit code of 0 or 1 depending + * on whether all tests passed or any tests failed. + */ + singleRun?: boolean; + /** + * @default ['polling', 'websocket'] + * @description An array of allowed transport methods between the browser and testing server. This configuration setting + * is handed off to [socket.io](http://socket.io/) (which manages the communication + * between browsers and the testing server). + */ + transports?: string[]; + /** + * @default '/' + * @description The base url, where Karma runs. + * All of Karma's urls get prefixed with the urlRoot. This is helpful when using proxies, as + * sometimes you might want to proxy a url that is already taken by Karma. + */ + urlRoot?: string; + } + + interface ClientOptions { + /** + * @default undefined + * @description When karma run is passed additional arguments on the command-line, they + * are passed through to the test adapter as karma.config.args (an array of strings). + * The client.args option allows you to set this value for actions other than run. + * How this value is used is up to your test adapter - you should check your adapter's + * documentation to see how (and if) it uses this value. + */ + args?: string[]; + /** + * @default true + * @description Run the tests inside an iFrame or a new window + * If true, Karma runs the tests inside an iFrame. If false, Karma runs the tests in a new window. Some tests may not run in an + * iFrame and may need a new window to run. + */ + useIframe?: boolean; + /** + * @default true + * @description Capture all console output and pipe it to the terminal. + */ + captureConsole?: boolean; + /** + * @default false + * @description Run the tests on the same window as the client, without using iframe or a new window + */ + runInParent?: boolean; + /** + * @default true + * @description Clear the context window + * If true, Karma clears the context window upon the completion of running the tests. + * If false, Karma does not clear the context window upon the completion of running the tests. + * Setting this to false is useful when embedding a Jasmine Spec Runner Template. + */ + clearContext?: boolean; + } + + interface FilePattern { + /** + * The pattern to use for matching. This property is mandatory. + */ + pattern: string; + /** + * @default true + * @description If autoWatch is true all files that have set watched to true will be watched + * for changes. + */ + watched?: boolean; + /** + * @default true + * @description Should the files be included in the browser using