Skip to content

Commit

Permalink
chore(api): generate types + docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jwerle committed Aug 26, 2024
1 parent 0fe3a5d commit 576d326
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 77 deletions.
14 changes: 7 additions & 7 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1736,7 +1736,7 @@ This is a `FunctionDeclaration` named `maybeMakeError` in `api/ipc.js`, it's exp
This is a `ClassDeclaration` named ``IPCSearchParams` (extends `URLSearchParams`)` in `api/ipc.js`, it's exported but undocumented.


## [`emit(name, value, target, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1219)
## [`emit(name, value, target, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1218)

Emit event to be dispatched on `window` object.

Expand All @@ -1747,7 +1747,7 @@ Emit event to be dispatched on `window` object.
| target | EventTarget | window | true | |
| options | Object | | true | |

## [`send(command, value, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1278)
## [`send(command, value, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1277)

Sends an async IPC command request with parameters.

Expand All @@ -1763,27 +1763,27 @@ Sends an async IPC command request with parameters.
| :--- | :--- | :--- |
| Not specified | Promise<Result> | |

## [`inflateIPCMessageTransfers()`](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1729)
## [`inflateIPCMessageTransfers()`](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1728)

This is a `FunctionDeclaration` named `inflateIPCMessageTransfers` in `api/ipc.js`, it's exported but undocumented.
## [`findIPCMessageTransfers()`](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1761)
## [`findIPCMessageTransfers()`](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1760)
This is a `FunctionDeclaration` named `findIPCMessageTransfers` in `api/ipc.js`, it's exported but undocumented.


## [ports](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1826)
## [ports](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1825)

This is a `VariableDeclaration` named `ports` in `api/ipc.js`, it's exported but undocumented.
## [`IPCMessagePort` (extends `MessagePort`)](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1828)
## [`IPCMessagePort` (extends `MessagePort`)](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L1827)
This is a `ClassDeclaration` named ``IPCMessagePort` (extends `MessagePort`)` in `api/ipc.js`, it's exported but undocumented.


## [`IPCMessageChannel` (extends `MessageChannel`)](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L2054)
## [`IPCMessageChannel` (extends `MessageChannel`)](https://github.com/socketsupply/socket/blob/v0.6.0-next/api/ipc.js#L2053)

This is a `ClassDeclaration` named ``IPCMessageChannel` (extends `MessageChannel`)` in `api/ipc.js`, it's exported but undocumented.
Expand Down
Loading

0 comments on commit 576d326

Please sign in to comment.