sse-cat 2.0.5 → 2.0.8

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/README.md CHANGED
@@ -8,15 +8,14 @@ Command-line client for Server-Sent Events(SSE).
8
8
 
9
9
  Options:
10
10
  -V, --version output the version number
11
- --header <header> Pass custom header(s) to server (default: [])
12
- --event <name> Pass custom event(s) that need to be captured (default: [])
13
- --heartbeat-event <name>
14
- --heartbeat-timeout <ms>
11
+ --header [header...] Pass custom header(s) to server
12
+ --event [name...] Pass custom event(s) that need to be captured
13
+ --heartbeat-event [name]
14
+ --heartbeat-timeout [ms]
15
15
  -h, --help display help for command
16
16
  ```
17
17
 
18
18
  ## Install
19
-
20
19
  ```sh
21
20
  npm install -g sse-cat
22
21
  # or
@@ -24,7 +23,6 @@ yarn global add sse-cat
24
23
  ```
25
24
 
26
25
  ### Install from source
27
-
28
26
  ```sh
29
27
  yarn install
30
28
  yarn build
@@ -32,15 +30,12 @@ yarn global add "file:$(pwd)"
32
30
  ```
33
31
 
34
32
  ## Usage
35
-
36
33
  ### Single SSE
37
-
38
34
  ```sh
39
35
  sse-cat 'http://localhost:8080/sse'
40
36
  ```
41
37
 
42
38
  ### Multiple SSE
43
-
44
39
  ```sh
45
40
  sse-cat \
46
41
  'http://localhost:8080/sse/1' \
@@ -48,25 +43,22 @@ sse-cat \
48
43
  ```
49
44
 
50
45
  ### Headers
51
-
52
46
  ```sh
53
47
  sse-cat \
54
48
  --header 'User-Agent: sse-cat' \
55
49
  --header "Authorization: Bearer $TOKEN" \
56
- 'http://localhost:8080/sse'
50
+ -- 'http://localhost:8080/sse'
57
51
  ```
58
52
 
59
53
  ### Custom events
60
-
61
54
  ```sh
62
55
  sse-cat \
63
56
  --event 'message' \
64
57
  --event 'custom-event' \
65
- 'http://localhost:8080/sse'
58
+ -- 'http://localhost:8080/sse'
66
59
  ```
67
60
 
68
61
  ### Heartbeat
69
-
70
62
  The heartbeat checker will only be enabled when all heartbeat options are set.
71
63
 
72
64
  ```sh