Skip to Content
Reference

How the reference works

Reference pages for every public entry point of the @streamsy packages.

The guides show how to use Streamsy. The reference describes each public export of @streamsy/core, @streamsy/projection, @streamsy/storage, and @streamsy/serve, organised by package and topic.

@streamsy/core

PageEntry pointExports
Streamsy@streamsy/coreThe stream class factories, group, Wildcard, and the class types
Wake streams@streamsy/coreStreamsy.wake, followWake, wakeActions, and the wake types
StreamAddress@streamsy/coreThe addresses, the collections, and the State changes and control messages
Producer@streamsy/coreProducer.next and Producer.Position
DurableState@streamsy/coreupsert, remove, changes, materialized, materialize, and their types
Options and results@streamsy/coreThe options of create, append, and read, and their results
Toolkit types@streamsy/coreBatch, the fold and decide types, and the failure unions
Errors@streamsy/coreThe protocol errors, the error unions, and isProtocolError
Faults@streamsy/coreThe storage, transport, and codec faults, and their guards
Ids and offsets@streamsy/coreStreamId, Offset, ProducerId, ZERO_OFFSET, and compare
Storage contract@streamsy/coreStorage, StorageCapabilities, CommitBoundary, the mutations, and their results
MemoryStorage@streamsy/coreMemoryStorage.layer, layerProtocol, and Options
Stream records@streamsy/coreStreamRecord, StoredMessage, RecordPatch, and the other stored values
Http@streamsy/core, @streamsy/core/httpHttp.routes, Http.app, Http.read, and the shutdown signal
RemoteStreams@streamsy/core/remoteRemoteStreams.layer, layerProtocol, Options, and TransportFault
Protocol@streamsy/core/protocolProtocol, StreamsReader, StreamsWriter, Reader, Writer, and routes
Streams@streamsy/core/protocolThe Streams functions on an address, and their options, results, and failures
StreamRoute@streamsy/core/protocolThe route functions and types
Testing@streamsy/core/testingStorageContract, faultyStorage, layerTest, StreamsTest, and expectFailureTag

@streamsy/projection

PageEntry pointExports
Projection constructors@streamsy/projectionProjection.fold, process, emit, mapAccum, mapAccumBatch, and wake
Projection runners@streamsy/projectionThe runners, the reads, the helpers, and ProjectionWakeup
Declarations and state@streamsy/projectionDeclaration, CurrentProjection, DecideSpec, and the state and step types
Units and progress@streamsy/projectionSlice, Entry, Unit, Range, the results, and the runner options
Commit@streamsy/projectionThe Commit namespace, the handler results, HandlerFailed, and Transaction
CheckpointStore@streamsy/projection, @streamsy/projection/checkpointCheckpointStore, CheckpointRecord, fromStore, recordKey, and the key types
Faults and retry@streamsy/projectionProjectionFault and ProjectionRetry

@streamsy/storage

PageEntry pointExports
SqlStorage@streamsy/storageSqlStorage.layer, layerProtocol, clientLayer, Options, and the defaults
BunStorage@streamsy/storage/bunBunStorage.layer, layerProtocol, and Options
DurableObjectStorage@streamsy/storage/durable-objectDurableObjectStorage.layer, layerProtocol, Options, and the default long-poll timeout

@streamsy/serve

PageEntry pointExports
Serve@streamsy/serveThe route and response functions, layer, teardown, and their options
Serve errors@streamsy/serveThe Serve error classes, ServeError, and PublicErrorSchema
Contract@streamsy/serve/contractCanonical JSON, fingerprints and ETags, header names, and public error bodies
Bun@streamsy/serve/bunThe Bun listener, its options, and its defaults
Node@streamsy/serve/nodeThe Node listener, its options, and its defaults
Deno@streamsy/serve/denoThe Deno listener, its options and defaults, and nodeSqliteCompat
Cloudflare@streamsy/serve/cloudflareWorker routing, Durable Object hosts, placement, wakeups, and object links
Alchemy@streamsy/serve/alchemyEffect routing, object transports, handlers, and the shared Cloudflare exports

On this page