a collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky
atproto
bluesky
typescript
npm
docs(repo): clarify about CAR streaming
+14
-2
+14
-2
packages/utilities/repo/README.md
+14
-2
packages/utilities/repo/README.md
···
7
7
```
8
8
9
9
AT Protocol stores user data in repositories - Merkle tree structures containing records organized
10
-
by collection. this package reads repository CAR exports (from `com.atproto.sync.getRepo` or
11
-
account exports) and iterates over the records.
10
+
by collection. this package reads repository CAR exports (from `com.atproto.sync.getRepo` or account
11
+
exports) and iterates over the records.
12
12
13
13
## usage
14
14
15
15
### streaming usage
16
+
17
+
> [!NOTE]
18
+
> PDS implementations, including the reference PDS, may not emit blocks in the efficient order
19
+
> specified by [Sync v1.1][sync-1.1]. the streaming reader compensates by buffering internally, so
20
+
> memory usage may be higher than expected.
21
+
>
22
+
> streaming may still be useful when responsiveness matters, such as web apps that want to display
23
+
> records as they arrive rather than waiting for the entire CAR to load.
24
+
>
25
+
> this library intends to enforce efficient block ordering once Sync v1.1 is finalized.
26
+
27
+
[sync-1.1]: https://github.com/bluesky-social/proposals/blob/main/0006-sync-iteration/README.md
16
28
17
29
```ts
18
30
import { fromStream } from '@atcute/repo';