Interface: ReadScope<S>
Defined in: packages/polizy/src/polizy.ts:181
The read operations exposed inside AuthSystem.withReadScope. Every call shares ONE read pass, so each (subject | object | relation) is fetched from storage at most once for the whole scope.
Operation-specific options like consistency, preload, or contextualTuples must not be passed to scope operations, as they share the single scope-wide reader.
Type Parameters
S
S extends AuthSchema<any, any, any, any, any>
Methods
check()
check(
request):Promise<boolean>
Defined in: packages/polizy/src/polizy.ts:182
Parameters
request
CheckRequest<S>
Returns
Promise<boolean>
checkMany()
checkMany(
requests):Promise<boolean[]>
Defined in: packages/polizy/src/polizy.ts:183
Parameters
requests
CheckRequest<S>[]
Returns
Promise<boolean[]>
countAccessibleObjects()
countAccessibleObjects(
args):Promise<number>
Defined in: packages/polizy/src/polizy.ts:208
Parameters
args
Returns
Promise<number>
countSubjects()
countSubjects(
args):Promise<number>
Defined in: packages/polizy/src/polizy.ts:202
Parameters
args
canThey
keyof S["actionToRelations"]
context?
Record<string, unknown>
ofType?
onWhat
AnyObject<SchemaObjectTypes<S>>
Returns
Promise<number>
explain()
explain(
request):Promise<ExplainResult>
Defined in: packages/polizy/src/polizy.ts:184
Parameters
request
CheckRequest<S>
Returns
Promise<ExplainResult>
listAccessibleObjects()
listAccessibleObjects(
args):Promise<ListAccessibleObjectsResult<S>>
Defined in: packages/polizy/src/polizy.ts:185
Parameters
args
ListAccessibleObjectsArgs<S> & object
Returns
Promise<ListAccessibleObjectsResult<S>>
listSubjects()
listSubjects(
args):Promise<Subject<SchemaSubjectTypes<S>>[]>
Defined in: packages/polizy/src/polizy.ts:188
Parameters
args
canThey
keyof S["actionToRelations"]
context?
Record<string, unknown>
limit?
number
offset?
number
ofType?
onWhat
AnyObject<SchemaObjectTypes<S>>
Returns
Promise<Subject<SchemaSubjectTypes<S>>[]>
someoneCan()
someoneCan(
args):Promise<boolean>
Defined in: packages/polizy/src/polizy.ts:196
Parameters
args
canThey
keyof S["actionToRelations"]
context?
Record<string, unknown>
ofType?
onWhat
AnyObject<SchemaObjectTypes<S>>
Returns
Promise<boolean>