Skip to content

Commit e956490

Browse files
committed
updated readme
1 parent 9c7b801 commit e956490

4 files changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1069,12 +1069,12 @@ When you listen for an event (e.g., in a Mediator or Component), you receive the
10691069
**Why a string?** It ensures that data remains immutable during transit and can be easily serialized for logging or debugging.
10701070

10711071
```javascript
1072-
import { EventData } from "modular-openscriptjs";
1072+
import { parsePayload } from "modular-openscriptjs";
10731073

10741074
// In a Component or Mediator
1075-
async $$auth_login(eventDataString, eventName) {
1075+
async $$auth_login(eventData, eventName) {
10761076
// 1. Parse the string back into an EventData object
1077-
const data = EventData.parse(eventDataString);
1077+
const data = parsePayload(eventData);
10781078

10791079
// 2. Access the message
10801080
const userId = data.message.get("id"); // 42
@@ -1120,7 +1120,7 @@ A Mediator is just a class that extends `Mediator`. It doesn't have a UI. It jus
11201120

11211121
```javascript
11221122
// src/mediators/AuthMediator.js
1123-
import { Mediator, EventData, payload } from "modular-openscriptjs";
1123+
import { Mediator, parsePayload, payload } from "modular-openscriptjs";
11241124

11251125
export default class AuthMediator extends Mediator {
11261126
// REQUIRED: This tells the framework to scan this class for listeners
@@ -1129,8 +1129,8 @@ export default class AuthMediator extends Mediator {
11291129
}
11301130

11311131
// Logic: Listen for 'auth' and 'login' events
1132-
async $$auth_login(eventDataString, eventName) {
1133-
const data = EventData.parse(eventDataString);
1132+
async $$auth_login(eventData, eventName) {
1133+
const data = parsePayload(eventData);
11341134
const credentials = data.message.getAll();
11351135

11361136
try {

docs/2-components.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,20 +165,20 @@ Methods starting with `$$` are treated as listeners for global events emitted vi
165165

166166
**Signature**: `(eventData, eventName)`
167167

168-
- `eventData`: The JSON stringified payload (needs `EventData.parse()`).
168+
- `eventData`: The JSON stringified payload (needs `parsePayload()`).
169169
- `eventName`: The string name of the event that triggered this listener.
170170

171171
- `$$app_started(eventData, event)`: Listens for `app:started`.
172172
- `$$user_login(eventData, event)`: Listens for `user:login`.
173173

174174
```javascript
175-
import { EventData, component } from "modular-openscriptjs";
175+
import { parsePayload, component } from "modular-openscriptjs";
176176

177177
export default class UserProfile extends Component {
178178
// Listen to global 'auth:logout' event
179179
async $$auth_logout(eventData, event) {
180180
// 1. Parse Data
181-
const data = EventData.parse(eventData);
181+
const data = parsePayload(eventData);
182182
console.log(`Received ${event}`);
183183
}
184184
}

docs/8-events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,10 @@ async $$auth_login(eventData, event) {
8585
When an event is received (e.g., in a Mediator), the payload is often a **JSON string**. You must parse it back into an `EventData` object to access the helpers.
8686

8787
```javascript
88-
import { EventData } from "modular-openscriptjs";
88+
import { parsePayload } from "modular-openscriptjs";
8989

9090
// ... in a listener
91-
const eventData = EventData.parse(payloadString);
91+
const eventData = parsePayload(payloadString);
9292
```
9393

9494
### EventData Helper Methods

docs/9-mediators.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The `$$` prefix is used to define event listeners. OpenScript interprets these p
5252
If you use an underscore in the method name after `$$`, it acts as an **OR** operator. The method will key off **multiple independent events**.
5353

5454
```javascript
55-
import { EventData } from "modular-openscriptjs";
55+
import { parsePayload } from "modular-openscriptjs";
5656

5757
/*
5858
* Listens for:
@@ -62,7 +62,7 @@ import { EventData } from "modular-openscriptjs";
6262
*/
6363
async $$user_login(eventData, event) {
6464
// Parse the JSON string payload
65-
const data = EventData.parse(eventData);
65+
const data = parsePayload(eventData);
6666

6767
console.log(`Triggered by '${event}'`);
6868
console.log("User ID:", data.message.get("id"));
@@ -78,7 +78,7 @@ To listen to namespaced events (e.g., `user:login`, `user:logout`), you should u
7878
$$auth = {
7979
// Listens for 'auth:login'
8080
login: async (eventData, event) => {
81-
const data = EventData.parse(eventData);
81+
const data = parsePayload(eventData);
8282
this.handleLogin(data);
8383
},
8484

0 commit comments

Comments
 (0)