Skip to content

js-bao-wss-client


js-bao-wss-client / DebugRuleSetParams

Interface: DebugRuleSetParams ​

Parameters for ruleSets.debug(), identifying the real user, group, category, and operation to evaluate.

Properties ​

category ​

category: string

The resource category being accessed (e.g., "members", "documents")


groupId? ​

optional groupId?: string

If provided, evaluates rules within a specific group's context


groupType ​

groupType: string

The group type whose rule set should be evaluated


operation ​

operation: string

The operation being performed (e.g., "read", "write", "delete")


targetUserId? ​

optional targetUserId?: string

If provided, the target user of the operation being debugged


userId ​

userId: string

The real user ID to evaluate rules against

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