@nikovirtala/projen-constructs 0.2.157 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +1077 -818
- package/.kiro/steering/product.md +1 -1
- package/.kiro/steering/tech.md +6 -4
- package/API.md +9711 -5492
- package/docs/api/assets/highlight.css +1 -1
- package/docs/api/assets/main.js +1 -1
- package/docs/api/assets/search.js +1 -1
- package/docs/api/assets/style.css +18 -3
- package/docs/api/classes/AwsCdkConstructLibraryProject.html +997 -162
- package/docs/api/classes/AwsCdkTypeScriptAppProject.html +1015 -157
- package/docs/api/classes/Bundler.html +267 -17
- package/docs/api/classes/Colima.html +221 -16
- package/docs/api/classes/Homebrew.html +244 -16
- package/docs/api/classes/JsiiProject.html +983 -150
- package/docs/api/classes/LambdaFunctionCodeBundle.html +222 -16
- package/docs/api/classes/LambdaFunctionCodeBundler.html +222 -16
- package/docs/api/classes/LambdaFunctionConstructGenerator.html +243 -16
- package/docs/api/classes/LocalStack.html +222 -16
- package/docs/api/classes/Mise.html +233 -16
- package/docs/api/classes/ProjectGenerator.html +229 -19
- package/docs/api/classes/TypeDoc.html +246 -19
- package/docs/api/classes/TypeScriptProject.html +983 -150
- package/docs/api/classes/Vitest.html +295 -16
- package/docs/api/enums/CommentStyle.html +74 -8
- package/docs/api/enums/CoverageProvider.html +65 -6
- package/docs/api/enums/CoverageReporter.html +72 -7
- package/docs/api/enums/EntryPointStrategy.html +74 -8
- package/docs/api/enums/Environment.html +79 -9
- package/docs/api/enums/LogLevel.html +79 -9
- package/docs/api/enums/Pool.html +75 -8
- package/docs/api/enums/ProjectType.html +149 -27
- package/docs/api/enums/Visibility.html +69 -7
- package/docs/api/functions/applyDefaults.html +41 -1
- package/docs/api/functions/convertToPosixPath.html +40 -1
- package/docs/api/functions/renderBundleName.html +40 -1
- package/docs/api/functions/toJson_TypeDocConfiguration.html +42 -2
- package/docs/api/hierarchy.html +29 -1
- package/docs/api/index.html +60 -2
- package/docs/api/interfaces/AwsCdkConstructLibraryProjectOptions.html +2404 -770
- package/docs/api/interfaces/AwsCdkTypeScriptAppProjectOptions.html +2302 -740
- package/docs/api/interfaces/Bundle.html +57 -2
- package/docs/api/interfaces/BundlerOptions.html +60 -2
- package/docs/api/interfaces/BundlingOptions.html +84 -2
- package/docs/api/interfaces/Component.html +70 -7
- package/docs/api/interfaces/ComponentOptions.html +66 -6
- package/docs/api/interfaces/HomebrewOptions.html +51 -2
- package/docs/api/interfaces/JsiiProjectOptions.html +2263 -713
- package/docs/api/interfaces/LambdaFunctionCodeBundleOptions.html +63 -2
- package/docs/api/interfaces/LambdaFunctionCodeBundlerOptions.html +57 -2
- package/docs/api/interfaces/LambdaFunctionConstructGeneratorOptions.html +72 -2
- package/docs/api/interfaces/LocalStackOptions.html +60 -2
- package/docs/api/interfaces/MiseOptions.html +51 -2
- package/docs/api/interfaces/ProjectGeneratorOptions.html +136 -20
- package/docs/api/interfaces/TypeDocConfiguration.html +469 -96
- package/docs/api/interfaces/TypeDocOptions.html +62 -5
- package/docs/api/interfaces/TypeScriptProjectOptions.html +2032 -638
- package/docs/api/interfaces/ValidationOptions.html +70 -7
- package/docs/api/interfaces/VitestConfigOptions.html +268 -57
- package/docs/api/interfaces/VitestOptions.html +71 -7
- package/docs/api/modules.html +52 -1
- package/docs/api/variables/defaultOptions.html +40 -1
- package/docs/api/variables/defaults.html +48 -1
- package/docs/api/variables/projectDefaultOptions.html +120 -1
- package/lib/bundle-vitest-define-config.js +37 -4
- package/lib/components/bundle-lambda-function-code.js +43 -9
- package/lib/components/colima.js +6 -4
- package/lib/components/homebrew.js +10 -4
- package/lib/components/lambda-function-construct-generator.js +47 -6
- package/lib/components/localstack.js +2 -4
- package/lib/components/mise.js +2 -4
- package/lib/components/typedoc.js +11 -4
- package/lib/components/vitest.d.ts +1 -1
- package/lib/components/vitest.js +58 -6
- package/lib/config.d.ts +52 -6
- package/lib/config.js +87 -10
- package/lib/errors.js +7 -1
- package/lib/project-generator.js +46 -9
- package/lib/project-type.d.ts +0 -8
- package/lib/project-type.js +1 -9
- package/lib/projects/awscdk-construct-library-options.generated.d.ts +72 -18
- package/lib/projects/awscdk-construct-library-options.generated.js +1 -1
- package/lib/projects/awscdk-construct-library.generated.d.ts +1 -1
- package/lib/projects/awscdk-construct-library.generated.js +2 -4
- package/lib/projects/awscdk-typescript-app-options.generated.d.ts +63 -17
- package/lib/projects/awscdk-typescript-app-options.generated.js +1 -1
- package/lib/projects/awscdk-typescript-app.generated.d.ts +1 -1
- package/lib/projects/awscdk-typescript-app.generated.js +2 -4
- package/lib/projects/jsii-options.generated.d.ts +72 -10
- package/lib/projects/jsii-options.generated.js +1 -1
- package/lib/projects/jsii.generated.d.ts +1 -1
- package/lib/projects/jsii.generated.js +2 -4
- package/lib/projects/typescript-options.generated.d.ts +63 -9
- package/lib/projects/typescript-options.generated.js +1 -1
- package/lib/projects/typescript.generated.d.ts +1 -1
- package/lib/projects/typescript.generated.js +2 -4
- package/lib/utils.d.ts +8 -0
- package/lib/utils.js +11 -2
- package/node_modules/@jsii/spec/lib/assembly-utils.js +36 -3
- package/node_modules/@jsii/spec/lib/validators.js +1 -1
- package/node_modules/@jsii/spec/package.json +4 -4
- package/package.json +19 -20
- package/pnpm-workspace.yaml +8 -0
- package/lib/components/vitest-bundled-define-config.d.ts +0 -1
- package/lib/components/vitest-bundled-define-config.js +0 -6
- package/lib/vitest-define-config-entry.d.ts +0 -1
- package/lib/vitest-define-config-entry.js +0 -6
|
@@ -1,6 +1,31 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VitestConfigOptions | @nikovirtala/projen-constructs</title><meta name="description" content="Documentation for @nikovirtala/projen-constructs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VitestConfigOptions | @nikovirtala/projen-constructs</title><meta name="description" content="Documentation for @nikovirtala/projen-constructs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nikovirtala/projen-constructs</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">VitestConfigOptions</a></li></ul>
|
|
12
|
+
<h1>Interface VitestConfigOptions</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Vitest Config.</p>
|
|
15
|
+
</div>
|
|
16
|
+
<div class="tsd-comment tsd-typography">
|
|
17
|
+
<div class="tsd-tag-see">
|
|
18
|
+
<h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/">https://vitest.dev/config/</a></p>
|
|
19
|
+
</div></div></section>
|
|
20
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">VitestConfigOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#bail">bail</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#coveragedirectory">coverageDirectory</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#coverageenabled">coverageEnabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#coverageprovider">coverageProvider</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/CoverageProvider.html" class="tsd-signature-type tsd-kind-enum">CoverageProvider</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#coveragereporters">coverageReporters</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/CoverageReporter.html" class="tsd-signature-type tsd-kind-enum">CoverageReporter</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#environment">environment</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/Environment.html" class="tsd-signature-type tsd-kind-enum">Environment</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#exclude">exclude</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#globals">globals</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#include">include</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#isolate">isolate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#passwithnotests">passWithNoTests</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#pool">pool</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/Pool.html" class="tsd-signature-type tsd-kind-enum">Pool</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#printconsoletrace">printConsoleTrace</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#slowtestthreshold">slowTestThreshold</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typecheckchecker">typecheckChecker</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typecheckenabled">typecheckEnabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typechecktsconfig">typecheckTsconfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updatesnapshots">updateSnapshots</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
21
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
22
|
+
<section class="tsd-panel tsd-index-panel">
|
|
23
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
24
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
25
|
+
<div class="tsd-accordion-details">
|
|
26
|
+
<section class="tsd-index-section">
|
|
27
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
28
|
+
<div class="tsd-index-list"><a href="#bail" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bail?</span></a>
|
|
4
29
|
<a href="#coveragedirectory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coverage<wbr/>Directory?</span></a>
|
|
5
30
|
<a href="#coverageenabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coverage<wbr/>Enabled?</span></a>
|
|
6
31
|
<a href="#coverageprovider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coverage<wbr/>Provider?</span></a>
|
|
@@ -18,94 +43,280 @@
|
|
|
18
43
|
<a href="#typecheckenabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typecheck<wbr/>Enabled?</span></a>
|
|
19
44
|
<a href="#typechecktsconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typecheck<wbr/>Tsconfig?</span></a>
|
|
20
45
|
<a href="#updatesnapshots" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Snapshots?</span></a>
|
|
21
|
-
</div></section></div></details></section></section
|
|
22
|
-
|
|
46
|
+
</div></section></div></details></section></section>
|
|
47
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
48
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
49
|
+
<section>
|
|
50
|
+
<section class="tsd-panel tsd-member">
|
|
51
|
+
<h3 class="tsd-anchor-link" id="bail"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bail</span><a href="#bail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
52
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
53
|
+
<div class="tsd-comment tsd-typography"><p>Stop running tests after certain number of failures.</p>
|
|
54
|
+
</div>
|
|
55
|
+
<div class="tsd-comment tsd-typography">
|
|
56
|
+
<div class="tsd-tag-default">
|
|
57
|
+
<h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">0</span>
|
|
23
58
|
</code><button type="button">Copy</button></pre>
|
|
24
59
|
|
|
25
|
-
</div
|
|
26
|
-
|
|
27
|
-
|
|
60
|
+
</div>
|
|
61
|
+
<div class="tsd-tag-see">
|
|
62
|
+
<h4 class="tsd-anchor-link" id="see-1">See<a href="#see-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#bail">https://vitest.dev/config/#bail</a></p>
|
|
63
|
+
</div></div></section>
|
|
64
|
+
<section class="tsd-panel tsd-member">
|
|
65
|
+
<h3 class="tsd-anchor-link" id="coveragedirectory"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>coverage<wbr/>Directory</span><a href="#coveragedirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
66
|
+
<div class="tsd-signature"><span class="tsd-kind-property">coverageDirectory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
67
|
+
<div class="tsd-comment tsd-typography"><p>Coverage output directory.</p>
|
|
68
|
+
</div>
|
|
69
|
+
<div class="tsd-comment tsd-typography">
|
|
70
|
+
<div class="tsd-tag-default">
|
|
71
|
+
<h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"coverage"</span>
|
|
28
72
|
</code><button type="button">Copy</button></pre>
|
|
29
73
|
|
|
30
|
-
</div></div></section
|
|
31
|
-
|
|
74
|
+
</div></div></section>
|
|
75
|
+
<section class="tsd-panel tsd-member">
|
|
76
|
+
<h3 class="tsd-anchor-link" id="coverageenabled"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>coverage<wbr/>Enabled</span><a href="#coverageenabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
77
|
+
<div class="tsd-signature"><span class="tsd-kind-property">coverageEnabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
78
|
+
<div class="tsd-comment tsd-typography"><p>Coverage enabled.</p>
|
|
79
|
+
</div>
|
|
80
|
+
<div class="tsd-comment tsd-typography">
|
|
81
|
+
<div class="tsd-tag-default">
|
|
82
|
+
<h4 class="tsd-anchor-link" id="default-2">Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
32
83
|
</code><button type="button">Copy</button></pre>
|
|
33
84
|
|
|
34
|
-
</div
|
|
35
|
-
|
|
36
|
-
|
|
85
|
+
</div>
|
|
86
|
+
<div class="tsd-tag-see">
|
|
87
|
+
<h4 class="tsd-anchor-link" id="see-2">See<a href="#see-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#coverage-enabled">https://vitest.dev/config/#coverage-enabled</a></p>
|
|
88
|
+
</div></div></section>
|
|
89
|
+
<section class="tsd-panel tsd-member">
|
|
90
|
+
<h3 class="tsd-anchor-link" id="coverageprovider"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>coverage<wbr/>Provider</span><a href="#coverageprovider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
91
|
+
<div class="tsd-signature"><span class="tsd-kind-property">coverageProvider</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/CoverageProvider.html" class="tsd-signature-type tsd-kind-enum">CoverageProvider</a></div>
|
|
92
|
+
<div class="tsd-comment tsd-typography"><p>Coverage provider type.</p>
|
|
93
|
+
</div>
|
|
94
|
+
<div class="tsd-comment tsd-typography">
|
|
95
|
+
<div class="tsd-tag-default">
|
|
96
|
+
<h4 class="tsd-anchor-link" id="default-3">Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"v8"</span>
|
|
37
97
|
</code><button type="button">Copy</button></pre>
|
|
38
98
|
|
|
39
|
-
</div
|
|
40
|
-
|
|
41
|
-
|
|
99
|
+
</div>
|
|
100
|
+
<div class="tsd-tag-see">
|
|
101
|
+
<h4 class="tsd-anchor-link" id="see-3">See<a href="#see-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#coverage-provider">https://vitest.dev/config/#coverage-provider</a></p>
|
|
102
|
+
</div></div></section>
|
|
103
|
+
<section class="tsd-panel tsd-member">
|
|
104
|
+
<h3 class="tsd-anchor-link" id="coveragereporters"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>coverage<wbr/>Reporters</span><a href="#coveragereporters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
105
|
+
<div class="tsd-signature"><span class="tsd-kind-property">coverageReporters</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/CoverageReporter.html" class="tsd-signature-type tsd-kind-enum">CoverageReporter</a><span class="tsd-signature-symbol">[]</span></div>
|
|
106
|
+
<div class="tsd-comment tsd-typography"><p>Coverage reporters.</p>
|
|
107
|
+
</div>
|
|
108
|
+
<div class="tsd-comment tsd-typography">
|
|
109
|
+
<div class="tsd-tag-default">
|
|
110
|
+
<h4 class="tsd-anchor-link" id="default-4">Default<a href="#default-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">'["text", "lcov"]'</span>
|
|
42
111
|
</code><button type="button">Copy</button></pre>
|
|
43
112
|
|
|
44
|
-
</div
|
|
45
|
-
|
|
46
|
-
|
|
113
|
+
</div>
|
|
114
|
+
<div class="tsd-tag-see">
|
|
115
|
+
<h4 class="tsd-anchor-link" id="see-4">See<a href="#see-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#coverage-reporter">https://vitest.dev/config/#coverage-reporter</a></p>
|
|
116
|
+
</div></div></section>
|
|
117
|
+
<section class="tsd-panel tsd-member">
|
|
118
|
+
<h3 class="tsd-anchor-link" id="environment"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>environment</span><a href="#environment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
119
|
+
<div class="tsd-signature"><span class="tsd-kind-property">environment</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/Environment.html" class="tsd-signature-type tsd-kind-enum">Environment</a></div>
|
|
120
|
+
<div class="tsd-comment tsd-typography"><p>The environment that will be used for testing.</p>
|
|
121
|
+
</div>
|
|
122
|
+
<div class="tsd-comment tsd-typography">
|
|
123
|
+
<div class="tsd-tag-default">
|
|
124
|
+
<h4 class="tsd-anchor-link" id="default-5">Default<a href="#default-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"node"</span>
|
|
47
125
|
</code><button type="button">Copy</button></pre>
|
|
48
126
|
|
|
49
|
-
</div
|
|
50
|
-
|
|
51
|
-
|
|
127
|
+
</div>
|
|
128
|
+
<div class="tsd-tag-see">
|
|
129
|
+
<h4 class="tsd-anchor-link" id="see-5">See<a href="#see-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#environment">https://vitest.dev/config/#environment</a></p>
|
|
130
|
+
</div></div></section>
|
|
131
|
+
<section class="tsd-panel tsd-member">
|
|
132
|
+
<h3 class="tsd-anchor-link" id="exclude"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>exclude</span><a href="#exclude" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
133
|
+
<div class="tsd-signature"><span class="tsd-kind-property">exclude</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
134
|
+
<div class="tsd-comment tsd-typography"><p>A list of glob patterns that should be excluded from your test files.</p>
|
|
135
|
+
</div>
|
|
136
|
+
<div class="tsd-comment tsd-typography">
|
|
137
|
+
<div class="tsd-tag-default">
|
|
138
|
+
<h4 class="tsd-anchor-link" id="default-6">Default<a href="#default-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
52
139
|
<li>Vitest's <code>configDefaults.exclude</code></li>
|
|
53
140
|
</ul>
|
|
54
|
-
</div
|
|
55
|
-
|
|
56
|
-
|
|
141
|
+
</div>
|
|
142
|
+
<div class="tsd-tag-see">
|
|
143
|
+
<h4 class="tsd-anchor-link" id="see-6">See<a href="#see-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#exclude">https://vitest.dev/config/#exclude</a></p>
|
|
144
|
+
</div></div></section>
|
|
145
|
+
<section class="tsd-panel tsd-member">
|
|
146
|
+
<h3 class="tsd-anchor-link" id="globals"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>globals</span><a href="#globals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
147
|
+
<div class="tsd-signature"><span class="tsd-kind-property">globals</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
148
|
+
<div class="tsd-comment tsd-typography"><p>Register apis globally. If you prefer to use the APIs globally like Jest, set to <code>true</code>.</p>
|
|
149
|
+
</div>
|
|
150
|
+
<div class="tsd-comment tsd-typography">
|
|
151
|
+
<div class="tsd-tag-default">
|
|
152
|
+
<h4 class="tsd-anchor-link" id="default-7">Default<a href="#default-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
57
153
|
</code><button type="button">Copy</button></pre>
|
|
58
154
|
|
|
59
|
-
</div
|
|
60
|
-
|
|
61
|
-
|
|
155
|
+
</div>
|
|
156
|
+
<div class="tsd-tag-see">
|
|
157
|
+
<h4 class="tsd-anchor-link" id="see-7">See<a href="#see-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#globals">https://vitest.dev/config/#globals</a></p>
|
|
158
|
+
</div></div></section>
|
|
159
|
+
<section class="tsd-panel tsd-member">
|
|
160
|
+
<h3 class="tsd-anchor-link" id="include"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>include</span><a href="#include" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
161
|
+
<div class="tsd-signature"><span class="tsd-kind-property">include</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
162
|
+
<div class="tsd-comment tsd-typography"><p>A list of glob patterns that match your test files.</p>
|
|
163
|
+
</div>
|
|
164
|
+
<div class="tsd-comment tsd-typography">
|
|
165
|
+
<div class="tsd-tag-default">
|
|
166
|
+
<h4 class="tsd-anchor-link" id="default-8">Default<a href="#default-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
62
167
|
<li>Vitest's <code>configDefaults.include</code></li>
|
|
63
168
|
</ul>
|
|
64
|
-
</div
|
|
65
|
-
|
|
169
|
+
</div>
|
|
170
|
+
<div class="tsd-tag-see">
|
|
171
|
+
<h4 class="tsd-anchor-link" id="see-8">See<a href="#see-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#include">https://vitest.dev/config/#include</a></p>
|
|
172
|
+
</div></div></section>
|
|
173
|
+
<section class="tsd-panel tsd-member">
|
|
174
|
+
<h3 class="tsd-anchor-link" id="isolate"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>isolate</span><a href="#isolate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
175
|
+
<div class="tsd-signature"><span class="tsd-kind-property">isolate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
176
|
+
<div class="tsd-comment tsd-typography"><p>Run tests in an isolated environment. This option has no effect on vmThreads pool.</p>
|
|
66
177
|
<p>Disabling this option might improve performance if your code doesn't rely on side effects.</p>
|
|
67
|
-
</div
|
|
178
|
+
</div>
|
|
179
|
+
<div class="tsd-comment tsd-typography">
|
|
180
|
+
<div class="tsd-tag-default">
|
|
181
|
+
<h4 class="tsd-anchor-link" id="default-9">Default<a href="#default-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
68
182
|
</code><button type="button">Copy</button></pre>
|
|
69
183
|
|
|
70
|
-
</div
|
|
71
|
-
|
|
72
|
-
|
|
184
|
+
</div>
|
|
185
|
+
<div class="tsd-tag-see">
|
|
186
|
+
<h4 class="tsd-anchor-link" id="see-9">See<a href="#see-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#isolate">https://vitest.dev/config/#isolate</a></p>
|
|
187
|
+
</div></div></section>
|
|
188
|
+
<section class="tsd-panel tsd-member">
|
|
189
|
+
<h3 class="tsd-anchor-link" id="passwithnotests"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>pass<wbr/>With<wbr/>No<wbr/>Tests</span><a href="#passwithnotests" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
190
|
+
<div class="tsd-signature"><span class="tsd-kind-property">passWithNoTests</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
191
|
+
<div class="tsd-comment tsd-typography"><p>Vitest will not fail, if no tests will be found.</p>
|
|
192
|
+
</div>
|
|
193
|
+
<div class="tsd-comment tsd-typography">
|
|
194
|
+
<div class="tsd-tag-default">
|
|
195
|
+
<h4 class="tsd-anchor-link" id="default-10">Default<a href="#default-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
73
196
|
</code><button type="button">Copy</button></pre>
|
|
74
197
|
|
|
75
|
-
</div
|
|
76
|
-
|
|
77
|
-
|
|
198
|
+
</div>
|
|
199
|
+
<div class="tsd-tag-see">
|
|
200
|
+
<h4 class="tsd-anchor-link" id="see-10">See<a href="#see-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#passwithnotests">https://vitest.dev/config/#passwithnotests</a></p>
|
|
201
|
+
</div></div></section>
|
|
202
|
+
<section class="tsd-panel tsd-member">
|
|
203
|
+
<h3 class="tsd-anchor-link" id="pool"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>pool</span><a href="#pool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
204
|
+
<div class="tsd-signature"><span class="tsd-kind-property">pool</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/Pool.html" class="tsd-signature-type tsd-kind-enum">Pool</a></div>
|
|
205
|
+
<div class="tsd-comment tsd-typography"><p>Pool used to run tests in.</p>
|
|
206
|
+
</div>
|
|
207
|
+
<div class="tsd-comment tsd-typography">
|
|
208
|
+
<div class="tsd-tag-default">
|
|
209
|
+
<h4 class="tsd-anchor-link" id="default-11">Default<a href="#default-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"forks"</span>
|
|
78
210
|
</code><button type="button">Copy</button></pre>
|
|
79
211
|
|
|
80
|
-
</div
|
|
81
|
-
|
|
82
|
-
|
|
212
|
+
</div>
|
|
213
|
+
<div class="tsd-tag-see">
|
|
214
|
+
<h4 class="tsd-anchor-link" id="see-11">See<a href="#see-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#pool">https://vitest.dev/config/#pool</a></p>
|
|
215
|
+
</div></div></section>
|
|
216
|
+
<section class="tsd-panel tsd-member">
|
|
217
|
+
<h3 class="tsd-anchor-link" id="printconsoletrace"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>print<wbr/>Console<wbr/>Trace</span><a href="#printconsoletrace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
218
|
+
<div class="tsd-signature"><span class="tsd-kind-property">printConsoleTrace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
219
|
+
<div class="tsd-comment tsd-typography"><p>Always print console traces when calling any console method.</p>
|
|
220
|
+
</div>
|
|
221
|
+
<div class="tsd-comment tsd-typography">
|
|
222
|
+
<div class="tsd-tag-default">
|
|
223
|
+
<h4 class="tsd-anchor-link" id="default-12">Default<a href="#default-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
83
224
|
</code><button type="button">Copy</button></pre>
|
|
84
225
|
|
|
85
|
-
</div
|
|
86
|
-
|
|
87
|
-
|
|
226
|
+
</div>
|
|
227
|
+
<div class="tsd-tag-see">
|
|
228
|
+
<h4 class="tsd-anchor-link" id="see-12">See<a href="#see-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#consoletrace">https://vitest.dev/config/#consoletrace</a></p>
|
|
229
|
+
</div></div></section>
|
|
230
|
+
<section class="tsd-panel tsd-member">
|
|
231
|
+
<h3 class="tsd-anchor-link" id="slowtestthreshold"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>slow<wbr/>Test<wbr/>Threshold</span><a href="#slowtestthreshold" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
232
|
+
<div class="tsd-signature"><span class="tsd-kind-property">slowTestThreshold</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
233
|
+
<div class="tsd-comment tsd-typography"><p>The number of milliseconds after which a test or suite is considered slow.</p>
|
|
234
|
+
</div>
|
|
235
|
+
<div class="tsd-comment tsd-typography">
|
|
236
|
+
<div class="tsd-tag-default">
|
|
237
|
+
<h4 class="tsd-anchor-link" id="default-13">Default<a href="#default-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">300</span>
|
|
88
238
|
</code><button type="button">Copy</button></pre>
|
|
89
239
|
|
|
90
|
-
</div
|
|
91
|
-
|
|
92
|
-
|
|
240
|
+
</div>
|
|
241
|
+
<div class="tsd-tag-see">
|
|
242
|
+
<h4 class="tsd-anchor-link" id="see-13">See<a href="#see-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#slowtestthreshold">https://vitest.dev/config/#slowtestthreshold</a></p>
|
|
243
|
+
</div></div></section>
|
|
244
|
+
<section class="tsd-panel tsd-member">
|
|
245
|
+
<h3 class="tsd-anchor-link" id="typecheckchecker"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>typecheck<wbr/>Checker</span><a href="#typecheckchecker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
246
|
+
<div class="tsd-signature"><span class="tsd-kind-property">typecheckChecker</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
247
|
+
<div class="tsd-comment tsd-typography"><p>Tool to use for type checking. Checker should implement the same output format as <code>tsc</code>.</p>
|
|
248
|
+
</div>
|
|
249
|
+
<div class="tsd-comment tsd-typography">
|
|
250
|
+
<div class="tsd-tag-default">
|
|
251
|
+
<h4 class="tsd-anchor-link" id="default-14">Default<a href="#default-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"tsc --noEmit"</span>
|
|
93
252
|
</code><button type="button">Copy</button></pre>
|
|
94
253
|
|
|
95
|
-
</div
|
|
96
|
-
|
|
97
|
-
|
|
254
|
+
</div>
|
|
255
|
+
<div class="tsd-tag-see">
|
|
256
|
+
<h4 class="tsd-anchor-link" id="see-14">See<a href="#see-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#typecheck-checker">https://vitest.dev/config/#typecheck-checker</a></p>
|
|
257
|
+
</div></div></section>
|
|
258
|
+
<section class="tsd-panel tsd-member">
|
|
259
|
+
<h3 class="tsd-anchor-link" id="typecheckenabled"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>typecheck<wbr/>Enabled</span><a href="#typecheckenabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
260
|
+
<div class="tsd-signature"><span class="tsd-kind-property">typecheckEnabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
261
|
+
<div class="tsd-comment tsd-typography"><p>Enable typechecking alongside your regular tests.</p>
|
|
262
|
+
</div>
|
|
263
|
+
<div class="tsd-comment tsd-typography">
|
|
264
|
+
<div class="tsd-tag-default">
|
|
265
|
+
<h4 class="tsd-anchor-link" id="default-15">Default<a href="#default-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span><span class="hl-1"> (</span><span class="hl-5">for</span><span class="hl-1"> </span><span class="hl-5">TypeScript</span><span class="hl-1"> </span><span class="hl-5">projects</span><span class="hl-1">)</span>
|
|
98
266
|
</code><button type="button">Copy</button></pre>
|
|
99
267
|
|
|
100
|
-
</div
|
|
101
|
-
|
|
102
|
-
|
|
268
|
+
</div>
|
|
269
|
+
<div class="tsd-tag-see">
|
|
270
|
+
<h4 class="tsd-anchor-link" id="see-15">See<a href="#see-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#typecheck-enabled">https://vitest.dev/config/#typecheck-enabled</a></p>
|
|
271
|
+
</div></div></section>
|
|
272
|
+
<section class="tsd-panel tsd-member">
|
|
273
|
+
<h3 class="tsd-anchor-link" id="typechecktsconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>typecheck<wbr/>Tsconfig</span><a href="#typechecktsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
274
|
+
<div class="tsd-signature"><span class="tsd-kind-property">typecheckTsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
275
|
+
<div class="tsd-comment tsd-typography"><p>Path to custom tsconfig, relative to the project root.</p>
|
|
276
|
+
</div>
|
|
277
|
+
<div class="tsd-comment tsd-typography">
|
|
278
|
+
<div class="tsd-tag-default">
|
|
279
|
+
<h4 class="tsd-anchor-link" id="default-16">Default<a href="#default-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">the</span><span class="hl-1"> </span><span class="hl-5">project</span><span class="hl-2">'s development tsconfig (e.g. "test/tsconfig.json"</span><span class="hl-9">)</span>
|
|
103
280
|
</code><button type="button">Copy</button></pre>
|
|
104
281
|
|
|
105
|
-
</div
|
|
106
|
-
|
|
107
|
-
|
|
282
|
+
</div>
|
|
283
|
+
<div class="tsd-tag-see">
|
|
284
|
+
<h4 class="tsd-anchor-link" id="see-16">See<a href="#see-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/#typecheck-tsconfig">https://vitest.dev/config/#typecheck-tsconfig</a></p>
|
|
285
|
+
</div></div></section>
|
|
286
|
+
<section class="tsd-panel tsd-member">
|
|
287
|
+
<h3 class="tsd-anchor-link" id="updatesnapshots"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>update<wbr/>Snapshots</span><a href="#updatesnapshots" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
288
|
+
<div class="tsd-signature"><span class="tsd-kind-property">updateSnapshots</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
289
|
+
<div class="tsd-comment tsd-typography"><p>Update snapshot files. This will update all changed snapshots and delete obsolete ones.</p>
|
|
290
|
+
</div>
|
|
291
|
+
<div class="tsd-comment tsd-typography">
|
|
292
|
+
<div class="tsd-tag-default">
|
|
293
|
+
<h4 class="tsd-anchor-link" id="default-17">Default<a href="#default-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
108
294
|
</code><button type="button">Copy</button></pre>
|
|
109
295
|
|
|
110
|
-
</div
|
|
111
|
-
|
|
296
|
+
</div>
|
|
297
|
+
<div class="tsd-tag-see">
|
|
298
|
+
<h4 class="tsd-anchor-link" id="see-17">See<a href="#see-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/guide/snapshot.html#updating-snapshots">https://vitest.dev/guide/snapshot.html#updating-snapshots</a></p>
|
|
299
|
+
</div></div></section></section></details></div>
|
|
300
|
+
<div class="col-sidebar">
|
|
301
|
+
<div class="page-menu">
|
|
302
|
+
<div class="tsd-navigation settings">
|
|
303
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
304
|
+
<h3>Settings</h3></summary>
|
|
305
|
+
<div class="tsd-accordion-details">
|
|
306
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
307
|
+
<ul id="tsd-filter-options">
|
|
308
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
309
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
310
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
311
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
312
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
313
|
+
<h3>On This Page</h3></summary>
|
|
314
|
+
<div class="tsd-accordion-details">
|
|
315
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
316
|
+
<div><a href="#bail"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bail</span></a><a href="#coveragedirectory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coverage<wbr/>Directory</span></a><a href="#coverageenabled"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coverage<wbr/>Enabled</span></a><a href="#coverageprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coverage<wbr/>Provider</span></a><a href="#coveragereporters"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coverage<wbr/>Reporters</span></a><a href="#environment"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>environment</span></a><a href="#exclude"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude</span></a><a href="#globals"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>globals</span></a><a href="#include"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include</span></a><a href="#isolate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>isolate</span></a><a href="#passwithnotests"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pass<wbr/>With<wbr/>No<wbr/>Tests</span></a><a href="#pool"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pool</span></a><a href="#printconsoletrace"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>print<wbr/>Console<wbr/>Trace</span></a><a href="#slowtestthreshold"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>slow<wbr/>Test<wbr/>Threshold</span></a><a href="#typecheckchecker"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typecheck<wbr/>Checker</span></a><a href="#typecheckenabled"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typecheck<wbr/>Enabled</span></a><a href="#typechecktsconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typecheck<wbr/>Tsconfig</span></a><a href="#updatesnapshots"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Snapshots</span></a></div></details></div></details></div>
|
|
317
|
+
<div class="site-menu">
|
|
318
|
+
<nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-constructs</a>
|
|
319
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
320
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
321
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
322
|
+
<div class="overlay"></div></body></html>
|