Skip to content

js-bao-wss-client


js-bao-wss-client / DiscoveredField

Interface: DiscoveredField ​

YDoc Schema Discovery

Reads meta* YMaps from a YDoc and returns a plain JSON description of the schema. Works with any YDoc — no BaseModel or database needed.

Usage: import { discoverSchema } from "js-bao"; const schema = discoverSchema(yDoc);

Properties ​

autoAssign? ​

optional autoAssign?: boolean


autoStamp? ​

optional autoStamp?: "create" | "update" | "both"


default? ​

optional default?: string | number | boolean


indexed? ​

optional indexed?: boolean


maxCount? ​

optional maxCount?: number


maxLength? ​

optional maxLength?: number


required? ​

optional required?: boolean


type ​

type: string


unique? ​

optional unique?: boolean

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30