@headspace/protos-events 0.0.20-alpha.0 → 0.0.20-alpha.4
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 +15 -0
- package/package.json +7 -2
package/README.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# @headspace/protos-events
|
|
2
|
+
|
|
3
|
+
The transportation format used for the SNS publishing clients and the SQS subscribing clients. It is protobuf based for type safety and ergonomics.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
`yarn add @headspace/protos-events`
|
|
7
|
+
|
|
8
|
+
## Getting started
|
|
9
|
+
|
|
10
|
+
Add a proto in the format of service name (i.e. auth.proto) and then add the [messages](https://developers.google.com/protocol-buffers/docs/encoding#structure).
|
|
11
|
+
|
|
12
|
+
## Examples
|
|
13
|
+
|
|
14
|
+
### user.proto
|
|
15
|
+
This proto is for the [user service](https://github.com/headspacemeditation/hs-user-service) is used to notify any subscribers to the `UserPasswordUpdated` message that a user's password has been updated.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@headspace/protos-events",
|
|
3
|
-
"version": "0.0.20-alpha.
|
|
3
|
+
"version": "0.0.20-alpha.4",
|
|
4
4
|
"main": "lib/index.js",
|
|
5
5
|
"typings": "lib/index.d.ts",
|
|
6
6
|
"scripts": {
|
|
@@ -14,8 +14,13 @@
|
|
|
14
14
|
"protobufjs": "^6.8.6"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
+
"babel-core": "^6.26.3",
|
|
18
|
+
"babel-jest": "^23.6.0",
|
|
19
|
+
"jest": "^23.6.0",
|
|
20
|
+
"jest-junit": "^5.1.0",
|
|
21
|
+
"ts-jest": "^23.10.0-beta.4",
|
|
17
22
|
"tslint": "^5.11.0",
|
|
18
23
|
"typescript": "^3.0.1"
|
|
19
24
|
},
|
|
20
|
-
"gitHead": "
|
|
25
|
+
"gitHead": "ecd8b44616b77d1e8fa410ffe31e04c7cce0a71f"
|
|
21
26
|
}
|