Skip to main content
Version: 57.2.0

TerrenoAccess

Type Parameters​

S​

S extends Statements

Properties​

ac​

readonly ac: object

can​

can: (args) => Promise<AccessResult>

Parameters​

args​

AccessCheckArgs<S>

Returns​

Promise<AccessResult>

fieldMask​

fieldMask: (args) => Promise<FieldMask>

Parameters​

args​
doc?​

unknown

phase?​

"write" | "read" | "create"

resource​

string

user?​

User

Returns​

Promise<FieldMask>

getPermissions​

getPermissions: (args) => Promise<PermissionSet>

Parameters​

args​
user​

User

Returns​

Promise<PermissionSet>

invalidateCache​

invalidateCache: (args?) => void

Parameters​

args?​
userId?​

string

Returns​

void

middleware​

middleware: (permissions, options?) => RequestHandler

Parameters​

permissions​

PermissionRequest<S>

options?​
getDoc?​

(req) => Promise<unknown>

Returns​

RequestHandler

permission​

permission: (permissions) => PermissionMethod<unknown>

Parameters​

permissions​

PermissionRequest<S>

Returns​

PermissionMethod<unknown>

queryFilter​

queryFilter: (args) => Promise<Record<string, unknown> | null>

Parameters​

args​
action​

string

context?​

Record<string, unknown>

resource​

string

user?​

User

Returns​

Promise<Record<string, unknown> | null>

roles​

roles: RoleManager

statements​

readonly statements: S