@teambit/ipc-events 1.0.310 → 1.0.311

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.
@@ -1,4 +1,4 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
2
  <testsuites tests="0" failures="0" errors="0" skipped="0">
3
- <testsuite name="teambit.harmony/ipc-events@1.0.310" tests="0" failures="0" errors="0" skipped="0"/>
3
+ <testsuite name="teambit.harmony/ipc-events@1.0.311" tests="0" failures="0" errors="0" skipped="0"/>
4
4
  </testsuites>
@@ -36,7 +36,8 @@
36
36
  "character": 1
37
37
  },
38
38
  "raw": "/**\n * imagine you have multiple processes running in the background, such as `bit watch`, `bit start`, `bit server`.\n * the user is running `bit install` from the cli, how do you let these processes know that the installation is complete?\n * `bit start` for instance could use ths info to clear the \"component issues\" of the components that were missing packages.\n *\n * this class provides a mechanism to achieve this by writing the event into the filesystem (`.bit/events/event-name`),\n * while each one of the processes has a watcher in the background watch this file. once they got the data from the watcher,\n * they can act upon it.\n *\n * in the previous example, when the user is running `bit install`, the install aspect runs `this.publishIpcEvent` to\n * write `.bit/events/onPostInstall` to the filesystem. then, the watcher of `bit start` process got a notification\n * that this file has changed/added and it runs `triggerGotEvent` to run all aspects registered to its gotEventSlot.\n * the installer in turn is registered to this slot and once its function is triggered, it check whether the eventName\n * is onPostInstall and then triggers its own OnPostInstall slot.\n */",
39
- "comment": "imagine you have multiple processes running in the background, such as `bit watch`, `bit start`, `bit server`.\nthe user is running `bit install` from the cli, how do you let these processes know that the installation is complete?\n`bit start` for instance could use ths info to clear the \"component issues\" of the components that were missing packages.\n\nthis class provides a mechanism to achieve this by writing the event into the filesystem (`.bit/events/event-name`),\nwhile each one of the processes has a watcher in the background watch this file. once they got the data from the watcher,\nthey can act upon it.\n\nin the previous example, when the user is running `bit install`, the install aspect runs `this.publishIpcEvent` to\nwrite `.bit/events/onPostInstall` to the filesystem. then, the watcher of `bit start` process got a notification\nthat this file has changed/added and it runs `triggerGotEvent` to run all aspects registered to its gotEventSlot.\nthe installer in turn is registered to this slot and once its function is triggered, it check whether the eventName\nis onPostInstall and then triggers its own OnPostInstall slot."
39
+ "comment": "imagine you have multiple processes running in the background, such as `bit watch`, `bit start`, `bit server`.\nthe user is running `bit install` from the cli, how do you let these processes know that the installation is complete?\n`bit start` for instance could use ths info to clear the \"component issues\" of the components that were missing packages.\n\nthis class provides a mechanism to achieve this by writing the event into the filesystem (`.bit/events/event-name`),\nwhile each one of the processes has a watcher in the background watch this file. once they got the data from the watcher,\nthey can act upon it.\n\nin the previous example, when the user is running `bit install`, the install aspect runs `this.publishIpcEvent` to\nwrite `.bit/events/onPostInstall` to the filesystem. then, the watcher of `bit start` process got a notification\nthat this file has changed/added and it runs `triggerGotEvent` to run all aspects registered to its gotEventSlot.\nthe installer in turn is registered to this slot and once its function is triggered, it check whether the eventName\nis onPostInstall and then triggers its own OnPostInstall slot.",
40
+ "tags": []
40
41
  },
41
42
  "signature": "class IpcEventsMain",
42
43
  "name": "IpcEventsMain",
@@ -190,7 +191,8 @@
190
191
  "character": 3
191
192
  },
192
193
  "raw": "/**\n * this gets called from the watcher only.\n * as soon as the watcher finds out that a new event has been written to the filesystem, it triggers this function\n */",
193
- "comment": "this gets called from the watcher only.\nas soon as the watcher finds out that a new event has been written to the filesystem, it triggers this function"
194
+ "comment": "this gets called from the watcher only.\nas soon as the watcher finds out that a new event has been written to the filesystem, it triggers this function",
195
+ "tags": []
194
196
  },
195
197
  "signature": "(method) IpcEventsMain.triggerGotEvent(eventName: EventName): Promise<void>",
196
198
  "name": "triggerGotEvent",
@@ -245,7 +247,8 @@
245
247
  "character": 3
246
248
  },
247
249
  "raw": "/**\n * write event data into the filesystem, so then other processes, such as \"bit start\", \"bit watch\", could use the\n * watcher to get the event data.\n */",
248
- "comment": "write event data into the filesystem, so then other processes, such as \"bit start\", \"bit watch\", could use the\nwatcher to get the event data."
250
+ "comment": "write event data into the filesystem, so then other processes, such as \"bit start\", \"bit watch\", could use the\nwatcher to get the event data.",
251
+ "tags": []
249
252
  },
250
253
  "signature": "(method) IpcEventsMain.publishIpcEvent(eventName: EventName, data?: Record<string, any>): Promise<void>",
251
254
  "name": "publishIpcEvent",
@@ -607,7 +610,8 @@
607
610
  "character": 1
608
611
  },
609
612
  "raw": "/**\n * imagine you have multiple processes running in the background, such as `bit watch`, `bit start`, `bit server`.\n * the user is running `bit install` from the cli, how do you let these processes know that the installation is complete?\n * `bit start` for instance could use ths info to clear the \"component issues\" of the components that were missing packages.\n *\n * this class provides a mechanism to achieve this by writing the event into the filesystem (`.bit/events/event-name`),\n * while each one of the processes has a watcher in the background watch this file. once they got the data from the watcher,\n * they can act upon it.\n *\n * in the previous example, when the user is running `bit install`, the install aspect runs `this.publishIpcEvent` to\n * write `.bit/events/onPostInstall` to the filesystem. then, the watcher of `bit start` process got a notification\n * that this file has changed/added and it runs `triggerGotEvent` to run all aspects registered to its gotEventSlot.\n * the installer in turn is registered to this slot and once its function is triggered, it check whether the eventName\n * is onPostInstall and then triggers its own OnPostInstall slot.\n */",
610
- "comment": "imagine you have multiple processes running in the background, such as `bit watch`, `bit start`, `bit server`.\nthe user is running `bit install` from the cli, how do you let these processes know that the installation is complete?\n`bit start` for instance could use ths info to clear the \"component issues\" of the components that were missing packages.\n\nthis class provides a mechanism to achieve this by writing the event into the filesystem (`.bit/events/event-name`),\nwhile each one of the processes has a watcher in the background watch this file. once they got the data from the watcher,\nthey can act upon it.\n\nin the previous example, when the user is running `bit install`, the install aspect runs `this.publishIpcEvent` to\nwrite `.bit/events/onPostInstall` to the filesystem. then, the watcher of `bit start` process got a notification\nthat this file has changed/added and it runs `triggerGotEvent` to run all aspects registered to its gotEventSlot.\nthe installer in turn is registered to this slot and once its function is triggered, it check whether the eventName\nis onPostInstall and then triggers its own OnPostInstall slot."
613
+ "comment": "imagine you have multiple processes running in the background, such as `bit watch`, `bit start`, `bit server`.\nthe user is running `bit install` from the cli, how do you let these processes know that the installation is complete?\n`bit start` for instance could use ths info to clear the \"component issues\" of the components that were missing packages.\n\nthis class provides a mechanism to achieve this by writing the event into the filesystem (`.bit/events/event-name`),\nwhile each one of the processes has a watcher in the background watch this file. once they got the data from the watcher,\nthey can act upon it.\n\nin the previous example, when the user is running `bit install`, the install aspect runs `this.publishIpcEvent` to\nwrite `.bit/events/onPostInstall` to the filesystem. then, the watcher of `bit start` process got a notification\nthat this file has changed/added and it runs `triggerGotEvent` to run all aspects registered to its gotEventSlot.\nthe installer in turn is registered to this slot and once its function is triggered, it check whether the eventName\nis onPostInstall and then triggers its own OnPostInstall slot.",
614
+ "tags": []
611
615
  },
612
616
  "signature": "class IpcEventsMain",
613
617
  "name": "IpcEventsMain",
@@ -761,7 +765,8 @@
761
765
  "character": 3
762
766
  },
763
767
  "raw": "/**\n * this gets called from the watcher only.\n * as soon as the watcher finds out that a new event has been written to the filesystem, it triggers this function\n */",
764
- "comment": "this gets called from the watcher only.\nas soon as the watcher finds out that a new event has been written to the filesystem, it triggers this function"
768
+ "comment": "this gets called from the watcher only.\nas soon as the watcher finds out that a new event has been written to the filesystem, it triggers this function",
769
+ "tags": []
765
770
  },
766
771
  "signature": "(method) IpcEventsMain.triggerGotEvent(eventName: EventName): Promise<void>",
767
772
  "name": "triggerGotEvent",
@@ -816,7 +821,8 @@
816
821
  "character": 3
817
822
  },
818
823
  "raw": "/**\n * write event data into the filesystem, so then other processes, such as \"bit start\", \"bit watch\", could use the\n * watcher to get the event data.\n */",
819
- "comment": "write event data into the filesystem, so then other processes, such as \"bit start\", \"bit watch\", could use the\nwatcher to get the event data."
824
+ "comment": "write event data into the filesystem, so then other processes, such as \"bit start\", \"bit watch\", could use the\nwatcher to get the event data.",
825
+ "tags": []
820
826
  },
821
827
  "signature": "(method) IpcEventsMain.publishIpcEvent(eventName: EventName, data?: Record<string, any>): Promise<void>",
822
828
  "name": "publishIpcEvent",
@@ -1340,7 +1346,7 @@
1340
1346
  "componentId": {
1341
1347
  "scope": "teambit.harmony",
1342
1348
  "name": "ipc-events",
1343
- "version": "1.0.310"
1349
+ "version": "1.0.311"
1344
1350
  },
1345
1351
  "taggedModuleExports": []
1346
1352
  }
package/package.json CHANGED
@@ -1,20 +1,20 @@
1
1
  {
2
2
  "name": "@teambit/ipc-events",
3
- "version": "1.0.310",
3
+ "version": "1.0.311",
4
4
  "homepage": "https://bit.cloud/teambit/harmony/ipc-events",
5
5
  "main": "dist/index.js",
6
6
  "componentId": {
7
7
  "scope": "teambit.harmony",
8
8
  "name": "ipc-events",
9
- "version": "1.0.310"
9
+ "version": "1.0.311"
10
10
  },
11
11
  "dependencies": {
12
12
  "fs-extra": "10.0.0",
13
13
  "p-map-series": "2.1.0",
14
14
  "@teambit/harmony": "0.4.6",
15
- "@teambit/cli": "0.0.887",
16
- "@teambit/logger": "0.0.980",
17
- "@teambit/scope": "1.0.310"
15
+ "@teambit/cli": "0.0.888",
16
+ "@teambit/logger": "0.0.981",
17
+ "@teambit/scope": "1.0.311"
18
18
  },
19
19
  "devDependencies": {
20
20
  "@types/fs-extra": "9.0.7",