@bleedingdev/modern-js-utils 3.2.0-ultramodern.5 → 3.2.0-ultramodern.9

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 (271) hide show
  1. package/dist/types/cli/alias.d.ts +20 -0
  2. package/dist/types/cli/applyOptionsChain.d.ts +3 -0
  3. package/dist/types/cli/commands.d.ts +8 -0
  4. package/dist/types/cli/common.d.ts +9 -0
  5. package/dist/types/cli/config.d.ts +4 -0
  6. package/dist/types/cli/constants.d.ts +55 -0
  7. package/dist/types/cli/ensure.d.ts +8 -0
  8. package/dist/types/cli/fs.d.ts +7 -0
  9. package/dist/types/cli/get/config.d.ts +1 -0
  10. package/dist/types/cli/get/data.d.ts +6 -0
  11. package/dist/types/cli/get/index.d.ts +11 -0
  12. package/dist/types/cli/index.d.ts +23 -0
  13. package/dist/types/cli/is/config.d.ts +22 -0
  14. package/dist/types/cli/is/env.d.ts +8 -0
  15. package/dist/types/cli/is/index.d.ts +4 -0
  16. package/dist/types/cli/is/project.d.ts +39 -0
  17. package/dist/types/cli/is/type.d.ts +15 -0
  18. package/dist/types/cli/logger.d.ts +1 -0
  19. package/dist/types/cli/modulePath.d.ts +5 -0
  20. package/dist/types/cli/monorepo.d.ts +9 -0
  21. package/dist/types/cli/package.d.ts +5 -0
  22. package/dist/types/cli/path.d.ts +11 -0
  23. package/dist/types/cli/port.d.ts +12 -0
  24. package/dist/types/cli/prettyInstructions.d.ts +6 -0
  25. package/dist/types/cli/require.d.ts +9 -0
  26. package/dist/types/cli/route.d.ts +4 -0
  27. package/dist/types/cli/runtimeExports.d.ts +5 -0
  28. package/dist/types/cli/tsconfig.d.ts +1 -0
  29. package/dist/types/cli/version.d.ts +4 -0
  30. package/dist/types/cli/watch.d.ts +8 -0
  31. package/dist/types/compiled.d.ts +37 -0
  32. package/dist/types/import.d.ts +5 -0
  33. package/dist/types/index.d.ts +3 -0
  34. package/dist/types/universal/constants.d.ts +47 -0
  35. package/dist/types/universal/index.d.ts +1 -0
  36. package/dist/types/universal/path.d.ts +1 -0
  37. package/dist/types/universal/pluginDagSort.d.ts +1 -0
  38. package/package.json +2 -2
  39. package/dist/compiled/address/index.js +0 -171
  40. package/dist/compiled/address/lib/address.d.ts +0 -28
  41. package/dist/compiled/address/package.json +0 -1
  42. package/dist/compiled/browserslist/index.d.ts +0 -178
  43. package/dist/compiled/browserslist/index.js +0 -1329
  44. package/dist/compiled/browserslist/license +0 -20
  45. package/dist/compiled/browserslist/package.json +0 -1
  46. package/dist/compiled/chalk/index.d.ts +0 -415
  47. package/dist/compiled/chalk/index.js +0 -2368
  48. package/dist/compiled/chalk/license +0 -9
  49. package/dist/compiled/chalk/package.json +0 -1
  50. package/dist/compiled/chokidar/anymatch/index.d.ts +0 -19
  51. package/dist/compiled/chokidar/fsevents.node +0 -0
  52. package/dist/compiled/chokidar/index.js +0 -4162
  53. package/dist/compiled/chokidar/index.js.LICENSE.txt +0 -41
  54. package/dist/compiled/chokidar/license +0 -21
  55. package/dist/compiled/chokidar/package.json +0 -1
  56. package/dist/compiled/chokidar/types/index.d.ts +0 -188
  57. package/dist/compiled/commander/index.js +0 -1540
  58. package/dist/compiled/commander/index.mjs +0 -2
  59. package/dist/compiled/commander/license +0 -22
  60. package/dist/compiled/commander/package.json +0 -1
  61. package/dist/compiled/commander/typings/index.d.ts +0 -890
  62. package/dist/compiled/debug/index.d.ts +0 -54
  63. package/dist/compiled/debug/index.js +0 -621
  64. package/dist/compiled/debug/license +0 -20
  65. package/dist/compiled/debug/ms/index.d.ts +0 -25
  66. package/dist/compiled/debug/package.json +0 -1
  67. package/dist/compiled/dotenv/index.js +0 -101
  68. package/dist/compiled/dotenv/license +0 -23
  69. package/dist/compiled/dotenv/package.json +0 -1
  70. package/dist/compiled/dotenv/types/index.d.ts +0 -59
  71. package/dist/compiled/dotenv-expand/index.d.ts +0 -15
  72. package/dist/compiled/dotenv-expand/index.js +0 -54
  73. package/dist/compiled/dotenv-expand/license +0 -24
  74. package/dist/compiled/dotenv-expand/package.json +0 -1
  75. package/dist/compiled/execa/index.d.ts +0 -564
  76. package/dist/compiled/execa/index.js +0 -1738
  77. package/dist/compiled/execa/license +0 -9
  78. package/dist/compiled/execa/package.json +0 -1
  79. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/adapters/fs.d.ts +0 -20
  80. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/index.d.ts +0 -12
  81. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/providers/async.d.ts +0 -7
  82. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/settings.d.ts +0 -20
  83. package/dist/compiled/fast-glob/@nodelib/fs.scandir/out/types/index.d.ts +0 -20
  84. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/adapters/fs.d.ts +0 -13
  85. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/index.d.ts +0 -12
  86. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/providers/async.d.ts +0 -4
  87. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/settings.d.ts +0 -16
  88. package/dist/compiled/fast-glob/@nodelib/fs.stat/out/types/index.d.ts +0 -4
  89. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/index.d.ts +0 -14
  90. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/providers/async.d.ts +0 -12
  91. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/readers/async.d.ts +0 -30
  92. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/readers/reader.d.ts +0 -6
  93. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/settings.d.ts +0 -30
  94. package/dist/compiled/fast-glob/@nodelib/fs.walk/out/types/index.d.ts +0 -8
  95. package/dist/compiled/fast-glob/index.js +0 -4665
  96. package/dist/compiled/fast-glob/index.js.LICENSE.txt +0 -38
  97. package/dist/compiled/fast-glob/license +0 -21
  98. package/dist/compiled/fast-glob/out/index.d.ts +0 -27
  99. package/dist/compiled/fast-glob/out/managers/tasks.d.ts +0 -22
  100. package/dist/compiled/fast-glob/out/settings.d.ts +0 -164
  101. package/dist/compiled/fast-glob/out/types/index.d.ts +0 -31
  102. package/dist/compiled/fast-glob/package.json +0 -1
  103. package/dist/compiled/filesize/filesize.d.ts +0 -131
  104. package/dist/compiled/filesize/index.js +0 -198
  105. package/dist/compiled/filesize/index.js.LICENSE.txt +0 -7
  106. package/dist/compiled/filesize/license +0 -28
  107. package/dist/compiled/filesize/package.json +0 -1
  108. package/dist/compiled/fs-extra/index.d.ts +0 -563
  109. package/dist/compiled/fs-extra/index.js +0 -2222
  110. package/dist/compiled/fs-extra/license +0 -15
  111. package/dist/compiled/fs-extra/package.json +0 -1
  112. package/dist/compiled/glob/index.d.ts +0 -91
  113. package/dist/compiled/glob/index.js +0 -2011
  114. package/dist/compiled/glob/license +0 -21
  115. package/dist/compiled/glob/minimatch/index.d.ts +0 -204
  116. package/dist/compiled/glob/package.json +0 -1
  117. package/dist/compiled/globby/index.d.ts +0 -186
  118. package/dist/compiled/globby/index.js +0 -690
  119. package/dist/compiled/globby/license +0 -9
  120. package/dist/compiled/globby/package.json +0 -1
  121. package/dist/compiled/gzip-size/index.d.ts +0 -96
  122. package/dist/compiled/gzip-size/index.js +0 -157
  123. package/dist/compiled/gzip-size/license +0 -9
  124. package/dist/compiled/gzip-size/package.json +0 -1
  125. package/dist/compiled/import-lazy/index.d.ts +0 -26
  126. package/dist/compiled/import-lazy/index.js +0 -45
  127. package/dist/compiled/import-lazy/license +0 -9
  128. package/dist/compiled/import-lazy/package.json +0 -1
  129. package/dist/compiled/inquirer/index.d.ts +0 -997
  130. package/dist/compiled/inquirer/index.js +0 -20167
  131. package/dist/compiled/inquirer/index.js.LICENSE.txt +0 -7
  132. package/dist/compiled/inquirer/lib/objects/choice.d.ts +0 -65
  133. package/dist/compiled/inquirer/lib/objects/choices.d.ts +0 -206
  134. package/dist/compiled/inquirer/lib/objects/separator.d.ts +0 -37
  135. package/dist/compiled/inquirer/lib/ui/baseUI.d.ts +0 -37
  136. package/dist/compiled/inquirer/lib/ui/bottom-bar.d.ts +0 -65
  137. package/dist/compiled/inquirer/lib/ui/prompt.d.ts +0 -104
  138. package/dist/compiled/inquirer/license +0 -22
  139. package/dist/compiled/inquirer/package.json +0 -1
  140. package/dist/compiled/inquirer/through/index.d.ts +0 -25
  141. package/dist/compiled/js-yaml/index.d.ts +0 -154
  142. package/dist/compiled/js-yaml/index.js +0 -2191
  143. package/dist/compiled/js-yaml/index.mjs +0 -2167
  144. package/dist/compiled/js-yaml/index.mjs.LICENSE.txt +0 -1
  145. package/dist/compiled/js-yaml/license +0 -21
  146. package/dist/compiled/js-yaml/package.json +0 -1
  147. package/dist/compiled/json5/index.js +0 -983
  148. package/dist/compiled/json5/lib/index.d.ts +0 -4
  149. package/dist/compiled/json5/lib/parse.d.ts +0 -15
  150. package/dist/compiled/json5/lib/stringify.d.ts +0 -89
  151. package/dist/compiled/json5/package.json +0 -1
  152. package/dist/compiled/lodash/common/array.d.ts +0 -2126
  153. package/dist/compiled/lodash/common/collection.d.ts +0 -1930
  154. package/dist/compiled/lodash/common/common.d.ts +0 -280
  155. package/dist/compiled/lodash/common/date.d.ts +0 -23
  156. package/dist/compiled/lodash/common/function.d.ts +0 -1446
  157. package/dist/compiled/lodash/common/lang.d.ts +0 -1693
  158. package/dist/compiled/lodash/common/math.d.ts +0 -405
  159. package/dist/compiled/lodash/common/number.d.ts +0 -131
  160. package/dist/compiled/lodash/common/object.d.ts +0 -2519
  161. package/dist/compiled/lodash/common/seq.d.ts +0 -210
  162. package/dist/compiled/lodash/common/string.d.ts +0 -788
  163. package/dist/compiled/lodash/common/util.d.ts +0 -1220
  164. package/dist/compiled/lodash/index.d.ts +0 -46
  165. package/dist/compiled/lodash/index.js +0 -1
  166. package/dist/compiled/lodash/index.mjs +0 -1
  167. package/dist/compiled/lodash/license +0 -47
  168. package/dist/compiled/lodash/package.json +0 -1
  169. package/dist/compiled/mime-types/index.d.ts +0 -14
  170. package/dist/compiled/mime-types/index.js +0 -116
  171. package/dist/compiled/mime-types/index.js.LICENSE.txt +0 -13
  172. package/dist/compiled/mime-types/license +0 -23
  173. package/dist/compiled/mime-types/package.json +0 -1
  174. package/dist/compiled/minimist/index.d.ts +0 -95
  175. package/dist/compiled/minimist/index.js +0 -202
  176. package/dist/compiled/minimist/license +0 -18
  177. package/dist/compiled/minimist/package.json +0 -1
  178. package/dist/compiled/nanoid/index.d.ts +0 -91
  179. package/dist/compiled/nanoid/index.js +0 -83
  180. package/dist/compiled/nanoid/index.mjs +0 -69
  181. package/dist/compiled/nanoid/license +0 -20
  182. package/dist/compiled/nanoid/package.json +0 -1
  183. package/dist/compiled/ora/cli-spinners/index.d.ts +0 -125
  184. package/dist/compiled/ora/index.d.ts +0 -277
  185. package/dist/compiled/ora/index.js +0 -3936
  186. package/dist/compiled/ora/index.js.LICENSE.txt +0 -1
  187. package/dist/compiled/ora/license +0 -9
  188. package/dist/compiled/ora/package.json +0 -1
  189. package/dist/compiled/pkg-up/index.d.ts +0 -48
  190. package/dist/compiled/pkg-up/index.js +0 -15
  191. package/dist/compiled/pkg-up/license +0 -9
  192. package/dist/compiled/pkg-up/package.json +0 -1
  193. package/dist/compiled/semver/classes/comparator.d.ts +0 -17
  194. package/dist/compiled/semver/classes/range.d.ts +0 -21
  195. package/dist/compiled/semver/classes/semver.d.ts +0 -62
  196. package/dist/compiled/semver/functions/clean.d.ts +0 -8
  197. package/dist/compiled/semver/functions/cmp.d.ts +0 -16
  198. package/dist/compiled/semver/functions/coerce.d.ts +0 -12
  199. package/dist/compiled/semver/functions/compare-build.d.ts +0 -16
  200. package/dist/compiled/semver/functions/compare-loose.d.ts +0 -5
  201. package/dist/compiled/semver/functions/compare.d.ts +0 -20
  202. package/dist/compiled/semver/functions/diff.d.ts +0 -13
  203. package/dist/compiled/semver/functions/eq.d.ts +0 -9
  204. package/dist/compiled/semver/functions/gt.d.ts +0 -9
  205. package/dist/compiled/semver/functions/gte.d.ts +0 -9
  206. package/dist/compiled/semver/functions/inc.d.ts +0 -15
  207. package/dist/compiled/semver/functions/lt.d.ts +0 -9
  208. package/dist/compiled/semver/functions/lte.d.ts +0 -8
  209. package/dist/compiled/semver/functions/major.d.ts +0 -9
  210. package/dist/compiled/semver/functions/minor.d.ts +0 -9
  211. package/dist/compiled/semver/functions/neq.d.ts +0 -9
  212. package/dist/compiled/semver/functions/parse.d.ts +0 -12
  213. package/dist/compiled/semver/functions/patch.d.ts +0 -9
  214. package/dist/compiled/semver/functions/prerelease.d.ts +0 -12
  215. package/dist/compiled/semver/functions/rcompare.d.ts +0 -15
  216. package/dist/compiled/semver/functions/rsort.d.ts +0 -9
  217. package/dist/compiled/semver/functions/satisfies.d.ts +0 -14
  218. package/dist/compiled/semver/functions/sort.d.ts +0 -9
  219. package/dist/compiled/semver/functions/valid.d.ts +0 -11
  220. package/dist/compiled/semver/index.d.ts +0 -133
  221. package/dist/compiled/semver/index.js +0 -1779
  222. package/dist/compiled/semver/internals/identifiers.d.ts +0 -13
  223. package/dist/compiled/semver/license +0 -15
  224. package/dist/compiled/semver/package.json +0 -1
  225. package/dist/compiled/semver/ranges/gtr.d.ts +0 -14
  226. package/dist/compiled/semver/ranges/intersects.d.ts +0 -13
  227. package/dist/compiled/semver/ranges/ltr.d.ts +0 -14
  228. package/dist/compiled/semver/ranges/max-satisfying.d.ts +0 -14
  229. package/dist/compiled/semver/ranges/min-satisfying.d.ts +0 -14
  230. package/dist/compiled/semver/ranges/min-version.d.ts +0 -10
  231. package/dist/compiled/semver/ranges/outside.d.ts +0 -15
  232. package/dist/compiled/semver/ranges/simplify.d.ts +0 -14
  233. package/dist/compiled/semver/ranges/subset.d.ts +0 -13
  234. package/dist/compiled/semver/ranges/to-comparators.d.ts +0 -9
  235. package/dist/compiled/semver/ranges/valid.d.ts +0 -12
  236. package/dist/compiled/signale/index.d.ts +0 -162
  237. package/dist/compiled/signale/index.js +0 -1704
  238. package/dist/compiled/signale/package.json +0 -1
  239. package/dist/compiled/slash/index.d.ts +0 -25
  240. package/dist/compiled/slash/index.js +0 -32
  241. package/dist/compiled/slash/license +0 -9
  242. package/dist/compiled/slash/package.json +0 -1
  243. package/dist/compiled/strip-ansi/index.d.ts +0 -17
  244. package/dist/compiled/strip-ansi/index.js +0 -34
  245. package/dist/compiled/strip-ansi/license +0 -9
  246. package/dist/compiled/strip-ansi/package.json +0 -1
  247. package/dist/compiled/tsconfig-paths/index.js +0 -629
  248. package/dist/compiled/tsconfig-paths/index.mjs +0 -2
  249. package/dist/compiled/tsconfig-paths/lib/config-loader.d.ts +0 -33
  250. package/dist/compiled/tsconfig-paths/lib/filesystem.d.ts +0 -34
  251. package/dist/compiled/tsconfig-paths/lib/index.d.ts +0 -5
  252. package/dist/compiled/tsconfig-paths/lib/mapping-entry.d.ts +0 -18
  253. package/dist/compiled/tsconfig-paths/lib/match-path-async.d.ts +0 -21
  254. package/dist/compiled/tsconfig-paths/lib/match-path-sync.d.ts +0 -32
  255. package/dist/compiled/tsconfig-paths/lib/register.d.ts +0 -12
  256. package/dist/compiled/tsconfig-paths/lib/try-path.d.ts +0 -15
  257. package/dist/compiled/tsconfig-paths/lib/tsconfig-loader.d.ts +0 -28
  258. package/dist/compiled/tsconfig-paths/license +0 -21
  259. package/dist/compiled/tsconfig-paths/package.json +0 -1
  260. package/dist/compiled/upath/index.js +0 -135
  261. package/dist/compiled/upath/license +0 -22
  262. package/dist/compiled/upath/package.json +0 -1
  263. package/dist/compiled/upath/upath.d.ts +0 -241
  264. package/dist/compiled/url-join/index.d.ts +0 -17
  265. package/dist/compiled/url-join/index.js +0 -61
  266. package/dist/compiled/url-join/license +0 -21
  267. package/dist/compiled/url-join/package.json +0 -1
  268. package/dist/compiled/webpack-chain/index.js +0 -1475
  269. package/dist/compiled/webpack-chain/license +0 -373
  270. package/dist/compiled/webpack-chain/package.json +0 -1
  271. package/dist/compiled/webpack-chain/types/index.d.ts +0 -599
@@ -1,125 +0,0 @@
1
- declare namespace cliSpinners {
2
- type SpinnerName =
3
- | 'dots'
4
- | 'dots2'
5
- | 'dots3'
6
- | 'dots4'
7
- | 'dots5'
8
- | 'dots6'
9
- | 'dots7'
10
- | 'dots8'
11
- | 'dots9'
12
- | 'dots10'
13
- | 'dots11'
14
- | 'dots12'
15
- | 'dots8Bit'
16
- | 'line'
17
- | 'line2'
18
- | 'pipe'
19
- | 'simpleDots'
20
- | 'simpleDotsScrolling'
21
- | 'star'
22
- | 'star2'
23
- | 'flip'
24
- | 'hamburger'
25
- | 'growVertical'
26
- | 'growHorizontal'
27
- | 'balloon'
28
- | 'balloon2'
29
- | 'noise'
30
- | 'bounce'
31
- | 'boxBounce'
32
- | 'boxBounce2'
33
- | 'triangle'
34
- | 'arc'
35
- | 'circle'
36
- | 'squareCorners'
37
- | 'circleQuarters'
38
- | 'circleHalves'
39
- | 'squish'
40
- | 'toggle'
41
- | 'toggle2'
42
- | 'toggle3'
43
- | 'toggle4'
44
- | 'toggle5'
45
- | 'toggle6'
46
- | 'toggle7'
47
- | 'toggle8'
48
- | 'toggle9'
49
- | 'toggle10'
50
- | 'toggle11'
51
- | 'toggle12'
52
- | 'toggle13'
53
- | 'arrow'
54
- | 'arrow2'
55
- | 'arrow3'
56
- | 'bouncingBar'
57
- | 'bouncingBall'
58
- | 'smiley'
59
- | 'monkey'
60
- | 'hearts'
61
- | 'clock'
62
- | 'earth'
63
- | 'material'
64
- | 'moon'
65
- | 'runner'
66
- | 'pong'
67
- | 'shark'
68
- | 'dqpb'
69
- | 'weather'
70
- | 'christmas'
71
- | 'grenade'
72
- | 'point'
73
- | 'layer'
74
- | 'betaWave'
75
- | 'fingerDance'
76
- | 'fistBump'
77
- | 'soccerHeader'
78
- | 'mindblown'
79
- | 'speaker'
80
- | 'orangePulse'
81
- | 'bluePulse'
82
- | 'orangeBluePulse'
83
- | 'timeTravel'
84
- | 'aesthetic';
85
-
86
- interface Spinner {
87
- /**
88
- Recommended interval.
89
- */
90
- readonly interval: number;
91
-
92
- /**
93
- A list of frames to show for the spinner.
94
- */
95
- readonly frames: string[];
96
- }
97
- }
98
-
99
- /**
100
- 70+ spinners for use in the terminal.
101
-
102
- @example
103
- ```
104
- import cliSpinners = require('../cli-spinners');
105
-
106
- console.log(cliSpinners.dots);
107
- // {
108
- // interval: 80,
109
- // frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
110
- // }
111
- ```
112
- */
113
- declare const cliSpinners: {
114
- readonly [spinnerName in cliSpinners.SpinnerName]: cliSpinners.Spinner;
115
- } & {
116
- /**
117
- Returns a random spinner each time it's called.
118
- */
119
- readonly random: cliSpinners.Spinner;
120
-
121
- // TODO: Remove this for the next major release
122
- default: typeof cliSpinners;
123
- };
124
-
125
- export = cliSpinners;
@@ -1,277 +0,0 @@
1
- import {SpinnerName} from './cli-spinners';
2
-
3
- declare namespace ora {
4
- interface Spinner {
5
- readonly interval?: number;
6
- readonly frames: string[];
7
- }
8
-
9
- type Color =
10
- | 'black'
11
- | 'red'
12
- | 'green'
13
- | 'yellow'
14
- | 'blue'
15
- | 'magenta'
16
- | 'cyan'
17
- | 'white'
18
- | 'gray';
19
-
20
- type PrefixTextGenerator = () => string;
21
-
22
- interface Options {
23
- /**
24
- Text to display after the spinner.
25
- */
26
- readonly text?: string;
27
-
28
- /**
29
- Text or a function that returns text to display before the spinner. No prefix text will be displayed if set to an empty string.
30
- */
31
- readonly prefixText?: string | PrefixTextGenerator;
32
-
33
- /**
34
- Name of one of the provided spinners. See [`example.js`](https://github.com/BendingBender/ora/blob/main/example.js) in this repo if you want to test out different spinners. On Windows, it will always use the line spinner as the Windows command-line doesn't have proper Unicode support.
35
-
36
- @default 'dots'
37
-
38
- Or an object like:
39
-
40
- @example
41
- ```
42
- {
43
- interval: 80, // Optional
44
- frames: ['-', '+', '-']
45
- }
46
- ```
47
- */
48
- readonly spinner?: SpinnerName | Spinner;
49
-
50
- /**
51
- Color of the spinner.
52
-
53
- @default 'cyan'
54
- */
55
- readonly color?: Color;
56
-
57
- /**
58
- Set to `false` to stop Ora from hiding the cursor.
59
-
60
- @default true
61
- */
62
- readonly hideCursor?: boolean;
63
-
64
- /**
65
- Indent the spinner with the given number of spaces.
66
-
67
- @default 0
68
- */
69
- readonly indent?: number;
70
-
71
- /**
72
- Interval between each frame.
73
-
74
- Spinners provide their own recommended interval, so you don't really need to specify this.
75
-
76
- Default: Provided by the spinner or `100`.
77
- */
78
- readonly interval?: number;
79
-
80
- /**
81
- Stream to write the output.
82
-
83
- You could for example set this to `process.stdout` instead.
84
-
85
- @default process.stderr
86
- */
87
- readonly stream?: NodeJS.WritableStream;
88
-
89
- /**
90
- Force enable/disable the spinner. If not specified, the spinner will be enabled if the `stream` is being run inside a TTY context (not spawned or piped) and/or not in a CI environment.
91
-
92
- Note that `{isEnabled: false}` doesn't mean it won't output anything. It just means it won't output the spinner, colors, and other ansi escape codes. It will still log text.
93
- */
94
- readonly isEnabled?: boolean;
95
-
96
- /**
97
- Disable the spinner and all log text. All output is suppressed and `isEnabled` will be considered `false`.
98
-
99
- @default false
100
- */
101
- readonly isSilent?: boolean;
102
-
103
- /**
104
- Discard stdin input (except Ctrl+C) while running if it's TTY. This prevents the spinner from twitching on input, outputting broken lines on `Enter` key presses, and prevents buffering of input while the spinner is running.
105
-
106
- This has no effect on Windows as there's no good way to implement discarding stdin properly there.
107
-
108
- @default true
109
- */
110
- readonly discardStdin?: boolean;
111
- }
112
-
113
- interface PersistOptions {
114
- /**
115
- Symbol to replace the spinner with.
116
-
117
- @default ' '
118
- */
119
- readonly symbol?: string;
120
-
121
- /**
122
- Text to be persisted after the symbol.
123
-
124
- Default: Current `text`.
125
- */
126
- readonly text?: string;
127
-
128
- /**
129
- Text or a function that returns text to be persisted before the symbol. No prefix text will be displayed if set to an empty string.
130
-
131
- Default: Current `prefixText`.
132
- */
133
- readonly prefixText?: string | PrefixTextGenerator;
134
- }
135
-
136
- interface Ora {
137
- /**
138
- A boolean of whether the instance is currently spinning.
139
- */
140
- readonly isSpinning: boolean;
141
-
142
- /**
143
- Change the text after the spinner.
144
- */
145
- text: string;
146
-
147
- /**
148
- Change the text or function that returns text before the spinner. No prefix text will be displayed if set to an empty string.
149
- */
150
- prefixText: string | PrefixTextGenerator;
151
-
152
- /**
153
- Change the spinner color.
154
- */
155
- color: Color;
156
-
157
- /**
158
- Change the spinner.
159
- */
160
- spinner: SpinnerName | Spinner;
161
-
162
- /**
163
- Change the spinner indent.
164
- */
165
- indent: number;
166
-
167
- /**
168
- Start the spinner.
169
-
170
- @param text - Set the current text.
171
- @returns The spinner instance.
172
- */
173
- start(text?: string): Ora;
174
-
175
- /**
176
- Stop and clear the spinner.
177
-
178
- @returns The spinner instance.
179
- */
180
- stop(): Ora;
181
-
182
- /**
183
- Stop the spinner, change it to a green `✔` and persist the current text, or `text` if provided.
184
-
185
- @param text - Will persist text if provided.
186
- @returns The spinner instance.
187
- */
188
- succeed(text?: string): Ora;
189
-
190
- /**
191
- Stop the spinner, change it to a red `✖` and persist the current text, or `text` if provided.
192
-
193
- @param text - Will persist text if provided.
194
- @returns The spinner instance.
195
- */
196
- fail(text?: string): Ora;
197
-
198
- /**
199
- Stop the spinner, change it to a yellow `⚠` and persist the current text, or `text` if provided.
200
-
201
- @param text - Will persist text if provided.
202
- @returns The spinner instance.
203
- */
204
- warn(text?: string): Ora;
205
-
206
- /**
207
- Stop the spinner, change it to a blue `ℹ` and persist the current text, or `text` if provided.
208
-
209
- @param text - Will persist text if provided.
210
- @returns The spinner instance.
211
- */
212
- info(text?: string): Ora;
213
-
214
- /**
215
- Stop the spinner and change the symbol or text.
216
-
217
- @returns The spinner instance.
218
- */
219
- stopAndPersist(options?: PersistOptions): Ora;
220
-
221
- /**
222
- Clear the spinner.
223
-
224
- @returns The spinner instance.
225
- */
226
- clear(): Ora;
227
-
228
- /**
229
- Manually render a new frame.
230
-
231
- @returns The spinner instance.
232
- */
233
- render(): Ora;
234
-
235
- /**
236
- Get a new frame.
237
-
238
- @returns The spinner instance text.
239
- */
240
- frame(): string;
241
- }
242
- }
243
-
244
- declare const ora: {
245
- /**
246
- Elegant terminal spinner.
247
-
248
- @param options - If a string is provided, it is treated as a shortcut for `options.text`.
249
-
250
- @example
251
- ```
252
- import ora = require('./ora');
253
-
254
- const spinner = ora('Loading unicorns').start();
255
-
256
- setTimeout(() => {
257
- spinner.color = 'yellow';
258
- spinner.text = 'Loading rainbows';
259
- }, 1000);
260
- ```
261
- */
262
- (options?: ora.Options | string): ora.Ora;
263
-
264
- /**
265
- Starts a spinner for a promise. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects.
266
-
267
- @param action - The promise to start the spinner for.
268
- @param options - If a string is provided, it is treated as a shortcut for `options.text`.
269
- @returns The spinner instance.
270
- */
271
- promise(
272
- action: PromiseLike<unknown>,
273
- options?: ora.Options | string
274
- ): ora.Ora;
275
- };
276
-
277
- export = ora;