Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/server / / WsTicketStore

Interface: WsTicketStore

Defined in: packages/server/src/ws/ticket.ts:69

Pluggable in-memory ticket store used by the WS upgrade handler + the POST /v1/session/ws-ticket route.

Stable

Properties

Property	Modifier	Type	Defined in
ttlMs	readonly	number	packages/server/src/ws/ticket.ts:70

Methods

consume()

consume(value): WsTicketConsumeResult;

Defined in: packages/server/src/ws/ticket.ts:72

Parameters

Parameter	Type
value	string

Returns

WsTicketConsumeResult

---

issue()

issue(input): WsTicket;

Defined in: packages/server/src/ws/ticket.ts:71

Parameters

Parameter	Type
input	{ scopes: readonly ParsedScope[]; tokenId: string; }
input.scopes	readonly ParsedScope[]
input.tokenId	string

Returns

WsTicket

---

prune()

prune(): number;

Defined in: packages/server/src/ws/ticket.ts:74

Drop expired entries; called on every consume().

Returns

number

---

size()

size(): number;

Defined in: packages/server/src/ws/ticket.ts:75

Returns

number