@ionic/angular 7.6.2-dev.11702957417.1622fcc0 → 7.6.2-dev.11704390532.1202188d
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/common/directives/navigation/router-outlet.d.ts +4 -3
- package/directives/control-value-accessors/index.d.ts +0 -1
- package/directives/navigation/ion-router-outlet.d.ts +12 -4
- package/directives/proxies-list.d.ts +1 -1
- package/directives/proxies.d.ts +39 -7
- package/esm2020/common/directives/control-value-accessors/value-accessor.mjs +4 -4
- package/esm2020/common/directives/navigation/back-button.mjs +4 -4
- package/esm2020/common/directives/navigation/nav.mjs +4 -4
- package/esm2020/common/directives/navigation/router-link-delegate.mjs +7 -7
- package/esm2020/common/directives/navigation/router-outlet.mjs +19 -11
- package/esm2020/common/directives/navigation/stack-controller.mjs +1 -4
- package/esm2020/common/directives/navigation/tabs.mjs +4 -4
- package/esm2020/common/overlays/modal.mjs +4 -4
- package/esm2020/common/overlays/popover.mjs +4 -4
- package/esm2020/common/providers/angular-delegate.mjs +4 -4
- package/esm2020/common/providers/config.mjs +4 -4
- package/esm2020/common/providers/dom-controller.mjs +4 -4
- package/esm2020/common/providers/nav-controller.mjs +6 -6
- package/esm2020/common/providers/platform.mjs +4 -4
- package/esm2020/directives/control-value-accessors/boolean-value-accessor.mjs +4 -4
- package/esm2020/directives/control-value-accessors/index.mjs +1 -2
- package/esm2020/directives/control-value-accessors/numeric-value-accessor.mjs +4 -4
- package/esm2020/directives/control-value-accessors/select-value-accessor.mjs +4 -4
- package/esm2020/directives/control-value-accessors/text-value-accessor.mjs +4 -4
- package/esm2020/directives/navigation/ion-back-button.mjs +4 -4
- package/esm2020/directives/navigation/ion-nav.mjs +4 -4
- package/esm2020/directives/navigation/ion-router-outlet.mjs +14 -10
- package/esm2020/directives/navigation/ion-tabs.mjs +5 -5
- package/esm2020/directives/navigation/router-link-delegate.mjs +7 -7
- package/esm2020/directives/overlays/modal.mjs +4 -4
- package/esm2020/directives/overlays/popover.mjs +4 -4
- package/esm2020/directives/proxies-list.mjs +4 -1
- package/esm2020/directives/proxies.mjs +314 -237
- package/esm2020/directives/validators/max-validator.mjs +4 -4
- package/esm2020/directives/validators/min-validator.mjs +4 -4
- package/esm2020/index.mjs +1 -2
- package/esm2020/ionic-module.mjs +7 -10
- package/esm2020/providers/action-sheet-controller.mjs +4 -4
- package/esm2020/providers/alert-controller.mjs +4 -4
- package/esm2020/providers/animation-controller.mjs +4 -4
- package/esm2020/providers/gesture-controller.mjs +4 -4
- package/esm2020/providers/loading-controller.mjs +4 -4
- package/esm2020/providers/menu-controller.mjs +4 -4
- package/esm2020/providers/modal-controller.mjs +4 -4
- package/esm2020/providers/picker-controller.mjs +7 -4
- package/esm2020/providers/toast-controller.mjs +4 -4
- package/esm2020/standalone/directives/checkbox.mjs +4 -4
- package/esm2020/standalone/directives/datetime.mjs +4 -4
- package/esm2020/standalone/directives/icon.mjs +4 -4
- package/esm2020/standalone/directives/index.mjs +1 -2
- package/esm2020/standalone/directives/input.mjs +4 -4
- package/esm2020/standalone/directives/proxies.mjs +316 -201
- package/esm2020/standalone/directives/radio-group.mjs +4 -4
- package/esm2020/standalone/directives/range.mjs +4 -4
- package/esm2020/standalone/directives/searchbar.mjs +4 -4
- package/esm2020/standalone/directives/segment.mjs +4 -4
- package/esm2020/standalone/directives/select.mjs +4 -4
- package/esm2020/standalone/directives/textarea.mjs +4 -4
- package/esm2020/standalone/directives/toggle.mjs +4 -4
- package/esm2020/standalone/index.mjs +2 -2
- package/esm2020/standalone/navigation/back-button.mjs +4 -4
- package/esm2020/standalone/navigation/nav.mjs +4 -4
- package/esm2020/standalone/navigation/router-link-delegate.mjs +7 -7
- package/esm2020/standalone/navigation/router-outlet.mjs +14 -10
- package/esm2020/standalone/navigation/tabs.mjs +5 -5
- package/esm2020/standalone/overlays/modal.mjs +4 -4
- package/esm2020/standalone/overlays/popover.mjs +4 -4
- package/esm2020/standalone/providers/action-sheet-controller.mjs +4 -4
- package/esm2020/standalone/providers/alert-controller.mjs +4 -4
- package/esm2020/standalone/providers/animation-controller.mjs +4 -4
- package/esm2020/standalone/providers/gesture-controller.mjs +4 -4
- package/esm2020/standalone/providers/loading-controller.mjs +4 -4
- package/esm2020/standalone/providers/menu-controller.mjs +4 -4
- package/esm2020/standalone/providers/modal-controller.mjs +4 -4
- package/esm2020/standalone/providers/picker-controller.mjs +8 -5
- package/esm2020/standalone/providers/toast-controller.mjs +4 -4
- package/fesm2015/ionic-angular-common.mjs +59 -54
- package/fesm2015/ionic-angular-common.mjs.map +1 -1
- package/fesm2015/ionic-angular-standalone.mjs +482 -419
- package/fesm2015/ionic-angular-standalone.mjs.map +1 -1
- package/fesm2015/ionic-angular.mjs +402 -359
- package/fesm2015/ionic-angular.mjs.map +1 -1
- package/fesm2020/ionic-angular-common.mjs +59 -54
- package/fesm2020/ionic-angular-common.mjs.map +1 -1
- package/fesm2020/ionic-angular-standalone.mjs +482 -419
- package/fesm2020/ionic-angular-standalone.mjs.map +1 -1
- package/fesm2020/ionic-angular.mjs +402 -359
- package/fesm2020/ionic-angular.mjs.map +1 -1
- package/index.d.ts +0 -1
- package/ionic-module.d.ts +11 -12
- package/package.json +2 -2
- package/providers/picker-controller.d.ts +4 -1
- package/standalone/directives/index.d.ts +0 -1
- package/standalone/directives/proxies.d.ts +56 -7
- package/standalone/index.d.ts +1 -1
- package/standalone/navigation/router-outlet.d.ts +12 -4
- package/standalone/providers/picker-controller.d.ts +4 -1
- package/LICENSE +0 -21
- package/directives/control-value-accessors/radio-value-accessor.d.ts +0 -9
- package/esm2020/directives/control-value-accessors/radio-value-accessor.mjs +0 -42
- package/esm2020/standalone/directives/radio.mjs +0 -62
- package/standalone/directives/radio.d.ts +0 -22
- package/test/apps/ng14/node_modules/@angular/animations/README.md +0 -8
- package/test/apps/ng14/node_modules/@angular/cli/README.md +0 -5
- package/test/apps/ng14/node_modules/@angular/common/README.md +0 -8
- package/test/apps/ng14/node_modules/@angular/compiler/README.md +0 -8
- package/test/apps/ng14/node_modules/@angular/core/README.md +0 -8
- package/test/apps/ng14/node_modules/@angular/forms/README.md +0 -8
- package/test/apps/ng14/node_modules/@angular/platform-browser/README.md +0 -8
- package/test/apps/ng14/node_modules/@angular/platform-browser-dynamic/README.md +0 -8
- package/test/apps/ng14/node_modules/@angular/platform-server/README.md +0 -8
- package/test/apps/ng14/node_modules/@angular/router/README.md +0 -8
- package/test/apps/ng14/node_modules/@angular-devkit/build-angular/README.md +0 -20
- package/test/apps/ng14/node_modules/@angular-eslint/builder/README.md +0 -1
- package/test/apps/ng14/node_modules/@angular-eslint/eslint-plugin/README.md +0 -1
- package/test/apps/ng14/node_modules/@angular-eslint/eslint-plugin-template/README.md +0 -1
- package/test/apps/ng14/node_modules/@angular-eslint/schematics/README.md +0 -1
- package/test/apps/ng14/node_modules/@angular-eslint/template-parser/README.md +0 -1
- package/test/apps/ng14/node_modules/@ionic/angular/README.md +0 -74
- package/test/apps/ng14/node_modules/@nguniversal/builders/README.md +0 -76
- package/test/apps/ng14/node_modules/@types/express/README.md +0 -15
- package/test/apps/ng14/node_modules/@types/node/README.md +0 -16
- package/test/apps/ng14/node_modules/@typescript-eslint/eslint-plugin/README.md +0 -10
- package/test/apps/ng14/node_modules/@typescript-eslint/parser/README.md +0 -10
- package/test/apps/ng14/node_modules/concurrently/README.md +0 -315
- package/test/apps/ng14/node_modules/core-js/README.md +0 -2307
- package/test/apps/ng14/node_modules/cypress/README.md +0 -25
- package/test/apps/ng14/node_modules/eslint/README.md +0 -308
- package/test/apps/ng14/node_modules/rxjs/README.md +0 -107
- package/test/apps/ng14/node_modules/ts-loader/README.md +0 -731
- package/test/apps/ng14/node_modules/ts-node/README.md +0 -302
- package/test/apps/ng14/node_modules/tslib/README.md +0 -164
- package/test/apps/ng14/node_modules/typescript/README.md +0 -104
- package/test/apps/ng14/node_modules/typescript-eslint-language-service/README.md +0 -77
- package/test/apps/ng14/node_modules/wait-on/README.md +0 -297
- package/test/apps/ng14/node_modules/webpack/README.md +0 -721
- package/test/apps/ng14/node_modules/webpack-cli/README.md +0 -147
- package/test/apps/ng14/node_modules/zone.js/README.md +0 -141
- package/test/apps/ng15/node_modules/@angular/animations/README.md +0 -8
- package/test/apps/ng15/node_modules/@angular/cli/README.md +0 -5
- package/test/apps/ng15/node_modules/@angular/common/README.md +0 -8
- package/test/apps/ng15/node_modules/@angular/compiler/README.md +0 -8
- package/test/apps/ng15/node_modules/@angular/core/README.md +0 -8
- package/test/apps/ng15/node_modules/@angular/forms/README.md +0 -8
- package/test/apps/ng15/node_modules/@angular/platform-browser/README.md +0 -8
- package/test/apps/ng15/node_modules/@angular/platform-browser-dynamic/README.md +0 -8
- package/test/apps/ng15/node_modules/@angular/platform-server/README.md +0 -8
- package/test/apps/ng15/node_modules/@angular/router/README.md +0 -8
- package/test/apps/ng15/node_modules/@angular-devkit/build-angular/README.md +0 -20
- package/test/apps/ng15/node_modules/@angular-eslint/builder/README.md +0 -1
- package/test/apps/ng15/node_modules/@angular-eslint/eslint-plugin/README.md +0 -1
- package/test/apps/ng15/node_modules/@angular-eslint/eslint-plugin-template/README.md +0 -1
- package/test/apps/ng15/node_modules/@angular-eslint/schematics/README.md +0 -1
- package/test/apps/ng15/node_modules/@angular-eslint/template-parser/README.md +0 -1
- package/test/apps/ng15/node_modules/@ionic/angular/README.md +0 -74
- package/test/apps/ng15/node_modules/@nguniversal/builders/README.md +0 -76
- package/test/apps/ng15/node_modules/@nguniversal/express-engine/README.md +0 -118
- package/test/apps/ng15/node_modules/@types/express/README.md +0 -15
- package/test/apps/ng15/node_modules/@types/node/README.md +0 -16
- package/test/apps/ng15/node_modules/@typescript-eslint/eslint-plugin/README.md +0 -234
- package/test/apps/ng15/node_modules/@typescript-eslint/parser/README.md +0 -265
- package/test/apps/ng15/node_modules/concurrently/README.md +0 -315
- package/test/apps/ng15/node_modules/core-js/README.md +0 -2307
- package/test/apps/ng15/node_modules/cypress/README.md +0 -25
- package/test/apps/ng15/node_modules/eslint/README.md +0 -308
- package/test/apps/ng15/node_modules/rxjs/README.md +0 -107
- package/test/apps/ng15/node_modules/ts-loader/README.md +0 -731
- package/test/apps/ng15/node_modules/ts-node/README.md +0 -302
- package/test/apps/ng15/node_modules/tslib/README.md +0 -164
- package/test/apps/ng15/node_modules/typescript/README.md +0 -104
- package/test/apps/ng15/node_modules/typescript-eslint-language-service/README.md +0 -77
- package/test/apps/ng15/node_modules/wait-on/README.md +0 -297
- package/test/apps/ng15/node_modules/webpack/README.md +0 -721
- package/test/apps/ng15/node_modules/webpack-cli/README.md +0 -147
- package/test/apps/ng15/node_modules/zone.js/README.md +0 -141
- package/test/apps/ng16/node_modules/@angular/animations/README.md +0 -8
- package/test/apps/ng16/node_modules/@angular/cli/README.md +0 -5
- package/test/apps/ng16/node_modules/@angular/common/README.md +0 -8
- package/test/apps/ng16/node_modules/@angular/compiler/README.md +0 -8
- package/test/apps/ng16/node_modules/@angular/core/README.md +0 -8
- package/test/apps/ng16/node_modules/@angular/forms/README.md +0 -8
- package/test/apps/ng16/node_modules/@angular/platform-browser/README.md +0 -8
- package/test/apps/ng16/node_modules/@angular/platform-browser-dynamic/README.md +0 -8
- package/test/apps/ng16/node_modules/@angular/platform-server/README.md +0 -8
- package/test/apps/ng16/node_modules/@angular/router/README.md +0 -8
- package/test/apps/ng16/node_modules/@angular-devkit/build-angular/README.md +0 -20
- package/test/apps/ng16/node_modules/@angular-eslint/builder/README.md +0 -1
- package/test/apps/ng16/node_modules/@angular-eslint/eslint-plugin/README.md +0 -84
- package/test/apps/ng16/node_modules/@angular-eslint/eslint-plugin-template/README.md +0 -93
- package/test/apps/ng16/node_modules/@angular-eslint/schematics/README.md +0 -1
- package/test/apps/ng16/node_modules/@angular-eslint/template-parser/README.md +0 -1
- package/test/apps/ng16/node_modules/@ionic/angular/README.md +0 -74
- package/test/apps/ng16/node_modules/@nguniversal/builders/README.md +0 -76
- package/test/apps/ng16/node_modules/@nguniversal/express-engine/README.md +0 -118
- package/test/apps/ng16/node_modules/@types/express/README.md +0 -15
- package/test/apps/ng16/node_modules/@types/node/README.md +0 -16
- package/test/apps/ng16/node_modules/@typescript-eslint/eslint-plugin/README.md +0 -234
- package/test/apps/ng16/node_modules/@typescript-eslint/parser/README.md +0 -265
- package/test/apps/ng16/node_modules/concurrently/README.md +0 -315
- package/test/apps/ng16/node_modules/core-js/README.md +0 -2307
- package/test/apps/ng16/node_modules/cypress/README.md +0 -25
- package/test/apps/ng16/node_modules/eslint/README.md +0 -308
- package/test/apps/ng16/node_modules/rxjs/README.md +0 -107
- package/test/apps/ng16/node_modules/ts-loader/README.md +0 -731
- package/test/apps/ng16/node_modules/ts-node/README.md +0 -302
- package/test/apps/ng16/node_modules/tslib/README.md +0 -164
- package/test/apps/ng16/node_modules/typescript/README.md +0 -49
- package/test/apps/ng16/node_modules/typescript-eslint-language-service/README.md +0 -77
- package/test/apps/ng16/node_modules/wait-on/README.md +0 -297
- package/test/apps/ng16/node_modules/webpack/README.md +0 -721
- package/test/apps/ng16/node_modules/webpack-cli/README.md +0 -147
- package/test/apps/ng16/node_modules/zone.js/README.md +0 -141
- package/test/apps/ng17/node_modules/@angular/animations/README.md +0 -8
- package/test/apps/ng17/node_modules/@angular/cli/README.md +0 -5
- package/test/apps/ng17/node_modules/@angular/common/README.md +0 -8
- package/test/apps/ng17/node_modules/@angular/compiler/README.md +0 -8
- package/test/apps/ng17/node_modules/@angular/core/README.md +0 -8
- package/test/apps/ng17/node_modules/@angular/forms/README.md +0 -8
- package/test/apps/ng17/node_modules/@angular/platform-browser/README.md +0 -8
- package/test/apps/ng17/node_modules/@angular/platform-browser-dynamic/README.md +0 -8
- package/test/apps/ng17/node_modules/@angular/platform-server/README.md +0 -8
- package/test/apps/ng17/node_modules/@angular/router/README.md +0 -8
- package/test/apps/ng17/node_modules/@angular-devkit/build-angular/README.md +0 -24
- package/test/apps/ng17/node_modules/@angular-eslint/builder/README.md +0 -1
- package/test/apps/ng17/node_modules/@angular-eslint/eslint-plugin/README.md +0 -84
- package/test/apps/ng17/node_modules/@angular-eslint/eslint-plugin-template/README.md +0 -94
- package/test/apps/ng17/node_modules/@angular-eslint/schematics/README.md +0 -1
- package/test/apps/ng17/node_modules/@angular-eslint/template-parser/README.md +0 -1
- package/test/apps/ng17/node_modules/@ionic/angular/README.md +0 -74
- package/test/apps/ng17/node_modules/@types/express/README.md +0 -15
- package/test/apps/ng17/node_modules/@types/ws/README.md +0 -16
- package/test/apps/ng17/node_modules/@typescript-eslint/eslint-plugin/README.md +0 -12
- package/test/apps/ng17/node_modules/@typescript-eslint/parser/README.md +0 -12
- package/test/apps/ng17/node_modules/concurrently/README.md +0 -315
- package/test/apps/ng17/node_modules/core-js/README.md +0 -95
- package/test/apps/ng17/node_modules/cypress/README.md +0 -25
- package/test/apps/ng17/node_modules/eslint/README.md +0 -308
- package/test/apps/ng17/node_modules/rxjs/README.md +0 -107
- package/test/apps/ng17/node_modules/ts-loader/README.md +0 -731
- package/test/apps/ng17/node_modules/ts-node/README.md +0 -302
- package/test/apps/ng17/node_modules/tslib/README.md +0 -164
- package/test/apps/ng17/node_modules/typescript/README.md +0 -51
- package/test/apps/ng17/node_modules/typescript-eslint-language-service/README.md +0 -77
- package/test/apps/ng17/node_modules/wait-on/README.md +0 -297
- package/test/apps/ng17/node_modules/webpack/README.md +0 -721
- package/test/apps/ng17/node_modules/webpack-cli/README.md +0 -147
- package/test/apps/ng17/node_modules/zone.js/README.md +0 -141
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
# @ionic/angular
|
|
2
|
-
|
|
3
|
-
Ionic Angular specific building blocks on top of [@ionic/core](https://www.npmjs.com/package/@ionic/core) components.
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
## Related
|
|
7
|
-
|
|
8
|
-
* [Ionic Core Components](https://www.npmjs.com/package/@ionic/core)
|
|
9
|
-
* [Ionic Documentation](https://ionicframework.com/docs/)
|
|
10
|
-
* [Ionic Discord](https://ionic.link/discord)
|
|
11
|
-
* [Ionic Forum](https://forum.ionicframework.com/)
|
|
12
|
-
* [Ionicons](http://ionicons.com/)
|
|
13
|
-
* [Stencil](https://stenciljs.com/)
|
|
14
|
-
* [Capacitor](https://capacitor.ionicframework.com/)
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
## License
|
|
18
|
-
|
|
19
|
-
* [MIT](https://raw.githubusercontent.com/ionic-team/ionic/main/LICENSE)
|
|
20
|
-
|
|
21
|
-
## Testing ng-add in ionic
|
|
22
|
-
|
|
23
|
-
1. Pull the latest from `main`
|
|
24
|
-
2. Build ionic/angular: `npm run build`
|
|
25
|
-
3. Run `npm link` from `ionic/angular/dist` directory
|
|
26
|
-
4. Create a blank angular project
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
ng new add-test
|
|
30
|
-
// Say yes to including the router, we need it
|
|
31
|
-
cd add-test
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
5. To run schematics locally, we need the schematics-cli (once published, this will not be needed)
|
|
35
|
-
|
|
36
|
-
```
|
|
37
|
-
npm install @angular-devkit/schematics-cli
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
6. Link `@ionic/angular`
|
|
41
|
-
|
|
42
|
-
```
|
|
43
|
-
npm link @ionic/angular
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
7. Run the local copy of the ng-add schematic
|
|
48
|
-
|
|
49
|
-
```
|
|
50
|
-
$ npx schematics @ionic/angular:ng-add
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
You'll now be able to add ionic components to a vanilla Angular app setup.
|
|
55
|
-
|
|
56
|
-
## Project Structure
|
|
57
|
-
|
|
58
|
-
**common**
|
|
59
|
-
|
|
60
|
-
This is where logic that is shared between lazy loaded and standalone components live. For example, the lazy loaded IonPopover and standalone IonPopover components extend from a base IonPopover implementation that exists in this directory.
|
|
61
|
-
|
|
62
|
-
**Note:** This directory exposes internal APIs and is only accessed in the `standalone` and `src` submodules. Ionic developers should never import directly from `@ionic/angular/common`. Instead, they should import from `@ionic/angular` or `@ionic/angular/standalone`.
|
|
63
|
-
|
|
64
|
-
**standalone**
|
|
65
|
-
|
|
66
|
-
This is where the standalone component implementations live. It was added as a separate entry point to avoid any lazy loaded logic from accidentally being pulled in to the final build. Having a separate directory allows the lazy loaded implementation to remain accessible from `@ionic/angular` for backwards compatibility.
|
|
67
|
-
|
|
68
|
-
Ionic developers can access this by importing from `@ionic/angular/standalone`.
|
|
69
|
-
|
|
70
|
-
**src**
|
|
71
|
-
|
|
72
|
-
This is where the lazy loaded component implementations live.
|
|
73
|
-
|
|
74
|
-
Ionic developers can access this by importing from `@ionic/angular`.
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
# Angular Universal Builders
|
|
2
|
-
|
|
3
|
-
Angular Universal comes with some custom Builders. All Parameters are also specified in their schema.json file.
|
|
4
|
-
|
|
5
|
-
# Builders
|
|
6
|
-
|
|
7
|
-
- prerender
|
|
8
|
-
- ssr-dev-server
|
|
9
|
-
- static-generator
|
|
10
|
-
|
|
11
|
-
## Prerender
|
|
12
|
-
|
|
13
|
-
### Description
|
|
14
|
-
|
|
15
|
-
This builder is used to prerender pages of your application. Prerendering is the process where a dynamic page is processed at build time generating static HTML.
|
|
16
|
-
|
|
17
|
-
For more information about this see: https://angular.io/guide/prerendering
|
|
18
|
-
|
|
19
|
-
Use this if you want to serve fast Pages, where you don't have changing Content on _each request_.
|
|
20
|
-
|
|
21
|
-
### Options
|
|
22
|
-
|
|
23
|
-
| Name | Type of Value | Description | Required |
|
|
24
|
-
| ------------- | -------------------------------------------- | --------------------------------------------------------------------------------- | -------- |
|
|
25
|
-
| browserTarget | Pattern: `^[^:\s]+:[^:\s]+(:[^\s]+)?$` | Target to build. | ✔️ |
|
|
26
|
-
| serverTarget | Pattern: `^[^:\s]+:[^:\s]+(:[^\s]+)?$` | Server target to use for prerendering the app. | ✔️ |
|
|
27
|
-
| routesFile | A Filename - Attention no schema validation! | The path to a file containing routes separated by newlines. | |
|
|
28
|
-
| routes | Unique Strings | The routes to render. | |
|
|
29
|
-
| guessRoutes | Bolean (default: true) | Whether or not the builder should extract routes and guess which paths to render. | |
|
|
30
|
-
| numProcesses | Number (min: 1, default: 1) | The number of cpus to use. Defaults to all but one. | |
|
|
31
|
-
|
|
32
|
-
## SSR Dev Server
|
|
33
|
-
|
|
34
|
-
### Summary
|
|
35
|
-
|
|
36
|
-
This command is similar to ng serve, which offers live reload during development, but uses server-side rendering.
|
|
37
|
-
The application runs in watch mode and refreshes the browser after every change. This command is slower than the actual ng serve command.
|
|
38
|
-
|
|
39
|
-
Attention: This builder is _only for local development_.
|
|
40
|
-
|
|
41
|
-
### Options
|
|
42
|
-
|
|
43
|
-
| Name | Type of Value | Description | Required |
|
|
44
|
-
| ------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
|
|
45
|
-
| browserTarget | Pattern: `.+:.+(:.+)?` | Target to build. | ✔️ |
|
|
46
|
-
| serverTarget | Pattern: `.+:.+(:.+)?` | Server target to build. | ✔️ |
|
|
47
|
-
| host | string (default: localhost) | Host to listen on. | |
|
|
48
|
-
| port | number (default: 4200) | Port to start the development server at. Default is 4200. Pass 0 to get a dynamically assigned port. | |
|
|
49
|
-
| publicHost | string | The URL that the browser client should use to connect to the development server. Use for a complex dev server setup, such as one with reverse proxies. | |
|
|
50
|
-
| open | boolean (default: false) | Opens the url in default browser. | |
|
|
51
|
-
| progress | boolean (default: true) | Log progress to the console while building. | |
|
|
52
|
-
| inspect | boolean (default: false) | Launch the development server in inspector mode and listen on address and port '127.0.0.1:9229'. | |
|
|
53
|
-
| ssl | boolean (default: false) | Serve using HTTPS. | |
|
|
54
|
-
| sslKey | string | SSL key to use for serving HTTPS. | |
|
|
55
|
-
| sslCert | string | SSL certificate to use for serving HTTPS. | |
|
|
56
|
-
| proxyConfig | string | Proxy configuration file. | |
|
|
57
|
-
|
|
58
|
-
## Static Generator
|
|
59
|
-
|
|
60
|
-
### Description
|
|
61
|
-
|
|
62
|
-
This builder is used to prerender pages of your application using the experimental [Clover](../common/clover/README.md) implementation.
|
|
63
|
-
Prerendering is the process where a dynamic page is processed at build time generating static HTML.
|
|
64
|
-
|
|
65
|
-
Attention:
|
|
66
|
-
Use this if you don't have any server side Code - as "serverTarget" is not configurable.
|
|
67
|
-
|
|
68
|
-
### Option
|
|
69
|
-
|
|
70
|
-
| Name | Type of Value | Description | Required |
|
|
71
|
-
| ------------- | -------------------------------------- | --------------------------------------------------------------------------------- | -------- |
|
|
72
|
-
| browserTarget | Pattern: `^[^:\s]+:[^:\s]+(:[^\s]+)?$` | Target to build. | ✔️ |
|
|
73
|
-
| routesFile | string | The path to a file containing routes separated by newlines. | |
|
|
74
|
-
| routes | array of Unique Strings | The routes to render. | |
|
|
75
|
-
| guessRoutes | boolean (default: true) | Whether or not the builder should extract routes and guess which paths to render. | |
|
|
76
|
-
| numProcesses | number (min: 1, default: 1) | The number of cpus to use. Defaults to all but one. | |
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Installation
|
|
2
|
-
> `npm install --save @types/express`
|
|
3
|
-
|
|
4
|
-
# Summary
|
|
5
|
-
This package contains type definitions for express (http://expressjs.com).
|
|
6
|
-
|
|
7
|
-
# Details
|
|
8
|
-
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express.
|
|
9
|
-
|
|
10
|
-
### Additional Details
|
|
11
|
-
* Last updated: Tue, 07 Nov 2023 03:09:36 GMT
|
|
12
|
-
* Dependencies: [@types/body-parser](https://npmjs.com/package/@types/body-parser), [@types/express-serve-static-core](https://npmjs.com/package/@types/express-serve-static-core), [@types/qs](https://npmjs.com/package/@types/qs), [@types/serve-static](https://npmjs.com/package/@types/serve-static)
|
|
13
|
-
|
|
14
|
-
# Credits
|
|
15
|
-
These definitions were written by [Boris Yankov](https://github.com/borisyankov), [China Medical University Hospital](https://github.com/CMUH), [Puneet Arora](https://github.com/puneetar), and [Dylan Frankland](https://github.com/dfrankland).
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
# Installation
|
|
2
|
-
> `npm install --save @types/node`
|
|
3
|
-
|
|
4
|
-
# Summary
|
|
5
|
-
This package contains type definitions for Node.js (https://nodejs.org/).
|
|
6
|
-
|
|
7
|
-
# Details
|
|
8
|
-
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v12.
|
|
9
|
-
|
|
10
|
-
### Additional Details
|
|
11
|
-
* Last updated: Tue, 07 Jun 2022 19:01:37 GMT
|
|
12
|
-
* Dependencies: none
|
|
13
|
-
* Global values: `Buffer`, `NodeJS`, `__dirname`, `__filename`, `clearImmediate`, `clearInterval`, `clearTimeout`, `console`, `exports`, `global`, `module`, `process`, `queueMicrotask`, `require`, `setImmediate`, `setInterval`, `setTimeout`
|
|
14
|
-
|
|
15
|
-
# Credits
|
|
16
|
-
These definitions were written by [Microsoft TypeScript](https://github.com/Microsoft), [DefinitelyTyped](https://github.com/DefinitelyTyped), [Alberto Schiabel](https://github.com/jkomyno), [Alvis HT Tang](https://github.com/alvis), [Andrew Makarov](https://github.com/r3nya), [Benjamin Toueg](https://github.com/btoueg), [Chigozirim C.](https://github.com/smac89), [David Junger](https://github.com/touffy), [Deividas Bakanas](https://github.com/DeividasBakanas), [Eugene Y. Q. Shen](https://github.com/eyqs), [Hannes Magnusson](https://github.com/Hannes-Magnusson-CK), [Hoàng Văn Khải](https://github.com/KSXGitHub), [Huw](https://github.com/hoo29), [Kelvin Jin](https://github.com/kjin), [Klaus Meinhardt](https://github.com/ajafff), [Lishude](https://github.com/islishude), [Mariusz Wiktorczyk](https://github.com/mwiktorczyk), [Mohsen Azimi](https://github.com/mohsen1), [Nicolas Even](https://github.com/n-e), [Nikita Galkin](https://github.com/galkin), [Parambir Singh](https://github.com/parambirs), [Sebastian Silbermann](https://github.com/eps1lon), [Simon Schick](https://github.com/SimonSchick), [Thomas den Hollander](https://github.com/ThomasdenH), [Wilco Bakker](https://github.com/WilcoBakker), [wwwy3y3](https://github.com/wwwy3y3), [Zane Hannan AU](https://github.com/ZaneHannanAU), [Samuel Ainsworth](https://github.com/samuela), [Kyle Uehlein](https://github.com/kuehlein), [Thanik Bhongbhibhat](https://github.com/bhongy), [Marcin Kopacz](https://github.com/chyzwar), [Trivikram Kamat](https://github.com/trivikr), [Junxiao Shi](https://github.com/yoursunny), [Ilia Baryshnikov](https://github.com/qwelias), and [ExE Boss](https://github.com/ExE-Boss).
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
# `@typescript-eslint/eslint-plugin`
|
|
2
|
-
|
|
3
|
-
An ESLint plugin which provides lint rules for TypeScript codebases.
|
|
4
|
-
|
|
5
|
-
[](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
|
|
6
|
-
[](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
|
|
7
|
-
|
|
8
|
-
👉 See **https://typescript-eslint.io/architecture/utils** for our Getting Started docs.
|
|
9
|
-
|
|
10
|
-
> See https://typescript-eslint.io for general documentation on typescript-eslint, the tooling that allows you to run ESLint and Prettier on TypeScript code.
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
# `@typescript-eslint/parser`
|
|
2
|
-
|
|
3
|
-
> An ESLint parser which leverages <a href="https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/typescript-estree">TypeScript ESTree</a> to allow for ESLint to lint TypeScript source code.
|
|
4
|
-
|
|
5
|
-
[](https://www.npmjs.com/package/@typescript-eslint/parser)
|
|
6
|
-
[](https://www.npmjs.com/package/@typescript-eslint/parser)
|
|
7
|
-
|
|
8
|
-
👉 See **https://typescript-eslint.io/packages/parser** for documentation on this package.
|
|
9
|
-
|
|
10
|
-
> See https://typescript-eslint.io for general documentation on typescript-eslint, the tooling that allows you to run ESLint and Prettier on TypeScript code.
|
|
@@ -1,315 +0,0 @@
|
|
|
1
|
-
# Concurrently
|
|
2
|
-
|
|
3
|
-
[](https://github.com/open-cli-tools/concurrently/actions?workflow=Tests)
|
|
4
|
-
[](https://coveralls.io/github/open-cli-tools/concurrently?branch=master)
|
|
5
|
-
|
|
6
|
-
[](https://www.npmjs.com/package/concurrently)
|
|
7
|
-
|
|
8
|
-
Run multiple commands concurrently.
|
|
9
|
-
Like `npm run watch-js & npm run watch-less` but better.
|
|
10
|
-
|
|
11
|
-

|
|
12
|
-
|
|
13
|
-
**Table of contents**
|
|
14
|
-
- [Concurrently](#concurrently)
|
|
15
|
-
- [Why](#why)
|
|
16
|
-
- [Install](#install)
|
|
17
|
-
- [Usage](#usage)
|
|
18
|
-
- [Programmatic Usage](#programmatic-usage)
|
|
19
|
-
- [`concurrently(commands[, options])`](#concurrentlycommands-options)
|
|
20
|
-
- [FAQ](#faq)
|
|
21
|
-
|
|
22
|
-
## Why
|
|
23
|
-
|
|
24
|
-
I like [task automation with npm](https://github.com/substack/blog/blob/master/npm_run.markdown)
|
|
25
|
-
but the usual way to run multiple commands concurrently is
|
|
26
|
-
`npm run watch-js & npm run watch-css`. That's fine but it's hard to keep
|
|
27
|
-
on track of different outputs. Also if one process fails, others still keep running
|
|
28
|
-
and you won't even notice the difference.
|
|
29
|
-
|
|
30
|
-
Another option would be to just run all commands in separate terminals. I got
|
|
31
|
-
tired of opening terminals and made **concurrently**.
|
|
32
|
-
|
|
33
|
-
**Features:**
|
|
34
|
-
|
|
35
|
-
* Cross platform (including Windows)
|
|
36
|
-
* Output is easy to follow with prefixes
|
|
37
|
-
* With `--kill-others` switch, all commands are killed if one dies
|
|
38
|
-
* Spawns commands with [spawn-command](https://github.com/mmalecki/spawn-command)
|
|
39
|
-
|
|
40
|
-
## Install
|
|
41
|
-
|
|
42
|
-
The tool is written in Node.js, but you can use it to run **any** commands.
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
npm install -g concurrently
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
or if you are using it from npm scripts:
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
npm install concurrently --save
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
## Usage
|
|
55
|
-
|
|
56
|
-
Remember to surround separate commands with quotes:
|
|
57
|
-
```bash
|
|
58
|
-
concurrently "command1 arg" "command2 arg"
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
Otherwise **concurrently** would try to run 4 separate commands:
|
|
62
|
-
`command1`, `arg`, `command2`, `arg`.
|
|
63
|
-
|
|
64
|
-
In package.json, escape quotes:
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
"start": "concurrently \"command1 arg\" \"command2 arg\""
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
NPM run commands can be shortened:
|
|
71
|
-
|
|
72
|
-
```bash
|
|
73
|
-
concurrently "npm:watch-js" "npm:watch-css" "npm:watch-node"
|
|
74
|
-
|
|
75
|
-
# Equivalent to:
|
|
76
|
-
concurrently -n watch-js,watch-css,watch-node "npm run watch-js" "npm run watch-css" "npm run watch-node"
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
NPM shortened commands also support wildcards. Given the following scripts in
|
|
80
|
-
package.json:
|
|
81
|
-
|
|
82
|
-
```javascript
|
|
83
|
-
{
|
|
84
|
-
//...
|
|
85
|
-
"scripts": {
|
|
86
|
-
// ...
|
|
87
|
-
"watch-js": "...",
|
|
88
|
-
"watch-css": "...",
|
|
89
|
-
"watch-node": "...",
|
|
90
|
-
// ...
|
|
91
|
-
},
|
|
92
|
-
// ...
|
|
93
|
-
}
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
```bash
|
|
97
|
-
concurrently "npm:watch-*"
|
|
98
|
-
|
|
99
|
-
# Equivalent to:
|
|
100
|
-
concurrently -n js,css,node "npm run watch-js" "npm run watch-css" "npm run watch-node"
|
|
101
|
-
|
|
102
|
-
# Any name provided for the wildcard command will be used as a prefix to the wildcard
|
|
103
|
-
# part of the script name:
|
|
104
|
-
concurrently -n w: npm:watch-*
|
|
105
|
-
|
|
106
|
-
# Equivalent to:
|
|
107
|
-
concurrently -n w:js,w:css,w:node "npm run watch-js" "npm run watch-css" "npm run watch-node"
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
Good frontend one-liner example [here](https://github.com/kimmobrunfeldt/dont-copy-paste-this-frontend-template/blob/5cd2bde719654941bdfc0a42c6f1b8e69ae79980/package.json#L9).
|
|
111
|
-
|
|
112
|
-
Help:
|
|
113
|
-
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
concurrently [options] <command ...>
|
|
117
|
-
|
|
118
|
-
General
|
|
119
|
-
-m, --max-processes How many processes should run at once.
|
|
120
|
-
New processes only spawn after all restart tries of a
|
|
121
|
-
process. [number]
|
|
122
|
-
-n, --names List of custom names to be used in prefix template.
|
|
123
|
-
Example names: "main,browser,server" [string]
|
|
124
|
-
--name-separator The character to split <names> on. Example usage:
|
|
125
|
-
concurrently -n "styles|scripts|server" --name-separator
|
|
126
|
-
"|" [default: ","]
|
|
127
|
-
-r, --raw Output only raw output of processes, disables
|
|
128
|
-
prettifying and concurrently coloring. [boolean]
|
|
129
|
-
-s, --success Return exit code of zero or one based on the success or
|
|
130
|
-
failure of the "first" child to terminate, the "last
|
|
131
|
-
child", or succeed only if "all" child processes
|
|
132
|
-
succeed.
|
|
133
|
-
[choices: "first", "last", "all"] [default: "all"]
|
|
134
|
-
--no-color Disables colors from logging [boolean]
|
|
135
|
-
--hide Comma-separated list of processes to hide the output.
|
|
136
|
-
The processes can be identified by their name or index.
|
|
137
|
-
[string] [default: ""]
|
|
138
|
-
|
|
139
|
-
Prefix styling
|
|
140
|
-
-p, --prefix Prefix used in logging for each process.
|
|
141
|
-
Possible values: index, pid, time, command, name,
|
|
142
|
-
none, or a template. Example template: "{time}-{pid}"
|
|
143
|
-
[string] [default: index or name (when --names is set)]
|
|
144
|
-
-c, --prefix-colors Comma-separated list of chalk colors to use on
|
|
145
|
-
prefixes. If there are more commands than colors, the
|
|
146
|
-
last color will be repeated.
|
|
147
|
-
- Available modifiers: reset, bold, dim, italic,
|
|
148
|
-
underline, inverse, hidden, strikethrough
|
|
149
|
-
- Available colors: black, red, green, yellow, blue,
|
|
150
|
-
magenta, cyan, white, gray, or any hex values for
|
|
151
|
-
colors, eg #23de43
|
|
152
|
-
- Available background colors: bgBlack, bgRed,
|
|
153
|
-
bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite
|
|
154
|
-
See https://www.npmjs.com/package/chalk for more
|
|
155
|
-
information. [string] [default: "reset"]
|
|
156
|
-
-l, --prefix-length Limit how many characters of the command is displayed
|
|
157
|
-
in prefix. The option can be used to shorten the
|
|
158
|
-
prefix when it is set to "command"
|
|
159
|
-
[number] [default: 10]
|
|
160
|
-
-t, --timestamp-format Specify the timestamp in moment/date-fns format.
|
|
161
|
-
[string] [default: "yyyy-MM-dd HH:mm:ss.SSS"]
|
|
162
|
-
|
|
163
|
-
Input handling
|
|
164
|
-
-i, --handle-input Whether input should be forwarded to the child
|
|
165
|
-
processes. See examples for more information.[boolean]
|
|
166
|
-
--default-input-target Identifier for child process to which input on stdin
|
|
167
|
-
should be sent if not specified at start of input.
|
|
168
|
-
Can be either the index or the name of the process.
|
|
169
|
-
[default: 0]
|
|
170
|
-
|
|
171
|
-
Killing other processes
|
|
172
|
-
-k, --kill-others kill other processes if one exits or dies [boolean]
|
|
173
|
-
--kill-others-on-fail kill other processes if one exits with non zero status
|
|
174
|
-
code [boolean]
|
|
175
|
-
|
|
176
|
-
Restarting
|
|
177
|
-
--restart-tries How many times a process that died should restart.
|
|
178
|
-
Negative numbers will make the process restart forever.
|
|
179
|
-
[number] [default: 0]
|
|
180
|
-
--restart-after Delay time to respawn the process, in milliseconds.
|
|
181
|
-
[number] [default: 0]
|
|
182
|
-
|
|
183
|
-
Options:
|
|
184
|
-
-h, --help Show help [boolean]
|
|
185
|
-
-v, -V, --version Show version number [boolean]
|
|
186
|
-
|
|
187
|
-
Examples:
|
|
188
|
-
|
|
189
|
-
- Output nothing more than stdout+stderr of child processes
|
|
190
|
-
|
|
191
|
-
$ concurrently --raw "npm run watch-less" "npm run watch-js"
|
|
192
|
-
|
|
193
|
-
- Normal output but without colors e.g. when logging to file
|
|
194
|
-
|
|
195
|
-
$ concurrently --no-color "grunt watch" "http-server" > log
|
|
196
|
-
|
|
197
|
-
- Custom prefix
|
|
198
|
-
|
|
199
|
-
$ concurrently --prefix "{time}-{pid}" "npm run watch" "http-server"
|
|
200
|
-
|
|
201
|
-
- Custom names and colored prefixes
|
|
202
|
-
|
|
203
|
-
$ concurrently --names "HTTP,WATCH" -c "bgBlue.bold,bgMagenta.bold"
|
|
204
|
-
"http-server" "npm run watch"
|
|
205
|
-
|
|
206
|
-
- Configuring via environment variables with CONCURRENTLY_ prefix
|
|
207
|
-
|
|
208
|
-
$ CONCURRENTLY_RAW=true CONCURRENTLY_KILL_OTHERS=true concurrently "echo hello" "echo world"
|
|
209
|
-
|
|
210
|
-
- Send input to default
|
|
211
|
-
|
|
212
|
-
$ concurrently --handle-input "nodemon" "npm run watch-js"
|
|
213
|
-
rs # Sends rs command to nodemon process
|
|
214
|
-
|
|
215
|
-
- Send input to specific child identified by index
|
|
216
|
-
|
|
217
|
-
$ concurrently --handle-input "npm run watch-js" nodemon
|
|
218
|
-
1:rs
|
|
219
|
-
|
|
220
|
-
- Send input to specific child identified by name
|
|
221
|
-
|
|
222
|
-
$ concurrently --handle-input -n js,srv "npm run watch-js" nodemon
|
|
223
|
-
srv:rs
|
|
224
|
-
|
|
225
|
-
- Shortened NPM run commands
|
|
226
|
-
|
|
227
|
-
$ concurrently npm:watch-node npm:watch-js npm:watch-css
|
|
228
|
-
|
|
229
|
-
- Shortened NPM run command with wildcard (make sure to wrap it in quotes!)
|
|
230
|
-
|
|
231
|
-
$ concurrently "npm:watch-*"
|
|
232
|
-
|
|
233
|
-
For more details, visit https://github.com/open-cli-tools/concurrently
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
## Programmatic Usage
|
|
237
|
-
concurrently can be used programmatically by using the API documented below:
|
|
238
|
-
|
|
239
|
-
### `concurrently(commands[, options])`
|
|
240
|
-
|
|
241
|
-
- `commands`: an array of either strings (containing the commands to run) or objects
|
|
242
|
-
with the shape `{ command, name, prefixColor, env, cwd }`.
|
|
243
|
-
|
|
244
|
-
- `options` (optional): an object containing any of the below:
|
|
245
|
-
- `cwd`: the working directory to be used by all commands. Can be overriden per command.
|
|
246
|
-
Default: `process.cwd()`.
|
|
247
|
-
- `defaultInputTarget`: the default input target when reading from `inputStream`.
|
|
248
|
-
Default: `0`.
|
|
249
|
-
- `handleInput`: when `true`, reads input from `process.stdin`.
|
|
250
|
-
- `inputStream`: a [`Readable` stream](https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_readable_streams)
|
|
251
|
-
to read the input from. Should only be used in the rare instance you would like to stream anything other than `process.stdin`. Overrides `handleInput`.
|
|
252
|
-
- `pauseInputStreamOnFinish`: by default, pauses the input stream (`process.stdin` when `handleInput` is enabled, or `inputStream` if provided) when all of the processes have finished. If you need to read from the input stream after `concurrently` has finished, set this to `false`. ([#252](https://github.com/kimmobrunfeldt/concurrently/issues/252)).
|
|
253
|
-
- `killOthers`: an array of exitting conditions that will cause a process to kill others.
|
|
254
|
-
Can contain any of `success` or `failure`.
|
|
255
|
-
- `maxProcesses`: how many processes should run at once.
|
|
256
|
-
- `outputStream`: a [`Writable` stream](https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_writable_streams)
|
|
257
|
-
to write logs to. Default: `process.stdout`.
|
|
258
|
-
- `prefix`: the prefix type to use when logging processes output.
|
|
259
|
-
Possible values: `index`, `pid`, `time`, `command`, `name`, `none`, or a template (eg `[{time} process: {pid}]`).
|
|
260
|
-
Default: the name of the process, or its index if no name is set.
|
|
261
|
-
- `prefixColors`: a list of colors as supported by [chalk](https://www.npmjs.com/package/chalk).
|
|
262
|
-
If concurrently would run more commands than there are colors, the last color is repeated.
|
|
263
|
-
Prefix colors specified per-command take precedence over this list.
|
|
264
|
-
- `prefixLength`: how many characters to show when prefixing with `command`. Default: `10`
|
|
265
|
-
- `raw`: whether raw mode should be used, meaning strictly process output will
|
|
266
|
-
be logged, without any prefixes, colouring or extra stuff.
|
|
267
|
-
- `successCondition`: the condition to consider the run was successful.
|
|
268
|
-
If `first`, only the first process to exit will make up the success of the run; if `last`, the last process that exits will determine whether the run succeeds.
|
|
269
|
-
Anything else means all processes should exit successfully.
|
|
270
|
-
- `restartTries`: how many attempts to restart a process that dies will be made. Default: `0`.
|
|
271
|
-
- `restartDelay`: how many milliseconds to wait between process restarts. Default: `0`.
|
|
272
|
-
- `timestampFormat`: a [date-fns format](https://date-fns.org/v2.0.1/docs/format)
|
|
273
|
-
to use when prefixing with `time`. Default: `yyyy-MM-dd HH:mm:ss.ZZZ`
|
|
274
|
-
|
|
275
|
-
> Returns: a `Promise` that resolves if the run was successful (according to `successCondition` option),
|
|
276
|
-
> or rejects, containing an array of objects with information for each command that has been run, in the order
|
|
277
|
-
> that the commands terminated. The objects have the shape `{ command, index, exitCode, killed }`, where `command` is the object
|
|
278
|
-
> passed in the `commands` array, `index` its index there and `killed` indicates if the process was killed as a result of
|
|
279
|
-
> `killOthers`. Default values (empty strings or objects) are returned for the fields that were not specified.
|
|
280
|
-
|
|
281
|
-
Example:
|
|
282
|
-
|
|
283
|
-
```js
|
|
284
|
-
const concurrently = require('concurrently');
|
|
285
|
-
concurrently([
|
|
286
|
-
'npm:watch-*',
|
|
287
|
-
{ command: 'nodemon', name: 'server' },
|
|
288
|
-
{ command: 'deploy', name: 'deploy', env: { PUBLIC_KEY: '...' } },
|
|
289
|
-
{ command: 'watch', name: 'watch', cwd: path.resolve(__dirname, 'scripts/watchers')}
|
|
290
|
-
], {
|
|
291
|
-
prefix: 'name',
|
|
292
|
-
killOthers: ['failure', 'success'],
|
|
293
|
-
restartTries: 3,
|
|
294
|
-
cwd: path.resolve(__dirname, 'scripts'),
|
|
295
|
-
}).then(success, failure);
|
|
296
|
-
```
|
|
297
|
-
|
|
298
|
-
## FAQ
|
|
299
|
-
|
|
300
|
-
* Process exited with code *null*?
|
|
301
|
-
|
|
302
|
-
From [Node child_process documentation](http://nodejs.org/api/child_process.html#child_process_event_exit), `exit` event:
|
|
303
|
-
|
|
304
|
-
> This event is emitted after the child process ends. If the process
|
|
305
|
-
> terminated normally, code is the final exit code of the process,
|
|
306
|
-
> otherwise null. If the process terminated due to receipt of a signal,
|
|
307
|
-
> signal is the string name of the signal, otherwise null.
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
So *null* means the process didn't terminate normally. This will make **concurrent**
|
|
311
|
-
to return non-zero exit code too.
|
|
312
|
-
|
|
313
|
-
* Does this work with the npm-replacements [yarn](https://github.com/yarnpkg/yarn) or [pnpm](https://pnpm.js.org/)?
|
|
314
|
-
|
|
315
|
-
Yes! In all examples above, you may replace "`npm`" with "`yarn`" or "`pnpm`".
|