Initial Commit
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
# SignalOptionsSchema
|
||||
|
||||
Zod boundary schema for `Signal` construction options.
|
||||
|
||||
## Purpose
|
||||
|
||||
Validates the options passed when constructing a `Signal`.
|
||||
|
||||
## Features
|
||||
|
||||
- Optional `initialValue` as positive number
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { SignalOptionsSchema } from "@suaveplan/audio-transport";
|
||||
|
||||
const parsed = SignalOptionsSchema.safeParse({ initialValue: 130 });
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
- `SignalOptionsSchema` — `z.object({ initialValue })`
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
The schema is minimal because `Signal` only needs an initial value. All other behavior is controlled via method calls after construction.
|
||||
Reference in New Issue
Block a user