Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/server / / WsUpgradeOptions
Interface: WsUpgradeOptions
Defined in: packages/server/src/ws/upgrade.ts:61
Public configuration accepted by createWsUpgradeEvents.
Stable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
anonymous? | readonly | boolean | IP-13: authentication is disabled server-wide (auth.kind='none'). Accept the upgrade unconditionally with a full (admin:*) scope grant instead of silently refusing to mount the WS route. Trusted-loopback / single-operator mode only. | packages/server/src/ws/upgrade.ts:76 |
dispatcher | readonly | WsDispatcher | - | packages/server/src/ws/upgrade.ts:62 |
newSubscriberId? | readonly | () => string | - | packages/server/src/ws/upgrade.ts:86 |
newSubscriptionId? | readonly | () => string | - | packages/server/src/ws/upgrade.ts:85 |
now? | readonly | () => number | - | packages/server/src/ws/upgrade.ts:78 |
runs? | readonly | RunStateTracker | - | packages/server/src/ws/upgrade.ts:77 |
serverSubprotocol? | readonly | string | Subprotocol the server advertises. Defaults to SUBPROTOCOL_NAME; tests can override to exercise the mismatch path. | packages/server/src/ws/upgrade.ts:84 |
tickets | readonly | WsTicketStore | - | packages/server/src/ws/upgrade.ts:63 |
verifier? | readonly | TokenVerifier | Token verifier for bearer / ticket upgrades. Optional only in the IP-13 no-auth loopback mode (anonymous: true), where there is no verifier to construct and every upgrade is accepted. | packages/server/src/ws/upgrade.ts:69 |