Skip to content

docs: update spectrum-ts documentation for v4.0.0 #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
photon-action-bot wants to merge 1 commit into from
Closed

docs: update spectrum-ts documentation for v4.0.0 #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs-src/spectrum-ts/getting-started.mdx.vel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ bun add spectrum-ts

Requires TypeScript 5 or later (TypeScript 6 is also supported).

Streaming providers (iMessage cloud and dedicated modes) connect over WebSocket and need a runtime with a global `WebSocket` — Node 22+, Bun, browsers, or edge workers. Webhook-only apps are not affected.

## Core concepts

Spectrum is built around four primitives:
Expand Down
4 changes: 2 additions & 2 deletions docs-src/spectrum-ts/providers/imessage.mdx.vel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The iMessage provider supports three connection modes — local, cloud, and dedi

<Tabs>
<Tab title="Cloud (default)">
Authenticates with Spectrum Cloud and connects to managed iMessage infrastructure via gRPC. Full feature set: send, receive, typing, reactions, replies, and group creation.
Authenticates with Spectrum Cloud and connects to managed iMessage infrastructure via WebSocket. Full feature set: send, receive, typing, reactions, replies, and group creation.

```ts
imessage.config();
Expand Down Expand Up @@ -41,7 +41,7 @@ The iMessage provider supports three connection modes — local, cloud, and dedi
</Note>
</Tab>
<Tab title="Dedicated">
Connect directly to one or more iMessage gRPC endpoints with your own tokens — use this when you're running your own iMessage relay and want to skip cloud auth. Each entry must include the `phone` number the instance serves, so Spectrum can route messages through the right number:
Connect directly to one or more iMessage WebSocket endpoints with your own tokens — use this when you're running your own iMessage relay and want to skip cloud auth. Each entry must include the `phone` number the instance serves, so Spectrum can route messages through the right number:

```ts
imessage.config({
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"eslint-plugin-format": "^2.0.1",
"husky": "^9.1.7",
"oxfmt": "^0.44.0",
"spectrum-ts": "3.1.0",
"spectrum-ts": "4.0.0",
"tsx": "^4.21.0",
"typescript": "^5.9.3"
}
Expand Down
57 changes: 7 additions & 50 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading