fix docs typos

castore-dev · Mar 10, 2023 · 489d3e8 · 489d3e8
1 parent 85f3896
commit 489d3e8
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/packages/dynamodb-event-storage-adapter/README.md b/packages/dynamodb-event-storage-adapter/README.md
@@ -56,7 +56,7 @@ This adapter persists aggregates in **separate partitions**: When persisting an
 
 A [Global Secondary Index](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.html) is also required to efficiently retrieve the event store aggregates ids (`listAggregateIds` operation). Only initial events (`version = 1`) are projected. A `KEYS_ONLY` projection type is sufficient.
 
-```json
+```ts
 // 👇 Initial event
 {
   "aggregateId": "123", // <= Partition key

diff --git a/packages/event-bridge-message-bus-adapter/README.md b/packages/event-bridge-message-bus-adapter/README.md
@@ -32,7 +32,7 @@ import { EventBridgeMessageBusAdapter } from '@castore/event-bridge-message-bus-
 const eventBridgeClient = new EventBridgeClient({});
 
 const messageBusAdapter = new EventBridgeMessageBusAdapter({
-  eventBusName: 'my-table-name',
+  eventBusName: 'my-event-bus-name',
   eventBridgeClient,
 });
 
@@ -54,13 +54,13 @@ This will directly plug your MessageBus to EventBridge 🙌
 
 When publishing a message, its `eventStoreId` is used as the message `source` and its event `type` is used as `detail-type`. The whole message is passed to the `detail` property.
 
-```json
+```ts
 // 👇 Entry example
 {
   "source": "USERS", // <= eventStoreId
   "detail-type": "USER_CREATED", // <= event type
   "detail": {
-    "eventSourceId": "USERS",
+    "eventStoreId": "USERS",
     "event": {
       "aggregateId": "123",
       "version": 1,

diff --git a/packages/sqs-message-queue-adapter/README.md b/packages/sqs-message-queue-adapter/README.md
@@ -54,11 +54,11 @@ This will directly plug your MessageQueue to SQS 🙌
 
 When publishing a message, it is JSON stringified and passed as the record body.
 
-```json
+```ts
 // 👇 Record example
 {
   "body": "{
-    \"eventSourceId\": \"USERS\",
+    \"eventStoreId\": \"USERS\",
     \"event\": {
       \"aggregateId\": \"123\",
       \"version\": 1,
-Original file line number
+Diff line change
@@ Expand Up @@
     A [Global Secondary Index](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.html) is also required to efficiently retrieve the event store aggregates ids (`listAggregateIds` operation). Only initial events (`version = 1`) are projected. A `KEYS_ONLY` projection type is sufficient.
-    ```json
+    ```ts
     // 👇 Initial event
     {
       "aggregateId": "123", // <= Partition key
@@ Expand Down @@