Skip to content

Commit dff04e8

Browse files
committed
docs: add stream naming convention to topic-suffixes reference
1 parent ea1bd9a commit dff04e8

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/src/content/docs/reference/topic-suffixes.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,20 @@ import { Link } from '../../../utils/links';
99

1010
cross.stream uses special topic suffixes to coordinate between components and track their lifecycle. This reference documents all suffixes, organized by component type.
1111

12+
## Stream Naming Convention
13+
14+
When creating streams, **use hyphens (`-`) instead of dots (`.`)** in stream names:
15+
16+
```nushell
17+
# Good - uses hyphens
18+
"my-stream" | .append
19+
20+
# Avoid - dots can collide with system suffixes
21+
"my.stream" | .append
22+
```
23+
24+
Dots are reserved for the suffix convention (e.g., `.spawn`, `.recv`, `.register`). Using dots in stream names could accidentally collide with system topic suffixes, leading to unexpected behavior.
25+
1226
## Generators
1327

1428
<table>

0 commit comments

Comments
 (0)