Interface: ReadScope<S>
Defined in: packages/polizy/src/polizy.ts:106
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.
Type Parameters
S
S extends AuthSchema<any, any, any, any, any>
Methods
check()
check(
request):Promise<boolean>
Defined in: packages/polizy/src/polizy.ts:107
Parameters
request
canThey
keyof S["actionToRelations"]
context?
Record<string, unknown>
onWhat
AnyObject<SchemaObjectTypes<S>>
who
Subject<SchemaSubjectTypes<S>> | AnyObject<SchemaObjectTypes<S>>
Returns
Promise<boolean>
checkMany()
checkMany(
requests):Promise<boolean[]>
Defined in: packages/polizy/src/polizy.ts:113
Parameters
requests
object[]
Returns
Promise<boolean[]>
explain()
explain(
request):Promise<ExplainResult>
Defined in: packages/polizy/src/polizy.ts:121
Parameters
request
canThey
keyof S["actionToRelations"]
context?
Record<string, unknown>
onWhat
AnyObject<SchemaObjectTypes<S>>
who
Subject<SchemaSubjectTypes<S>> | AnyObject<SchemaObjectTypes<S>>
Returns
Promise<ExplainResult>
listAccessibleObjects()
listAccessibleObjects(
args):Promise<ListAccessibleObjectsResult<S>>
Defined in: packages/polizy/src/polizy.ts:127
Parameters
args
ListAccessibleObjectsArgs<S> & object
Returns
Promise<ListAccessibleObjectsResult<S>>
listSubjects()
listSubjects(
args):Promise<Subject<SchemaSubjectTypes<S>>[]>
Defined in: packages/polizy/src/polizy.ts:130
Parameters
args
canThey
keyof S["actionToRelations"]
context?
Record<string, unknown>
ofType?
onWhat
AnyObject<SchemaObjectTypes<S>>
Returns
Promise<Subject<SchemaSubjectTypes<S>>[]>