@ionic/angular 7.6.2-dev.11702957417.1622fcc0 → 7.6.2-dev.11703182244.1165aeec

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.
Files changed (228) hide show
  1. package/directives/proxies.d.ts +1 -1
  2. package/esm2020/common/directives/control-value-accessors/value-accessor.mjs +4 -4
  3. package/esm2020/common/directives/navigation/back-button.mjs +4 -4
  4. package/esm2020/common/directives/navigation/nav.mjs +4 -4
  5. package/esm2020/common/directives/navigation/router-link-delegate.mjs +7 -7
  6. package/esm2020/common/directives/navigation/router-outlet.mjs +7 -7
  7. package/esm2020/common/directives/navigation/tabs.mjs +4 -4
  8. package/esm2020/common/overlays/modal.mjs +4 -4
  9. package/esm2020/common/overlays/popover.mjs +4 -4
  10. package/esm2020/common/providers/angular-delegate.mjs +4 -4
  11. package/esm2020/common/providers/config.mjs +4 -4
  12. package/esm2020/common/providers/dom-controller.mjs +4 -4
  13. package/esm2020/common/providers/nav-controller.mjs +4 -4
  14. package/esm2020/common/providers/platform.mjs +4 -4
  15. package/esm2020/directives/control-value-accessors/boolean-value-accessor.mjs +4 -4
  16. package/esm2020/directives/control-value-accessors/numeric-value-accessor.mjs +4 -4
  17. package/esm2020/directives/control-value-accessors/radio-value-accessor.mjs +4 -4
  18. package/esm2020/directives/control-value-accessors/select-value-accessor.mjs +4 -4
  19. package/esm2020/directives/control-value-accessors/text-value-accessor.mjs +4 -4
  20. package/esm2020/directives/navigation/ion-back-button.mjs +4 -4
  21. package/esm2020/directives/navigation/ion-nav.mjs +4 -4
  22. package/esm2020/directives/navigation/ion-router-outlet.mjs +4 -4
  23. package/esm2020/directives/navigation/ion-tabs.mjs +4 -4
  24. package/esm2020/directives/navigation/router-link-delegate.mjs +7 -7
  25. package/esm2020/directives/overlays/modal.mjs +4 -4
  26. package/esm2020/directives/overlays/popover.mjs +4 -4
  27. package/esm2020/directives/proxies.mjs +234 -234
  28. package/esm2020/directives/validators/max-validator.mjs +4 -4
  29. package/esm2020/directives/validators/min-validator.mjs +4 -4
  30. package/esm2020/ionic-module.mjs +5 -5
  31. package/esm2020/providers/action-sheet-controller.mjs +4 -4
  32. package/esm2020/providers/alert-controller.mjs +4 -4
  33. package/esm2020/providers/animation-controller.mjs +4 -4
  34. package/esm2020/providers/gesture-controller.mjs +4 -4
  35. package/esm2020/providers/loading-controller.mjs +4 -4
  36. package/esm2020/providers/menu-controller.mjs +4 -4
  37. package/esm2020/providers/modal-controller.mjs +4 -4
  38. package/esm2020/providers/picker-controller.mjs +4 -4
  39. package/esm2020/providers/toast-controller.mjs +4 -4
  40. package/esm2020/standalone/directives/checkbox.mjs +4 -4
  41. package/esm2020/standalone/directives/datetime.mjs +4 -4
  42. package/esm2020/standalone/directives/icon.mjs +4 -4
  43. package/esm2020/standalone/directives/input.mjs +4 -4
  44. package/esm2020/standalone/directives/proxies.mjs +198 -198
  45. package/esm2020/standalone/directives/radio-group.mjs +4 -4
  46. package/esm2020/standalone/directives/radio.mjs +4 -4
  47. package/esm2020/standalone/directives/range.mjs +4 -4
  48. package/esm2020/standalone/directives/searchbar.mjs +4 -4
  49. package/esm2020/standalone/directives/segment.mjs +4 -4
  50. package/esm2020/standalone/directives/select.mjs +4 -4
  51. package/esm2020/standalone/directives/textarea.mjs +4 -4
  52. package/esm2020/standalone/directives/toggle.mjs +4 -4
  53. package/esm2020/standalone/navigation/back-button.mjs +4 -4
  54. package/esm2020/standalone/navigation/nav.mjs +4 -4
  55. package/esm2020/standalone/navigation/router-link-delegate.mjs +7 -7
  56. package/esm2020/standalone/navigation/router-outlet.mjs +4 -4
  57. package/esm2020/standalone/navigation/tabs.mjs +4 -4
  58. package/esm2020/standalone/overlays/modal.mjs +4 -4
  59. package/esm2020/standalone/overlays/popover.mjs +4 -4
  60. package/esm2020/standalone/providers/action-sheet-controller.mjs +4 -4
  61. package/esm2020/standalone/providers/alert-controller.mjs +4 -4
  62. package/esm2020/standalone/providers/animation-controller.mjs +4 -4
  63. package/esm2020/standalone/providers/gesture-controller.mjs +4 -4
  64. package/esm2020/standalone/providers/loading-controller.mjs +4 -4
  65. package/esm2020/standalone/providers/menu-controller.mjs +4 -4
  66. package/esm2020/standalone/providers/modal-controller.mjs +4 -4
  67. package/esm2020/standalone/providers/picker-controller.mjs +4 -4
  68. package/esm2020/standalone/providers/toast-controller.mjs +4 -4
  69. package/fesm2015/ionic-angular-common.mjs +45 -45
  70. package/fesm2015/ionic-angular-common.mjs.map +1 -1
  71. package/fesm2015/ionic-angular-standalone.mjs +284 -284
  72. package/fesm2015/ionic-angular-standalone.mjs.map +1 -1
  73. package/fesm2015/ionic-angular.mjs +309 -309
  74. package/fesm2015/ionic-angular.mjs.map +1 -1
  75. package/fesm2020/ionic-angular-common.mjs +45 -45
  76. package/fesm2020/ionic-angular-common.mjs.map +1 -1
  77. package/fesm2020/ionic-angular-standalone.mjs +284 -284
  78. package/fesm2020/ionic-angular-standalone.mjs.map +1 -1
  79. package/fesm2020/ionic-angular.mjs +309 -309
  80. package/fesm2020/ionic-angular.mjs.map +1 -1
  81. package/package.json +2 -2
  82. package/standalone/directives/proxies.d.ts +1 -1
  83. package/LICENSE +0 -21
  84. package/test/apps/ng14/node_modules/@angular/animations/README.md +0 -8
  85. package/test/apps/ng14/node_modules/@angular/cli/README.md +0 -5
  86. package/test/apps/ng14/node_modules/@angular/common/README.md +0 -8
  87. package/test/apps/ng14/node_modules/@angular/compiler/README.md +0 -8
  88. package/test/apps/ng14/node_modules/@angular/core/README.md +0 -8
  89. package/test/apps/ng14/node_modules/@angular/forms/README.md +0 -8
  90. package/test/apps/ng14/node_modules/@angular/platform-browser/README.md +0 -8
  91. package/test/apps/ng14/node_modules/@angular/platform-browser-dynamic/README.md +0 -8
  92. package/test/apps/ng14/node_modules/@angular/platform-server/README.md +0 -8
  93. package/test/apps/ng14/node_modules/@angular/router/README.md +0 -8
  94. package/test/apps/ng14/node_modules/@angular-devkit/build-angular/README.md +0 -20
  95. package/test/apps/ng14/node_modules/@angular-eslint/builder/README.md +0 -1
  96. package/test/apps/ng14/node_modules/@angular-eslint/eslint-plugin/README.md +0 -1
  97. package/test/apps/ng14/node_modules/@angular-eslint/eslint-plugin-template/README.md +0 -1
  98. package/test/apps/ng14/node_modules/@angular-eslint/schematics/README.md +0 -1
  99. package/test/apps/ng14/node_modules/@angular-eslint/template-parser/README.md +0 -1
  100. package/test/apps/ng14/node_modules/@ionic/angular/README.md +0 -74
  101. package/test/apps/ng14/node_modules/@nguniversal/builders/README.md +0 -76
  102. package/test/apps/ng14/node_modules/@types/express/README.md +0 -15
  103. package/test/apps/ng14/node_modules/@types/node/README.md +0 -16
  104. package/test/apps/ng14/node_modules/@typescript-eslint/eslint-plugin/README.md +0 -10
  105. package/test/apps/ng14/node_modules/@typescript-eslint/parser/README.md +0 -10
  106. package/test/apps/ng14/node_modules/concurrently/README.md +0 -315
  107. package/test/apps/ng14/node_modules/core-js/README.md +0 -2307
  108. package/test/apps/ng14/node_modules/cypress/README.md +0 -25
  109. package/test/apps/ng14/node_modules/eslint/README.md +0 -308
  110. package/test/apps/ng14/node_modules/rxjs/README.md +0 -107
  111. package/test/apps/ng14/node_modules/ts-loader/README.md +0 -731
  112. package/test/apps/ng14/node_modules/ts-node/README.md +0 -302
  113. package/test/apps/ng14/node_modules/tslib/README.md +0 -164
  114. package/test/apps/ng14/node_modules/typescript/README.md +0 -104
  115. package/test/apps/ng14/node_modules/typescript-eslint-language-service/README.md +0 -77
  116. package/test/apps/ng14/node_modules/wait-on/README.md +0 -297
  117. package/test/apps/ng14/node_modules/webpack/README.md +0 -721
  118. package/test/apps/ng14/node_modules/webpack-cli/README.md +0 -147
  119. package/test/apps/ng14/node_modules/zone.js/README.md +0 -141
  120. package/test/apps/ng15/node_modules/@angular/animations/README.md +0 -8
  121. package/test/apps/ng15/node_modules/@angular/cli/README.md +0 -5
  122. package/test/apps/ng15/node_modules/@angular/common/README.md +0 -8
  123. package/test/apps/ng15/node_modules/@angular/compiler/README.md +0 -8
  124. package/test/apps/ng15/node_modules/@angular/core/README.md +0 -8
  125. package/test/apps/ng15/node_modules/@angular/forms/README.md +0 -8
  126. package/test/apps/ng15/node_modules/@angular/platform-browser/README.md +0 -8
  127. package/test/apps/ng15/node_modules/@angular/platform-browser-dynamic/README.md +0 -8
  128. package/test/apps/ng15/node_modules/@angular/platform-server/README.md +0 -8
  129. package/test/apps/ng15/node_modules/@angular/router/README.md +0 -8
  130. package/test/apps/ng15/node_modules/@angular-devkit/build-angular/README.md +0 -20
  131. package/test/apps/ng15/node_modules/@angular-eslint/builder/README.md +0 -1
  132. package/test/apps/ng15/node_modules/@angular-eslint/eslint-plugin/README.md +0 -1
  133. package/test/apps/ng15/node_modules/@angular-eslint/eslint-plugin-template/README.md +0 -1
  134. package/test/apps/ng15/node_modules/@angular-eslint/schematics/README.md +0 -1
  135. package/test/apps/ng15/node_modules/@angular-eslint/template-parser/README.md +0 -1
  136. package/test/apps/ng15/node_modules/@ionic/angular/README.md +0 -74
  137. package/test/apps/ng15/node_modules/@nguniversal/builders/README.md +0 -76
  138. package/test/apps/ng15/node_modules/@nguniversal/express-engine/README.md +0 -118
  139. package/test/apps/ng15/node_modules/@types/express/README.md +0 -15
  140. package/test/apps/ng15/node_modules/@types/node/README.md +0 -16
  141. package/test/apps/ng15/node_modules/@typescript-eslint/eslint-plugin/README.md +0 -234
  142. package/test/apps/ng15/node_modules/@typescript-eslint/parser/README.md +0 -265
  143. package/test/apps/ng15/node_modules/concurrently/README.md +0 -315
  144. package/test/apps/ng15/node_modules/core-js/README.md +0 -2307
  145. package/test/apps/ng15/node_modules/cypress/README.md +0 -25
  146. package/test/apps/ng15/node_modules/eslint/README.md +0 -308
  147. package/test/apps/ng15/node_modules/rxjs/README.md +0 -107
  148. package/test/apps/ng15/node_modules/ts-loader/README.md +0 -731
  149. package/test/apps/ng15/node_modules/ts-node/README.md +0 -302
  150. package/test/apps/ng15/node_modules/tslib/README.md +0 -164
  151. package/test/apps/ng15/node_modules/typescript/README.md +0 -104
  152. package/test/apps/ng15/node_modules/typescript-eslint-language-service/README.md +0 -77
  153. package/test/apps/ng15/node_modules/wait-on/README.md +0 -297
  154. package/test/apps/ng15/node_modules/webpack/README.md +0 -721
  155. package/test/apps/ng15/node_modules/webpack-cli/README.md +0 -147
  156. package/test/apps/ng15/node_modules/zone.js/README.md +0 -141
  157. package/test/apps/ng16/node_modules/@angular/animations/README.md +0 -8
  158. package/test/apps/ng16/node_modules/@angular/cli/README.md +0 -5
  159. package/test/apps/ng16/node_modules/@angular/common/README.md +0 -8
  160. package/test/apps/ng16/node_modules/@angular/compiler/README.md +0 -8
  161. package/test/apps/ng16/node_modules/@angular/core/README.md +0 -8
  162. package/test/apps/ng16/node_modules/@angular/forms/README.md +0 -8
  163. package/test/apps/ng16/node_modules/@angular/platform-browser/README.md +0 -8
  164. package/test/apps/ng16/node_modules/@angular/platform-browser-dynamic/README.md +0 -8
  165. package/test/apps/ng16/node_modules/@angular/platform-server/README.md +0 -8
  166. package/test/apps/ng16/node_modules/@angular/router/README.md +0 -8
  167. package/test/apps/ng16/node_modules/@angular-devkit/build-angular/README.md +0 -20
  168. package/test/apps/ng16/node_modules/@angular-eslint/builder/README.md +0 -1
  169. package/test/apps/ng16/node_modules/@angular-eslint/eslint-plugin/README.md +0 -84
  170. package/test/apps/ng16/node_modules/@angular-eslint/eslint-plugin-template/README.md +0 -93
  171. package/test/apps/ng16/node_modules/@angular-eslint/schematics/README.md +0 -1
  172. package/test/apps/ng16/node_modules/@angular-eslint/template-parser/README.md +0 -1
  173. package/test/apps/ng16/node_modules/@ionic/angular/README.md +0 -74
  174. package/test/apps/ng16/node_modules/@nguniversal/builders/README.md +0 -76
  175. package/test/apps/ng16/node_modules/@nguniversal/express-engine/README.md +0 -118
  176. package/test/apps/ng16/node_modules/@types/express/README.md +0 -15
  177. package/test/apps/ng16/node_modules/@types/node/README.md +0 -16
  178. package/test/apps/ng16/node_modules/@typescript-eslint/eslint-plugin/README.md +0 -234
  179. package/test/apps/ng16/node_modules/@typescript-eslint/parser/README.md +0 -265
  180. package/test/apps/ng16/node_modules/concurrently/README.md +0 -315
  181. package/test/apps/ng16/node_modules/core-js/README.md +0 -2307
  182. package/test/apps/ng16/node_modules/cypress/README.md +0 -25
  183. package/test/apps/ng16/node_modules/eslint/README.md +0 -308
  184. package/test/apps/ng16/node_modules/rxjs/README.md +0 -107
  185. package/test/apps/ng16/node_modules/ts-loader/README.md +0 -731
  186. package/test/apps/ng16/node_modules/ts-node/README.md +0 -302
  187. package/test/apps/ng16/node_modules/tslib/README.md +0 -164
  188. package/test/apps/ng16/node_modules/typescript/README.md +0 -49
  189. package/test/apps/ng16/node_modules/typescript-eslint-language-service/README.md +0 -77
  190. package/test/apps/ng16/node_modules/wait-on/README.md +0 -297
  191. package/test/apps/ng16/node_modules/webpack/README.md +0 -721
  192. package/test/apps/ng16/node_modules/webpack-cli/README.md +0 -147
  193. package/test/apps/ng16/node_modules/zone.js/README.md +0 -141
  194. package/test/apps/ng17/node_modules/@angular/animations/README.md +0 -8
  195. package/test/apps/ng17/node_modules/@angular/cli/README.md +0 -5
  196. package/test/apps/ng17/node_modules/@angular/common/README.md +0 -8
  197. package/test/apps/ng17/node_modules/@angular/compiler/README.md +0 -8
  198. package/test/apps/ng17/node_modules/@angular/core/README.md +0 -8
  199. package/test/apps/ng17/node_modules/@angular/forms/README.md +0 -8
  200. package/test/apps/ng17/node_modules/@angular/platform-browser/README.md +0 -8
  201. package/test/apps/ng17/node_modules/@angular/platform-browser-dynamic/README.md +0 -8
  202. package/test/apps/ng17/node_modules/@angular/platform-server/README.md +0 -8
  203. package/test/apps/ng17/node_modules/@angular/router/README.md +0 -8
  204. package/test/apps/ng17/node_modules/@angular-devkit/build-angular/README.md +0 -24
  205. package/test/apps/ng17/node_modules/@angular-eslint/builder/README.md +0 -1
  206. package/test/apps/ng17/node_modules/@angular-eslint/eslint-plugin/README.md +0 -84
  207. package/test/apps/ng17/node_modules/@angular-eslint/eslint-plugin-template/README.md +0 -94
  208. package/test/apps/ng17/node_modules/@angular-eslint/schematics/README.md +0 -1
  209. package/test/apps/ng17/node_modules/@angular-eslint/template-parser/README.md +0 -1
  210. package/test/apps/ng17/node_modules/@ionic/angular/README.md +0 -74
  211. package/test/apps/ng17/node_modules/@types/express/README.md +0 -15
  212. package/test/apps/ng17/node_modules/@types/ws/README.md +0 -16
  213. package/test/apps/ng17/node_modules/@typescript-eslint/eslint-plugin/README.md +0 -12
  214. package/test/apps/ng17/node_modules/@typescript-eslint/parser/README.md +0 -12
  215. package/test/apps/ng17/node_modules/concurrently/README.md +0 -315
  216. package/test/apps/ng17/node_modules/core-js/README.md +0 -95
  217. package/test/apps/ng17/node_modules/cypress/README.md +0 -25
  218. package/test/apps/ng17/node_modules/eslint/README.md +0 -308
  219. package/test/apps/ng17/node_modules/rxjs/README.md +0 -107
  220. package/test/apps/ng17/node_modules/ts-loader/README.md +0 -731
  221. package/test/apps/ng17/node_modules/ts-node/README.md +0 -302
  222. package/test/apps/ng17/node_modules/tslib/README.md +0 -164
  223. package/test/apps/ng17/node_modules/typescript/README.md +0 -51
  224. package/test/apps/ng17/node_modules/typescript-eslint-language-service/README.md +0 -77
  225. package/test/apps/ng17/node_modules/wait-on/README.md +0 -297
  226. package/test/apps/ng17/node_modules/webpack/README.md +0 -721
  227. package/test/apps/ng17/node_modules/webpack-cli/README.md +0 -147
  228. package/test/apps/ng17/node_modules/zone.js/README.md +0 -141
@@ -1,297 +0,0 @@
1
- # wait-on - wait for files, ports, sockets, http(s) resources
2
-
3
- wait-on is a cross-platform command line utility which will wait for files, ports, sockets, and http(s) resources to become available (or not available using reverse mode). Functionality is also available via a Node.js API. Cross-platform - runs everywhere Node.js runs (linux, unix, mac OS X, windows)
4
-
5
- wait-on will wait for period of time for a file to stop growing before triggering availability which is good for monitoring files that are being built. Likewise wait-on will wait for period of time for other resources to remain available before triggering success.
6
-
7
- For http(s) resources wait-on will check that the requests are returning 2XX (success) to HEAD or GET requests (after following any redirects).
8
-
9
- wait-on can also be used in reverse mode which waits for resources to NOT be available. This is useful in waiting for services to shutdown before continuing. (Thanks @skarbovskiy for adding this feature)
10
-
11
- [![Build Status](https://secure.travis-ci.org/jeffbski/wait-on.png?branch=master)](http://travis-ci.org/jeffbski/wait-on)
12
-
13
- ## Installation
14
-
15
- Latest version 3+ requires Node.js v8.9+
16
-
17
- (Node.js v4 users can still use wait-on@2.1.2, and older Node.js
18
- engines, use wait-on@1.5.4)
19
-
20
- ```bash
21
- npm install wait-on # local version
22
- OR
23
- npm install -g wait-on # global version
24
- ```
25
-
26
- ## Usage
27
-
28
- Use from command line or using Node.js programmatic API.
29
-
30
- ### CLI Usage
31
-
32
- Assuming NEXT_CMD is the command to run when resources are available, then wait-on will wait and then exit with a successful exit code (0) once all resources are available, causing NEXT_CMD to be run.
33
-
34
- wait-on can also be used in reverse mode, which waits for resources to NOT be available. This is useful in waiting for services to shutdown before continuing. (Thanks @skarbovskiy for adding)
35
-
36
- If wait-on is interrupted before all resources are available, it will exit with a non-zero exit code and thus NEXT_CMD will not be run.
37
-
38
- ```bash
39
- wait-on file1 && NEXT_CMD # wait for file1, then exec NEXT_CMD
40
- wait-on f1 f2 && NEXT_CMD # wait for both f1 and f2, the exec NEXT_CMD
41
- wait-on http://localhost:8000/foo && NEXT_CMD # wait for http 2XX HEAD
42
- wait-on https://myserver/foo && NEXT_CMD # wait for https 2XX HEAD
43
- wait-on http-get://localhost:8000/foo && NEXT_CMD # wait for http 2XX GET
44
- wait-on https-get://myserver/foo && NEXT_CMD # wait for https 2XX GET
45
- wait-on tcp:4000 && NEXT_CMD # wait for service to listen on a TCP port
46
- wait-on socket:/path/mysock # wait for service to listen on domain socket
47
- wait-on http://unix:/var/SOCKPATH:/a/foo # wait for http HEAD on domain socket
48
- wait-on http-get://unix:/var/SOCKPATH:/a/foo # wait for http GET on domain socket
49
- ```
50
-
51
- ```
52
- Usage: wait-on {OPTIONS} resource [...resource]
53
-
54
- Description:
55
-
56
- wait-on is a command line utility which will wait for files, ports,
57
- sockets, and http(s) resources to become available (or not available
58
- using reverse flag). Exits with success code (0) when all resources
59
- are ready. Non-zero exit code if interrupted or timed out.
60
-
61
- Options may also be specified in a config file (js or json). For
62
- example --config configFile.js would result in configFile.js being
63
- required and the resulting object will be merged with any
64
- command line options before wait-on is called. See exampleConfig.js
65
-
66
- In shell combine with && to conditionally run another command
67
- once resources are available. ex: wait-on f1 && NEXT_CMD
68
-
69
- resources types are defined by their prefix, if no prefix is
70
- present, the resource is assumed to be of type 'file'. Resources
71
- can also be provided in the config file.
72
-
73
- resource prefixes are:
74
-
75
- file: - regular file (also default type). ex: file:/path/to/file
76
- http: - HTTP HEAD returns 2XX response. ex: http://m.com:90/foo
77
- https: - HTTPS HEAD returns 2XX response. ex: https://my/bar
78
- http-get: - HTTP GET returns 2XX response. ex: http://m.com:90/foo
79
- https-get: - HTTPS GET returns 2XX response. ex: https://my/bar
80
- tcp: - TCP port is listening. ex: 1.2.3.4:9000 or foo.com:700
81
- socket: - Domain Socket is listening. ex: socket:/path/to/sock
82
- For http over socket, use http://unix:SOCK_PATH:URL_PATH
83
- like http://unix:/path/to/sock:/foo/bar or
84
- http-get://unix:/path/to/sock:/foo/bar
85
-
86
- Standard Options:
87
-
88
- -c, --config
89
-
90
- js or json config file, useful for http(s) options and resources
91
-
92
- -d, --delay
93
-
94
- Initial delay before checking for resources in ms, default 0
95
-
96
- --httpTimeout
97
-
98
- Maximum time in ms to wait for an HTTP HEAD/GET request, default 0
99
- which results in using the OS default
100
-
101
- -i, --interval
102
-
103
- Interval to poll resources in ms, default 250ms
104
-
105
- -l, --log
106
-
107
- Log resources begin waited on and when complete or errored
108
-
109
- -r, --reverse
110
-
111
- Reverse operation, wait for resources to NOT be available
112
-
113
- -s, --simultaneous
114
-
115
- Simultaneous / Concurrent connections to a resource, default Infinity
116
- Setting this to 1 would delay new requests until previous one has completed.
117
- Used to limit the number of connections attempted to a resource at a time.
118
-
119
- -t, --timeout
120
-
121
- Maximum time in ms to wait before exiting with failure (1) code,
122
- default Infinity
123
-
124
- --tcpTimeout
125
-
126
- Maximum time in ms for tcp connect, default 300ms
127
-
128
- -v, --verbose
129
-
130
- Enable debug output to stdout
131
-
132
- -w, --window
133
-
134
- Stability window, the time in ms defining the window of time that
135
- resource needs to have not changed (file size or availability) before
136
- signalling success, default 750ms. If less than interval, it will be
137
- reset to the value of interval. This is only used for files, other
138
- resources are considered available on first detection.
139
-
140
- -h, --help
141
-
142
- Show this message
143
- ```
144
-
145
- ### Node.js API usage
146
-
147
- ```javascript
148
- var waitOn = require('wait-on');
149
- var opts = {
150
- resources: [
151
- 'file1',
152
- 'http://foo.com:8000/bar',
153
- 'https://my.com/cat',
154
- 'http-get://foo.com:8000/bar',
155
- 'https-get://my.com/cat',
156
- 'tcp:foo.com:8000',
157
- 'socket:/my/sock',
158
- 'http://unix:/my/sock:/my/url',
159
- 'http-get://unix:/my/sock:/my/url'
160
- ],
161
- delay: 1000, // initial delay in ms, default 0
162
- interval: 100, // poll interval in ms, default 250ms
163
- simultaneous: 1, // limit to 1 connection per resource at a time
164
- timeout: 30000, // timeout in ms, default Infinity
165
- tcpTimeout: 1000, // tcp timeout in ms, default 300ms
166
- window: 1000, // stabilization time in ms, default 750ms
167
-
168
- // http options
169
- ca: [
170
- /* strings or binaries */
171
- ],
172
- cert: [
173
- /* strings or binaries */
174
- ],
175
- key: [
176
- /* strings or binaries */
177
- ],
178
- passphrase: 'yourpassphrase',
179
- proxy: false /* OR proxy config as defined in axios.
180
- If not set axios detects proxy from env vars http_proxy and https_proxy
181
- https://github.com/axios/axios#config-defaults
182
- {
183
- host: '127.0.0.1',
184
- port: 9000,
185
- auth: {
186
- username: 'mikeymike',
187
- password: 'rapunz3l'
188
- }
189
- } */,
190
- auth: {
191
- user: 'theuser', // or username
192
- pass: 'thepassword' // or password
193
- },
194
- strictSSL: false,
195
- followRedirect: true,
196
- headers: {
197
- 'x-custom': 'headers'
198
- },
199
- validateStatus: function (status) {
200
- return status >= 200 && status < 300; // default if not provided
201
- }
202
- };
203
-
204
- // Usage with callback function
205
- waitOn(opts, function (err) {
206
- if (err) {
207
- return handleError(err);
208
- }
209
- // once here, all resources are available
210
- });
211
-
212
- // Usage with promises
213
- waitOn(opts)
214
- .then(function () {
215
- // once here, all resources are available
216
- })
217
- .catch(function (err) {
218
- handleError(err);
219
- });
220
-
221
- // Usage with async await
222
- try {
223
- await waitOn(opts);
224
- // once here, all resources are available
225
- } catch (err) {
226
- handleError(err);
227
- }
228
- ```
229
-
230
- waitOn(opts, [cb]) - function which triggers resource checks
231
-
232
- - opts.resources - array of string resources to wait for. prefix determines the type of resource with the default type of `file:`
233
- - opts.delay - optional initial delay in ms, default 0
234
- - opts.interval - optional poll resource interval in ms, default 250ms
235
- - opts.log - optional flag which outputs to stdout, remaining resources waited on and when complete or errored
236
- - opts.resources - optional array of string resources to wait for if none are specified via command line
237
- - opts.reverse - optional flag to reverse operation so checks are for resources being NOT available, default false
238
- - opts.simultaneous - optional count to limit concurrent connections per resource at a time, setting to 1 waits for previous connection to succeed, fail, or timeout before sending another, default infinity
239
- - opts.timeout - optional timeout in ms, default Infinity. Aborts with error.
240
- - opts.tcpTimeout - optional tcp timeout in ms, default 300ms
241
- - opts.verbose - optional flag which outputs debug output, default false
242
- - opts.window - optional stabilization time in ms, default 750ms. Waits this amount of time for file sizes to stabilize or other resource availability to remain unchanged.
243
- - http(s) specific options, see https://nodejs.org/api/tls.html#tls_tls_connect_options_callback for specific details
244
-
245
- - opts.ca: [ /* strings or binaries */ ],
246
- - opts.cert: [ /* strings or binaries */ ],
247
- - opts.key: [ /* strings or binaries */ ],
248
- - opts.passphrase: 'yourpassphrase',
249
- - opts.proxy: undefined, false, or object as defined in axios. Default is undefined. If not set axios detects proxy from env vars http_proxy and https_proxy. https://github.com/axios/axios#config-defaults
250
-
251
- ```js
252
- // example proxy object
253
- {
254
- host: '127.0.0.1',
255
- port: 9000,
256
- auth: {
257
- username: 'mikeymike',
258
- password: 'rapunz3l'
259
- }
260
- }
261
- ```
262
-
263
- - opts.auth: { user, pass }
264
- - opts.strictSSL: false,
265
- - opts.followRedirect: false, // defaults to true
266
- - opts.headers: { 'x-custom': 'headers' },
267
-
268
- - cb(err) - if err is provided then, resource checks did not succeed
269
-
270
- ## Goals
271
-
272
- - simple command line utility and Node.js API for waiting for resources
273
- - wait for files to stabilize
274
- - wait for http(s) resources to return 2XX in response to HEAD request
275
- - wait for http(s) resources to return 2XX in response to GET request
276
- - wait for services to be listening on tcp ports
277
- - wait for services to be listening on unix domain sockets
278
- - configurable initial delay, poll interval, stabilization window, timeout
279
- - command line utility returns success code (0) when resources are availble
280
- - command line utility that can also wait for resources to not be available using reverse flag. This is useful for waiting for services to shutdown before continuing.
281
- - cross platform - runs anywhere Node.js runs (linux, unix, mac OS X, windows)
282
-
283
- ## Why
284
-
285
- I frequently need to wait on build tasks to complete or services to be available before starting next command, so this project makes that easier and is portable to everywhere Node.js runs.
286
-
287
- ## Get involved
288
-
289
- If you have input or ideas or would like to get involved, you may:
290
-
291
- - contact me via twitter @jeffbski - <http://twitter.com/jeffbski>
292
- - open an issue on github to begin a discussion - <https://github.com/jeffbski/wait-on/issues>
293
- - fork the repo and send a pull request (ideally with tests) - <https://github.com/jeffbski/wait-on>
294
-
295
- ## License
296
-
297
- - [MIT license](http://github.com/jeffbski/wait-on/raw/master/LICENSE)