UNPKG

serverless-offline-msk

Version:

A serverless offline plugin that enables AWS MSK events

github.com/lukevers/serverless-offline-msk

lukevers/serverless-offline-msk

71 lines (49 loc) • 3.24 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
[![*nix build status][nix-build-image]][nix-build-url] [![Windows build status][win-build-image]][win-build-url] [![Tests coverage][cov-image]][cov-url] ![Transpilation status][transpilation-image] [![npm version][npm-image]][npm-url] # child-process-ext ## [Node.js `child_process`](https://nodejs.org/api/child_process..html) extensions ### Installation ```bash npm install child-process-ext ``` ### API #### `spawn(command[, args[, options]])` Cross system compliant [`spawn`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) (backed by [`cross-spawn`](https://www.npmjs.com/package/cross-spawn)). Works exactly same way as node's [`spawn`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) with difference that promise is returned that resolves once process exits. Following properties are exposed on return promise: - `child` - child process - `stdout` - stdout stream (decorated so it can also be used as promise) - `stderr` - stderr stream (decorated so it can also be used as promise) - `std` - Merged stdout & stderr stream (decorated so it can also be used as promise) - `stdoutBuffer` - Buffer that exposes so far written `stdout` - `stderrBuffer` - Buffer that exposes so far written `stderrr` - `stdBuffer` - Buffer that exposes so far written `std` Promise resolves with object with three properties: - `code` - Exit code of a child proces - `signal` - Signal that terminated the process - `stdoutBuffer` - Buffer containing gathered `stdout` content - `stderrBuffer` - Buffer containing gathered `stderr` content - `stdBuffer` - Buffer containing gathered `stderr` content If process exits with non zero code, then promise is rejected with an error exposing same properties as above ##### Non standard options ###### split `bool` (default: `false`) Whether stdout data should be split by lines. If set to `true`, then `stdout` and `stderr` on promise expose mappers of original `stdout` and `stderr` that emit each line with distinct `data` event ###### shouldCloseStdin `bool` (default: `false`) Whether stdin should be closed. Applicable for spawned processes where `stdin` is set to other than `'inherit'` mode, and underlying processes is reading from `stdin`. Not providing any `stdin` output, may produce stall if process logic waits for an input. _See: [get-stdin#13](https://github.com/sindresorhus/get-stdin/issues/13#issuecomment-279234249) for more information_ ### Tests ```bash npm test ``` [nix-build-image]: https://semaphoreci.com/api/v1/medikoo-org/child-process-ext/branches/master/shields_badge.svg [nix-build-url]: https://semaphoreci.com/medikoo-org/child-process-ext [win-build-image]: https://ci.appveyor.com/api/projects/status/8r0yv6561qwijfbe?svg=true [win-build-url]: https://ci.appveyor.com/api/project/medikoo/child-process-ext [cov-image]: https://img.shields.io/codecov/c/github/medikoo/child-process-ext.svg [cov-url]: https://codecov.io/gh/medikoo/child-process-ext [transpilation-image]: https://img.shields.io/badge/transpilation-free-brightgreen.svg [npm-image]: https://img.shields.io/npm/v/child-process-ext.svg [npm-url]: https://www.npmjs.com/package/child-process-ext