angular-slickgrid 4.2.1 → 4.2.2

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 (205) hide show
  1. package/LICENSE +20 -20
  2. package/app/modules/angular-slickgrid/components/angular-slickgrid.component.d.ts +2 -2
  3. package/app/modules/angular-slickgrid/extensions/slickRowDetailView.d.ts +0 -2
  4. package/docs/assets/lib/multiple-select/README.md +17 -17
  5. package/esm2020/app/modules/angular-slickgrid/components/angular-slickgrid.component.mjs +14 -14
  6. package/esm2020/app/modules/angular-slickgrid/constants.mjs +1 -1
  7. package/esm2020/app/modules/angular-slickgrid/extensions/index.mjs +1 -1
  8. package/esm2020/app/modules/angular-slickgrid/extensions/slickRowDetailView.mjs +2 -4
  9. package/esm2020/app/modules/angular-slickgrid/global-grid-options.mjs +1 -1
  10. package/esm2020/app/modules/angular-slickgrid/index.mjs +1 -1
  11. package/esm2020/app/modules/angular-slickgrid/models/angularComponentOutput.interface.mjs +1 -1
  12. package/esm2020/app/modules/angular-slickgrid/models/angularGridInstance.interface.mjs +1 -1
  13. package/esm2020/app/modules/angular-slickgrid/models/externalTestingDependencies.interface.mjs +1 -1
  14. package/esm2020/app/modules/angular-slickgrid/models/gridOption.interface.mjs +1 -1
  15. package/esm2020/app/modules/angular-slickgrid/models/index.mjs +1 -1
  16. package/esm2020/app/modules/angular-slickgrid/models/rowDetailView.interface.mjs +1 -1
  17. package/esm2020/app/modules/angular-slickgrid/models/slickGrid.interface.mjs +1 -1
  18. package/esm2020/app/modules/angular-slickgrid/modules/angular-slickgrid.module.mjs +7 -10
  19. package/esm2020/app/modules/angular-slickgrid/services/angularUtil.service.mjs +4 -4
  20. package/esm2020/app/modules/angular-slickgrid/services/bsDropdown.service.mjs +4 -4
  21. package/esm2020/app/modules/angular-slickgrid/services/container.service.mjs +4 -4
  22. package/esm2020/app/modules/angular-slickgrid/services/index.mjs +1 -1
  23. package/esm2020/app/modules/angular-slickgrid/services/translater.service.mjs +4 -4
  24. package/esm2020/app/modules/angular-slickgrid/services/utilities.mjs +1 -1
  25. package/esm2020/app/modules/angular-slickgrid/slickgrid-config.mjs +1 -1
  26. package/esm2020/public_api.mjs +1 -1
  27. package/fesm2015/angular-slickgrid.mjs +32 -37
  28. package/fesm2015/angular-slickgrid.mjs.map +1 -1
  29. package/fesm2020/angular-slickgrid.mjs +32 -37
  30. package/fesm2020/angular-slickgrid.mjs.map +1 -1
  31. package/i18n/en.json +89 -89
  32. package/i18n/fr.json +90 -90
  33. package/{angular-slickgrid.d.ts → index.d.ts} +0 -0
  34. package/package.json +11 -11
  35. package/test/cypress/node_modules/@cypress/request/README.md +1038 -0
  36. package/test/cypress/node_modules/@cypress/xvfb/README.md +48 -0
  37. package/test/cypress/node_modules/@cypress/xvfb/node_modules/debug/README.md +437 -0
  38. package/test/cypress/node_modules/@types/node/README.md +16 -0
  39. package/test/cypress/node_modules/@types/sinonjs__fake-timers/README.md +16 -0
  40. package/test/cypress/node_modules/@types/sizzle/README.md +16 -0
  41. package/test/cypress/node_modules/@types/yauzl/README.md +16 -0
  42. package/test/cypress/node_modules/@types/yauzl/node_modules/@types/node/README.md +16 -0
  43. package/test/cypress/node_modules/aggregate-error/README.md +61 -0
  44. package/test/cypress/node_modules/ansi-colors/README.md +315 -0
  45. package/test/cypress/node_modules/ansi-escapes/README.md +245 -0
  46. package/test/cypress/node_modules/ansi-regex/README.md +78 -0
  47. package/test/cypress/node_modules/ansi-styles/README.md +152 -0
  48. package/test/cypress/node_modules/arch/README.md +71 -0
  49. package/test/cypress/node_modules/asn1/README.md +50 -0
  50. package/test/cypress/node_modules/assert-plus/README.md +162 -0
  51. package/test/cypress/node_modules/astral-regex/README.md +46 -0
  52. package/test/cypress/node_modules/async/README.md +60 -0
  53. package/test/cypress/node_modules/asynckit/README.md +233 -0
  54. package/test/cypress/node_modules/at-least-node/README.md +25 -0
  55. package/test/cypress/node_modules/aws-sign2/README.md +4 -0
  56. package/test/cypress/node_modules/aws4/README.md +183 -0
  57. package/test/cypress/node_modules/balanced-match/README.md +91 -0
  58. package/test/cypress/node_modules/base64-js/README.md +34 -0
  59. package/test/cypress/node_modules/bcrypt-pbkdf/README.md +45 -0
  60. package/test/cypress/node_modules/blob-util/README.md +623 -0
  61. package/test/cypress/node_modules/bluebird/README.md +57 -0
  62. package/test/cypress/node_modules/brace-expansion/README.md +129 -0
  63. package/test/cypress/node_modules/buffer/README.md +410 -0
  64. package/test/cypress/node_modules/buffer-crc32/README.md +47 -0
  65. package/test/cypress/node_modules/cachedir/README.md +27 -0
  66. package/test/cypress/node_modules/caseless/README.md +45 -0
  67. package/test/cypress/node_modules/chalk/README.md +293 -0
  68. package/test/cypress/node_modules/chalk/node_modules/supports-color/README.md +76 -0
  69. package/test/cypress/node_modules/check-more-types/README.md +952 -0
  70. package/test/cypress/node_modules/ci-info/README.md +114 -0
  71. package/test/cypress/node_modules/clean-stack/README.md +76 -0
  72. package/test/cypress/node_modules/cli-cursor/README.md +55 -0
  73. package/test/cypress/node_modules/cli-table3/README.md +218 -0
  74. package/test/cypress/node_modules/cli-truncate/README.md +139 -0
  75. package/test/cypress/node_modules/color-convert/README.md +68 -0
  76. package/test/cypress/node_modules/color-name/README.md +11 -0
  77. package/test/cypress/node_modules/colorette/README.md +102 -0
  78. package/test/cypress/node_modules/colors/README.md +221 -0
  79. package/test/cypress/node_modules/combined-stream/README.md +138 -0
  80. package/test/cypress/node_modules/commander/README.md +737 -0
  81. package/test/cypress/node_modules/common-tags/README.md +687 -0
  82. package/test/cypress/node_modules/core-util-is/README.md +3 -0
  83. package/test/cypress/node_modules/cross-spawn/README.md +96 -0
  84. package/test/cypress/node_modules/cypress/README.md +25 -0
  85. package/test/cypress/node_modules/cypress/mount-utils/README.md +14 -0
  86. package/test/cypress/node_modules/cypress/react/README.md +414 -0
  87. package/test/cypress/node_modules/cypress/vue/README.md +678 -0
  88. package/test/cypress/node_modules/cypress/vue2/README.md +693 -0
  89. package/test/cypress/node_modules/dashdash/README.md +574 -0
  90. package/test/cypress/node_modules/dayjs/README.md +128 -0
  91. package/test/cypress/node_modules/debug/README.md +455 -0
  92. package/test/cypress/node_modules/delayed-stream/README.md +141 -0
  93. package/test/cypress/node_modules/ecc-jsbn/README.md +8 -0
  94. package/test/cypress/node_modules/emoji-regex/README.md +73 -0
  95. package/test/cypress/node_modules/end-of-stream/README.md +54 -0
  96. package/test/cypress/node_modules/enquirer/README.md +1752 -0
  97. package/test/cypress/node_modules/escape-string-regexp/README.md +27 -0
  98. package/test/cypress/node_modules/eventemitter2/README.md +809 -0
  99. package/test/cypress/node_modules/execa/README.md +656 -0
  100. package/test/cypress/node_modules/executable/README.md +64 -0
  101. package/test/cypress/node_modules/extend/README.md +81 -0
  102. package/test/cypress/node_modules/extract-zip/README.md +57 -0
  103. package/test/cypress/node_modules/extract-zip/node_modules/debug/README.md +455 -0
  104. package/test/cypress/node_modules/extsprintf/README.md +46 -0
  105. package/test/cypress/node_modules/fd-slicer/README.md +199 -0
  106. package/test/cypress/node_modules/figures/README.md +139 -0
  107. package/test/cypress/node_modules/forever-agent/README.md +4 -0
  108. package/test/cypress/node_modules/form-data/README.md +234 -0
  109. package/test/cypress/node_modules/fs-extra/README.md +264 -0
  110. package/test/cypress/node_modules/fs.realpath/README.md +33 -0
  111. package/test/cypress/node_modules/get-stream/README.md +124 -0
  112. package/test/cypress/node_modules/getos/README.md +79 -0
  113. package/test/cypress/node_modules/getpass/README.md +32 -0
  114. package/test/cypress/node_modules/glob/README.md +375 -0
  115. package/test/cypress/node_modules/global-dirs/README.md +72 -0
  116. package/test/cypress/node_modules/graceful-fs/README.md +133 -0
  117. package/test/cypress/node_modules/has-flag/README.md +89 -0
  118. package/test/cypress/node_modules/http-signature/README.md +80 -0
  119. package/test/cypress/node_modules/human-signals/README.md +155 -0
  120. package/test/cypress/node_modules/ieee754/README.md +51 -0
  121. package/test/cypress/node_modules/indent-string/README.md +70 -0
  122. package/test/cypress/node_modules/inflight/README.md +37 -0
  123. package/test/cypress/node_modules/inherits/README.md +42 -0
  124. package/test/cypress/node_modules/ini/README.md +102 -0
  125. package/test/cypress/node_modules/is-ci/README.md +50 -0
  126. package/test/cypress/node_modules/is-fullwidth-code-point/README.md +39 -0
  127. package/test/cypress/node_modules/is-installed-globally/README.md +31 -0
  128. package/test/cypress/node_modules/is-path-inside/README.md +63 -0
  129. package/test/cypress/node_modules/is-stream/README.md +57 -0
  130. package/test/cypress/node_modules/is-typedarray/README.md +16 -0
  131. package/test/cypress/node_modules/isexe/README.md +51 -0
  132. package/test/cypress/node_modules/isstream/README.md +66 -0
  133. package/test/cypress/node_modules/jsbn/README.md +175 -0
  134. package/test/cypress/node_modules/json-schema/README.md +3 -0
  135. package/test/cypress/node_modules/json-stringify-safe/README.md +52 -0
  136. package/test/cypress/node_modules/jsonfile/README.md +205 -0
  137. package/test/cypress/node_modules/jsonfile/node_modules/universalify/README.md +76 -0
  138. package/test/cypress/node_modules/jsprim/README.md +287 -0
  139. package/test/cypress/node_modules/lazy-ass/README.md +269 -0
  140. package/test/cypress/node_modules/listr2/README.md +17 -0
  141. package/test/cypress/node_modules/lodash/README.md +39 -0
  142. package/test/cypress/node_modules/lodash.once/README.md +18 -0
  143. package/test/cypress/node_modules/log-symbols/README.md +51 -0
  144. package/test/cypress/node_modules/log-update/README.md +97 -0
  145. package/test/cypress/node_modules/log-update/node_modules/slice-ansi/README.md +66 -0
  146. package/test/cypress/node_modules/log-update/node_modules/wrap-ansi/README.md +97 -0
  147. package/test/cypress/node_modules/lru-cache/README.md +166 -0
  148. package/test/cypress/node_modules/merge-stream/README.md +78 -0
  149. package/test/cypress/node_modules/mime-db/README.md +102 -0
  150. package/test/cypress/node_modules/mime-types/README.md +123 -0
  151. package/test/cypress/node_modules/mimic-fn/README.md +69 -0
  152. package/test/cypress/node_modules/minimatch/README.md +209 -0
  153. package/test/cypress/node_modules/ms/README.md +60 -0
  154. package/test/cypress/node_modules/npm-run-path/README.md +115 -0
  155. package/test/cypress/node_modules/once/README.md +79 -0
  156. package/test/cypress/node_modules/onetime/README.md +94 -0
  157. package/test/cypress/node_modules/ospath/README.md +53 -0
  158. package/test/cypress/node_modules/p-map/README.md +89 -0
  159. package/test/cypress/node_modules/path-is-absolute/README.md +59 -0
  160. package/test/cypress/node_modules/path-key/README.md +61 -0
  161. package/test/cypress/node_modules/pend/README.md +41 -0
  162. package/test/cypress/node_modules/performance-now/README.md +30 -0
  163. package/test/cypress/node_modules/pify/README.md +119 -0
  164. package/test/cypress/node_modules/pretty-bytes/README.md +131 -0
  165. package/test/cypress/node_modules/proxy-from-env/README.md +131 -0
  166. package/test/cypress/node_modules/psl/README.md +215 -0
  167. package/test/cypress/node_modules/pump/README.md +65 -0
  168. package/test/cypress/node_modules/punycode/README.md +122 -0
  169. package/test/cypress/node_modules/qs/README.md +475 -0
  170. package/test/cypress/node_modules/request-progress/README.md +78 -0
  171. package/test/cypress/node_modules/restore-cursor/README.md +26 -0
  172. package/test/cypress/node_modules/rimraf/README.md +101 -0
  173. package/test/cypress/node_modules/rxjs/README.md +147 -0
  174. package/test/cypress/node_modules/rxjs/_esm2015/README.md +147 -0
  175. package/test/cypress/node_modules/rxjs/_esm5/README.md +147 -0
  176. package/test/cypress/node_modules/rxjs/src/README.md +147 -0
  177. package/test/cypress/node_modules/safe-buffer/README.md +584 -0
  178. package/test/cypress/node_modules/safer-buffer/README.md +156 -0
  179. package/test/cypress/node_modules/semver/README.md +566 -0
  180. package/test/cypress/node_modules/shebang-command/README.md +34 -0
  181. package/test/cypress/node_modules/shebang-regex/README.md +33 -0
  182. package/test/cypress/node_modules/signal-exit/README.md +39 -0
  183. package/test/cypress/node_modules/slice-ansi/README.md +72 -0
  184. package/test/cypress/node_modules/sshpk/README.md +804 -0
  185. package/test/cypress/node_modules/string-width/README.md +50 -0
  186. package/test/cypress/node_modules/strip-ansi/README.md +46 -0
  187. package/test/cypress/node_modules/strip-final-newline/README.md +30 -0
  188. package/test/cypress/node_modules/supports-color/README.md +77 -0
  189. package/test/cypress/node_modules/throttleit/README.md +32 -0
  190. package/test/cypress/node_modules/tmp/README.md +365 -0
  191. package/test/cypress/node_modules/tough-cookie/README.md +527 -0
  192. package/test/cypress/node_modules/tslib/README.md +142 -0
  193. package/test/cypress/node_modules/tunnel-agent/README.md +4 -0
  194. package/test/cypress/node_modules/tweetnacl/README.md +459 -0
  195. package/test/cypress/node_modules/type-fest/README.md +760 -0
  196. package/test/cypress/node_modules/universalify/README.md +76 -0
  197. package/test/cypress/node_modules/untildify/README.md +30 -0
  198. package/test/cypress/node_modules/uuid/README.md +505 -0
  199. package/test/cypress/node_modules/verror/README.md +528 -0
  200. package/test/cypress/node_modules/verror/node_modules/extsprintf/README.md +46 -0
  201. package/test/cypress/node_modules/which/README.md +54 -0
  202. package/test/cypress/node_modules/wrap-ansi/README.md +91 -0
  203. package/test/cypress/node_modules/wrappy/README.md +36 -0
  204. package/test/cypress/node_modules/yallist/README.md +204 -0
  205. package/test/cypress/node_modules/yauzl/README.md +658 -0
@@ -0,0 +1,102 @@
1
+ # Colorette
2
+
3
+ > Easily set the color and style of text in the terminal.
4
+
5
+ - No wonky prototype method-chain API.
6
+ - Automatic color support detection.
7
+ - Up to [2x faster](#benchmarks) than alternatives.
8
+ - [`NO_COLOR`](https://no-color.org) friendly. 👌
9
+
10
+ Here's the first example to get you started.
11
+
12
+ ```js
13
+ import { blue, bold, underline } from "colorette"
14
+
15
+ console.log(
16
+ blue("I'm blue"),
17
+ bold(blue("da ba dee")),
18
+ underline(bold(blue("da ba daa")))
19
+ )
20
+ ```
21
+
22
+ Here's an example using [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals).
23
+
24
+ ```js
25
+ console.log(`
26
+ There's a ${underline(blue("house"))},
27
+ With a ${bold(blue("window"))},
28
+ And a ${blue("corvette")}
29
+ And everything is blue
30
+ `)
31
+ ```
32
+
33
+ Of course, you can nest styles without breaking existing color sequences.
34
+
35
+ ```js
36
+ console.log(bold(`I'm ${blue(`da ba ${underline("dee")} da ba`)} daa`))
37
+ ```
38
+
39
+ Feeling adventurous? Try the [pipeline operator](https://github.com/tc39/proposal-pipeline-operator).
40
+
41
+ ```js
42
+ console.log("Da ba dee da ba daa" |> blue |> bold)
43
+ ```
44
+
45
+ ## Installation
46
+
47
+ ```console
48
+ npm install colorette
49
+ ```
50
+
51
+ ## API
52
+
53
+ ### `<style>(string)`
54
+
55
+ ```js
56
+ import { blue } from "colorette"
57
+
58
+ blue("I'm blue") //=> \x1b[34mI'm blue\x1b[39m
59
+ ```
60
+
61
+ See [supported styles]().
62
+
63
+ ### `options.enabled`
64
+
65
+ Colorette automatically detects if your terminal can display color, but you can toggle color as needed.
66
+
67
+ ```js
68
+ import { options } from "colorette"
69
+
70
+ options.enabled = false
71
+ ```
72
+
73
+ You can also force the use of color globally by setting `FORCE_COLOR=` or `NO_COLOR=` from the CLI.
74
+
75
+ ```console
76
+ $ FORCE_COLOR= node example.js >log
77
+ $ NO_COLOR= node example.js
78
+ ```
79
+
80
+ ## Supported styles
81
+
82
+ | Colors | Background Colors | Bright Colors | Bright Background Colors | Modifiers |
83
+ | ------- | ----------------- | ------------- | ------------------------ | ----------------- |
84
+ | black | bgBlack | blackBright | bgBlackBright | dim |
85
+ | red | bgRed | redBright | bgRedBright | **bold** |
86
+ | green | bgGreen | greenBright | bgGreenBright | hidden |
87
+ | yellow | bgYellow | yellowBright | bgYellowBright | _italic_ |
88
+ | blue | bgBlue | blueBright | bgBlueBright | <u>underline</u> |
89
+ | magenta | bgMagenta | magentaBright | bgMagentaBright | ~~strikethrough~~ |
90
+ | cyan | bgCyan | cyanBright | bgCyanBright | reset |
91
+ | white | bgWhite | whiteBright | bgWhiteBright | |
92
+ | gray | | | | |
93
+
94
+ ## Benchmarks
95
+
96
+ ```console
97
+ npm --prefix bench start
98
+ ```
99
+
100
+ ## License
101
+
102
+ [MIT](LICENSE.md)
@@ -0,0 +1,221 @@
1
+ # colors.js
2
+ [![Build Status](https://travis-ci.org/Marak/colors.js.svg?branch=master)](https://travis-ci.org/Marak/colors.js)
3
+ [![version](https://img.shields.io/npm/v/colors.svg)](https://www.npmjs.org/package/colors)
4
+ [![dependencies](https://david-dm.org/Marak/colors.js.svg)](https://david-dm.org/Marak/colors.js)
5
+ [![devDependencies](https://david-dm.org/Marak/colors.js/dev-status.svg)](https://david-dm.org/Marak/colors.js#info=devDependencies)
6
+
7
+ Please check out the [roadmap](ROADMAP.md) for upcoming features and releases. Please open Issues to provide feedback, and check the `develop` branch for the latest bleeding-edge updates.
8
+
9
+ ## get color and style in your node.js console
10
+
11
+ ![Demo](https://raw.githubusercontent.com/Marak/colors.js/master/screenshots/colors.png)
12
+
13
+ ## Installation
14
+
15
+ npm install colors
16
+
17
+ ## colors and styles!
18
+
19
+ ### text colors
20
+
21
+ - black
22
+ - red
23
+ - green
24
+ - yellow
25
+ - blue
26
+ - magenta
27
+ - cyan
28
+ - white
29
+ - gray
30
+ - grey
31
+
32
+ ### bright text colors
33
+
34
+ - brightRed
35
+ - brightGreen
36
+ - brightYellow
37
+ - brightBlue
38
+ - brightMagenta
39
+ - brightCyan
40
+ - brightWhite
41
+
42
+ ### background colors
43
+
44
+ - bgBlack
45
+ - bgRed
46
+ - bgGreen
47
+ - bgYellow
48
+ - bgBlue
49
+ - bgMagenta
50
+ - bgCyan
51
+ - bgWhite
52
+ - bgGray
53
+ - bgGrey
54
+
55
+ ### bright background colors
56
+
57
+ - bgBrightRed
58
+ - bgBrightGreen
59
+ - bgBrightYellow
60
+ - bgBrightBlue
61
+ - bgBrightMagenta
62
+ - bgBrightCyan
63
+ - bgBrightWhite
64
+
65
+ ### styles
66
+
67
+ - reset
68
+ - bold
69
+ - dim
70
+ - italic
71
+ - underline
72
+ - inverse
73
+ - hidden
74
+ - strikethrough
75
+
76
+ ### extras
77
+
78
+ - rainbow
79
+ - zebra
80
+ - america
81
+ - trap
82
+ - random
83
+
84
+
85
+ ## Usage
86
+
87
+ By popular demand, `colors` now ships with two types of usages!
88
+
89
+ The super nifty way
90
+
91
+ ```js
92
+ var colors = require('colors');
93
+
94
+ console.log('hello'.green); // outputs green text
95
+ console.log('i like cake and pies'.underline.red) // outputs red underlined text
96
+ console.log('inverse the color'.inverse); // inverses the color
97
+ console.log('OMG Rainbows!'.rainbow); // rainbow
98
+ console.log('Run the trap'.trap); // Drops the bass
99
+
100
+ ```
101
+
102
+ or a slightly less nifty way which doesn't extend `String.prototype`
103
+
104
+ ```js
105
+ var colors = require('colors/safe');
106
+
107
+ console.log(colors.green('hello')); // outputs green text
108
+ console.log(colors.red.underline('i like cake and pies')) // outputs red underlined text
109
+ console.log(colors.inverse('inverse the color')); // inverses the color
110
+ console.log(colors.rainbow('OMG Rainbows!')); // rainbow
111
+ console.log(colors.trap('Run the trap')); // Drops the bass
112
+
113
+ ```
114
+
115
+ I prefer the first way. Some people seem to be afraid of extending `String.prototype` and prefer the second way.
116
+
117
+ If you are writing good code you will never have an issue with the first approach. If you really don't want to touch `String.prototype`, the second usage will not touch `String` native object.
118
+
119
+ ## Enabling/Disabling Colors
120
+
121
+ The package will auto-detect whether your terminal can use colors and enable/disable accordingly. When colors are disabled, the color functions do nothing. You can override this with a command-line flag:
122
+
123
+ ```bash
124
+ node myapp.js --no-color
125
+ node myapp.js --color=false
126
+
127
+ node myapp.js --color
128
+ node myapp.js --color=true
129
+ node myapp.js --color=always
130
+
131
+ FORCE_COLOR=1 node myapp.js
132
+ ```
133
+
134
+ Or in code:
135
+
136
+ ```javascript
137
+ var colors = require('colors');
138
+ colors.enable();
139
+ colors.disable();
140
+ ```
141
+
142
+ ## Console.log [string substitution](http://nodejs.org/docs/latest/api/console.html#console_console_log_data)
143
+
144
+ ```js
145
+ var name = 'Marak';
146
+ console.log(colors.green('Hello %s'), name);
147
+ // outputs -> 'Hello Marak'
148
+ ```
149
+
150
+ ## Custom themes
151
+
152
+ ### Using standard API
153
+
154
+ ```js
155
+
156
+ var colors = require('colors');
157
+
158
+ colors.setTheme({
159
+ silly: 'rainbow',
160
+ input: 'grey',
161
+ verbose: 'cyan',
162
+ prompt: 'grey',
163
+ info: 'green',
164
+ data: 'grey',
165
+ help: 'cyan',
166
+ warn: 'yellow',
167
+ debug: 'blue',
168
+ error: 'red'
169
+ });
170
+
171
+ // outputs red text
172
+ console.log("this is an error".error);
173
+
174
+ // outputs yellow text
175
+ console.log("this is a warning".warn);
176
+ ```
177
+
178
+ ### Using string safe API
179
+
180
+ ```js
181
+ var colors = require('colors/safe');
182
+
183
+ // set single property
184
+ var error = colors.red;
185
+ error('this is red');
186
+
187
+ // set theme
188
+ colors.setTheme({
189
+ silly: 'rainbow',
190
+ input: 'grey',
191
+ verbose: 'cyan',
192
+ prompt: 'grey',
193
+ info: 'green',
194
+ data: 'grey',
195
+ help: 'cyan',
196
+ warn: 'yellow',
197
+ debug: 'blue',
198
+ error: 'red'
199
+ });
200
+
201
+ // outputs red text
202
+ console.log(colors.error("this is an error"));
203
+
204
+ // outputs yellow text
205
+ console.log(colors.warn("this is a warning"));
206
+
207
+ ```
208
+
209
+ ### Combining Colors
210
+
211
+ ```javascript
212
+ var colors = require('colors');
213
+
214
+ colors.setTheme({
215
+ custom: ['red', 'underline']
216
+ });
217
+
218
+ console.log('test'.custom);
219
+ ```
220
+
221
+ *Protip: There is a secret undocumented style in `colors`. If you find the style you can summon him.*
@@ -0,0 +1,138 @@
1
+ # combined-stream
2
+
3
+ A stream that emits multiple other streams one after another.
4
+
5
+ **NB** Currently `combined-stream` works with streams version 1 only. There is ongoing effort to switch this library to streams version 2. Any help is welcome. :) Meanwhile you can explore other libraries that provide streams2 support with more or less compatibility with `combined-stream`.
6
+
7
+ - [combined-stream2](https://www.npmjs.com/package/combined-stream2): A drop-in streams2-compatible replacement for the combined-stream module.
8
+
9
+ - [multistream](https://www.npmjs.com/package/multistream): A stream that emits multiple other streams one after another.
10
+
11
+ ## Installation
12
+
13
+ ``` bash
14
+ npm install combined-stream
15
+ ```
16
+
17
+ ## Usage
18
+
19
+ Here is a simple example that shows how you can use combined-stream to combine
20
+ two files into one:
21
+
22
+ ``` javascript
23
+ var CombinedStream = require('combined-stream');
24
+ var fs = require('fs');
25
+
26
+ var combinedStream = CombinedStream.create();
27
+ combinedStream.append(fs.createReadStream('file1.txt'));
28
+ combinedStream.append(fs.createReadStream('file2.txt'));
29
+
30
+ combinedStream.pipe(fs.createWriteStream('combined.txt'));
31
+ ```
32
+
33
+ While the example above works great, it will pause all source streams until
34
+ they are needed. If you don't want that to happen, you can set `pauseStreams`
35
+ to `false`:
36
+
37
+ ``` javascript
38
+ var CombinedStream = require('combined-stream');
39
+ var fs = require('fs');
40
+
41
+ var combinedStream = CombinedStream.create({pauseStreams: false});
42
+ combinedStream.append(fs.createReadStream('file1.txt'));
43
+ combinedStream.append(fs.createReadStream('file2.txt'));
44
+
45
+ combinedStream.pipe(fs.createWriteStream('combined.txt'));
46
+ ```
47
+
48
+ However, what if you don't have all the source streams yet, or you don't want
49
+ to allocate the resources (file descriptors, memory, etc.) for them right away?
50
+ Well, in that case you can simply provide a callback that supplies the stream
51
+ by calling a `next()` function:
52
+
53
+ ``` javascript
54
+ var CombinedStream = require('combined-stream');
55
+ var fs = require('fs');
56
+
57
+ var combinedStream = CombinedStream.create();
58
+ combinedStream.append(function(next) {
59
+ next(fs.createReadStream('file1.txt'));
60
+ });
61
+ combinedStream.append(function(next) {
62
+ next(fs.createReadStream('file2.txt'));
63
+ });
64
+
65
+ combinedStream.pipe(fs.createWriteStream('combined.txt'));
66
+ ```
67
+
68
+ ## API
69
+
70
+ ### CombinedStream.create([options])
71
+
72
+ Returns a new combined stream object. Available options are:
73
+
74
+ * `maxDataSize`
75
+ * `pauseStreams`
76
+
77
+ The effect of those options is described below.
78
+
79
+ ### combinedStream.pauseStreams = `true`
80
+
81
+ Whether to apply back pressure to the underlaying streams. If set to `false`,
82
+ the underlaying streams will never be paused. If set to `true`, the
83
+ underlaying streams will be paused right after being appended, as well as when
84
+ `delayedStream.pipe()` wants to throttle.
85
+
86
+ ### combinedStream.maxDataSize = `2 * 1024 * 1024`
87
+
88
+ The maximum amount of bytes (or characters) to buffer for all source streams.
89
+ If this value is exceeded, `combinedStream` emits an `'error'` event.
90
+
91
+ ### combinedStream.dataSize = `0`
92
+
93
+ The amount of bytes (or characters) currently buffered by `combinedStream`.
94
+
95
+ ### combinedStream.append(stream)
96
+
97
+ Appends the given `stream` to the combinedStream object. If `pauseStreams` is
98
+ set to `true, this stream will also be paused right away.
99
+
100
+ `streams` can also be a function that takes one parameter called `next`. `next`
101
+ is a function that must be invoked in order to provide the `next` stream, see
102
+ example above.
103
+
104
+ Regardless of how the `stream` is appended, combined-stream always attaches an
105
+ `'error'` listener to it, so you don't have to do that manually.
106
+
107
+ Special case: `stream` can also be a String or Buffer.
108
+
109
+ ### combinedStream.write(data)
110
+
111
+ You should not call this, `combinedStream` takes care of piping the appended
112
+ streams into itself for you.
113
+
114
+ ### combinedStream.resume()
115
+
116
+ Causes `combinedStream` to start drain the streams it manages. The function is
117
+ idempotent, and also emits a `'resume'` event each time which usually goes to
118
+ the stream that is currently being drained.
119
+
120
+ ### combinedStream.pause();
121
+
122
+ If `combinedStream.pauseStreams` is set to `false`, this does nothing.
123
+ Otherwise a `'pause'` event is emitted, this goes to the stream that is
124
+ currently being drained, so you can use it to apply back pressure.
125
+
126
+ ### combinedStream.end();
127
+
128
+ Sets `combinedStream.writable` to false, emits an `'end'` event, and removes
129
+ all streams from the queue.
130
+
131
+ ### combinedStream.destroy();
132
+
133
+ Same as `combinedStream.end()`, except it emits a `'close'` event instead of
134
+ `'end'`.
135
+
136
+ ## License
137
+
138
+ combined-stream is licensed under the MIT license.