docs(readme): update docs

unadlib · Mar 31, 2024 · 26ed6e9 · 26ed6e9
1 parent c89f9d9
commit 26ed6e9
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -68,17 +68,17 @@ const App = () => {
 
 #### Parameters
 
-| Name      | Type   | Description            |
+| Parameter | Type   | Description            |
 | --------- | ------ | ---------------------- |
 | `type`    | enums  | Transport port type    |
 | `options` | object | Transport port options |
 
 #### Returns
 
-| Name               | Type     | Description                |
-| ------------------ | -------- | -------------------------- |
-| `transport.emit`   | function | Emit a message             |
-| `transport.listen` | hook     | Listen a message with deps |
+| Return             | Type                                                              | Description          |
+| ------------------ | ----------------------------------------------------------------- | -------------------- |
+| `transport.emit`   | (name: string \| options, ...args: any[]) => any                  | Emit a message       |
+| `transport.listen` | (name: string, fn: (...args: any[]) => any, deps?: any[]) => void | Listen for a message |
 
 > The `use-transport` hook returns a transport instance. more API details can be found in the [data-transport](https://github.com/unadlib/data-transport) documentation.