Skip to content

Commit 64b1bb0

Browse files
docs: update spectrum-ts documentation for v1.5.0 (#17)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent a7dce6a commit 64b1bb0

3 files changed

Lines changed: 60 additions & 29 deletions

File tree

docs-src/spectrum-ts/getting-started.mdx.vel

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ bun add spectrum-ts
2727
```
2828
</CodeGroup>
2929

30-
Requires TypeScript 5 or later.
30+
Requires TypeScript 5 or later (TypeScript 6 is also supported).
3131

3232
## Core concepts
3333

docs-src/spectrum-ts/providers.mdx.vel

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,50 @@ Providers plug into Spectrum's type system and runtime. Each one exports a calla
2323

2424
Drop any combination into `providers`:
2525

26-
```ts
27-
import { Spectrum } from "spectrum-ts";
28-
import { imessage } from "spectrum-ts/providers/imessage";
29-
import { terminal } from "spectrum-ts/providers/terminal";
30-
import { whatsappBusiness } from "spectrum-ts/providers/whatsapp-business";
31-
32-
const app = await Spectrum({
33-
projectId: "...",
34-
projectSecret: "...",
35-
providers: [
36-
imessage.config(),
37-
whatsappBusiness.config({
38-
accessToken: process.env.WA_TOKEN!,
39-
phoneNumberId: process.env.WA_NUMBER_ID!,
40-
appSecret: process.env.WA_SECRET!,
41-
}),
42-
terminal.config(),
43-
],
44-
});
45-
```
26+
<Tabs>
27+
<Tab title="Aggregate import">
28+
```ts
29+
import { Spectrum } from "spectrum-ts";
30+
import { imessage, terminal, whatsappBusiness } from "spectrum-ts/providers";
31+
32+
const app = await Spectrum({
33+
projectId: "...",
34+
projectSecret: "...",
35+
providers: [
36+
imessage.config(),
37+
whatsappBusiness.config({
38+
accessToken: process.env.WA_TOKEN!,
39+
phoneNumberId: process.env.WA_NUMBER_ID!,
40+
appSecret: process.env.WA_SECRET!,
41+
}),
42+
terminal.config(),
43+
],
44+
});
45+
```
46+
</Tab>
47+
<Tab title="Individual imports">
48+
```ts
49+
import { Spectrum } from "spectrum-ts";
50+
import { imessage } from "spectrum-ts/providers/imessage";
51+
import { terminal } from "spectrum-ts/providers/terminal";
52+
import { whatsappBusiness } from "spectrum-ts/providers/whatsapp-business";
53+
54+
const app = await Spectrum({
55+
projectId: "...",
56+
projectSecret: "...",
57+
providers: [
58+
imessage.config(),
59+
whatsappBusiness.config({
60+
accessToken: process.env.WA_TOKEN!,
61+
phoneNumberId: process.env.WA_NUMBER_ID!,
62+
appSecret: process.env.WA_SECRET!,
63+
}),
64+
terminal.config(),
65+
],
66+
});
67+
```
68+
</Tab>
69+
</Tabs>
4670

4771
`app.messages` merges messages from every provider. The `message.platform` field tells you which one delivered each message.
4872

pnpm-lock.yaml

Lines changed: 15 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)