Skip to content

Class: MemoryAdapter ​

Defined in: packages/core/src/adapters/memory.ts:41

In-memory adapter. Great for tests, prototypes, or apps whose roles are defined in code. Data is lost when the process exits.

Implements ​

Constructors ​

Constructor ​

ts
new MemoryAdapter(options?): MemoryAdapter;

Defined in: packages/core/src/adapters/memory.ts:50

Parameters ​

ParameterType
options?MemoryAdapterOptions

Returns ​

MemoryAdapter

Properties ​

PropertyModifierTypeDescriptionDefined in
supportsExpiryreadonlybooleantrue when the adapter stores an expiry per subject link (see above). Default: off. First-party adapters only set it when created with { expiry: true }, because it needs an expires_at column.packages/core/src/adapters/memory.ts:42

Methods ​

attachRolePermissions() ​

ts
attachRolePermissions(roleId, permissionIds): Promise<void>;

Defined in: packages/core/src/adapters/memory.ts:111

Parameters ​

ParameterType
roleIdId
permissionIdsreadonly Id[]

Returns ​

Promise<void>

Implementation of ​

RbacAdapter.attachRolePermissions


attachSubjectPermissions() ​

ts
attachSubjectPermissions(
   subject, 
   permissionIds, 
   teamId, 
   options?
): Promise<void>;

Defined in: packages/core/src/adapters/memory.ts:147

options is only passed with supportsExpiry: true; store its expiresAt on every given link.

Parameters ​

ParameterType
subjectSubject
permissionIdsreadonly Id[]
teamIdTeamId
options?AttachLinkOptions

Returns ​

Promise<void>

Implementation of ​

RbacAdapter.attachSubjectPermissions


attachSubjectRoles() ​

ts
attachSubjectRoles(
   subject, 
   roleIds, 
   teamId, 
   options?
): Promise<void>;

Defined in: packages/core/src/adapters/memory.ts:130

options is only passed with supportsExpiry: true; store its expiresAt on every given link.

Parameters ​

ParameterType
subjectSubject
roleIdsreadonly Id[]
teamIdTeamId
options?AttachLinkOptions

Returns ​

Promise<void>

Implementation of ​

RbacAdapter.attachSubjectRoles


createPermission() ​

ts
createPermission(data): Promise<Permission>;

Defined in: packages/core/src/adapters/memory.ts:56

Parameters ​

ParameterType
data{ guardName: string; name: string; }
data.guardNamestring
data.namestring

Returns ​

Promise<Permission>

Implementation of ​

RbacAdapter.createPermission


createRole() ​

ts
createRole(data): Promise<Role>;

Defined in: packages/core/src/adapters/memory.ts:81

Parameters ​

ParameterType
data{ guardName: string; name: string; teamId: TeamId; }
data.guardNamestring
data.namestring
data.teamIdTeamId

Returns ​

Promise<Role>

Implementation of ​

RbacAdapter.createRole


ts
deleteExpiredLinks(now): Promise<DeletedLinkCounts>;

Defined in: packages/core/src/adapters/memory.ts:193

Deletes every role and direct-permission link (any subject, team and guard) whose expiresAt is at or before now. Links without an expiry stay. Used by rbac.pruneExpired().

Parameters ​

ParameterType
nowDate

Returns ​

Promise<DeletedLinkCounts>

Implementation of ​

RbacAdapter.deleteExpiredLinks


deletePermission() ​

ts
deletePermission(id): Promise<void>;

Defined in: packages/core/src/adapters/memory.ts:73

Parameters ​

ParameterType
idId

Returns ​

Promise<void>

Implementation of ​

RbacAdapter.deletePermission


deleteRole() ​

ts
deleteRole(id): Promise<void>;

Defined in: packages/core/src/adapters/memory.ts:99

Parameters ​

ParameterType
idId

Returns ​

Promise<void>

Implementation of ​

RbacAdapter.deleteRole


detachRolePermissions() ​

ts
detachRolePermissions(roleId, permissionIds?): Promise<void>;

Defined in: packages/core/src/adapters/memory.ts:118

Parameters ​

ParameterType
roleIdId
permissionIds?readonly Id[]

Returns ​

Promise<void>

Implementation of ​

RbacAdapter.detachRolePermissions


detachSubjectPermissions() ​

ts
detachSubjectPermissions(
   subject, 
   permissionIds, 
   teamId
): Promise<void>;

Defined in: packages/core/src/adapters/memory.ts:156

Parameters ​

ParameterType
subjectSubject
permissionIdsreadonly Id[] | undefined
teamIdTeamId

Returns ​

Promise<void>

Implementation of ​

RbacAdapter.detachSubjectPermissions


detachSubjectRoles() ​

ts
detachSubjectRoles(
   subject, 
   roleIds, 
   teamId
): Promise<void>;

Defined in: packages/core/src/adapters/memory.ts:139

Parameters ​

ParameterType
subjectSubject
roleIdsreadonly Id[] | undefined
teamIdTeamId

Returns ​

Promise<void>

Implementation of ​

RbacAdapter.detachSubjectRoles


ts
detachTeamLinks(teamId): Promise<void>;

Defined in: packages/core/src/adapters/memory.ts:218

Removes every role and direct-permission link held in the team (model_has_* rows only; roles stay). Match the team id exactly. Never called with null (the global scope).

Used by rbac.deleteTeam(). Fallback: one detachSubjectRoles and one detachSubjectPermissions call (with undefined ids) per subject returned by getTeamLinks.

Parameters ​

ParameterType
teamIdId

Returns ​

Promise<void>

Implementation of ​

RbacAdapter.detachTeamLinks


findPermissions() ​

ts
findPermissions(query?): Promise<Permission[]>;

Defined in: packages/core/src/adapters/memory.ts:62

Parameters ​

ParameterType
query?FindPermissionsQuery

Returns ​

Promise<Permission[]>

Implementation of ​

RbacAdapter.findPermissions


findRoles() ​

ts
findRoles(query?): Promise<Role[]>;

Defined in: packages/core/src/adapters/memory.ts:87

Parameters ​

ParameterType
query?FindRolesQuery

Returns ​

Promise<Role[]>

Implementation of ​

RbacAdapter.findRoles


ts
getRolePermissionLinks(roleIds): Promise<RolePermissionLink[]>;

Defined in: packages/core/src/adapters/memory.ts:107

Parameters ​

ParameterType
roleIdsreadonly Id[]

Returns ​

Promise<RolePermissionLink[]>

Implementation of ​

RbacAdapter.getRolePermissionLinks


getSubjectIdsWithPermissions() ​

ts
getSubjectIdsWithPermissions(
   subjectType, 
   permissionIds, 
   teamId, 
   options?
): Promise<Id[]>;

Defined in: packages/core/src/adapters/memory.ts:173

Ids of subjects of subjectType that have ANY of the given DIRECT permissions in the given team. Unique. With options (only passed with supportsExpiry: true), links expired at options.now don't count.

Parameters ​

ParameterType
subjectTypestring
permissionIdsreadonly Id[]
teamIdTeamId
options?ActiveLinkOptions

Returns ​

Promise<Id[]>

Implementation of ​

RbacAdapter.getSubjectIdsWithPermissions


getSubjectIdsWithRoles() ​

ts
getSubjectIdsWithRoles(
   subjectType, 
   roleIds, 
   teamId, 
   options?
): Promise<Id[]>;

Defined in: packages/core/src/adapters/memory.ts:164

Ids of subjects of subjectType that have ANY of the given roles in the given team. Unique. With options (only passed with supportsExpiry: true), links expired at options.now don't count.

Parameters ​

ParameterType
subjectTypestring
roleIdsreadonly Id[]
teamIdTeamId
options?ActiveLinkOptions

Returns ​

Promise<Id[]>

Implementation of ​

RbacAdapter.getSubjectIdsWithRoles


ts
getSubjectLinks(subject): Promise<SubjectLinks>;

Defined in: packages/core/src/adapters/memory.ts:204

Every role and direct-permission link of the subject, in EVERY team (global included), whatever the guard. Match the subject exactly, like getSubjectRoleIds.

Used by rbac.for(subject).teams() and revokeAll({ allTeams: true }). No fallback: the required methods can only read one team at a time, so without it those two throw ADAPTER_METHOD_MISSING.

Parameters ​

ParameterType
subjectSubject

Returns ​

Promise<SubjectLinks>

Implementation of ​

RbacAdapter.getSubjectLinks


getSubjectPermissionIds() ​

ts
getSubjectPermissionIds(subject, teamId): Promise<Id[]>;

Defined in: packages/core/src/adapters/memory.ts:143

Parameters ​

ParameterType
subjectSubject
teamIdTeamId

Returns ​

Promise<Id[]>

Implementation of ​

RbacAdapter.getSubjectPermissionIds


ts
getSubjectPermissionLinks(subject, teamId): Promise<SubjectPermissionLink[]>;

Defined in: packages/core/src/adapters/memory.ts:188

The subject's direct-permission links in the team, like getSubjectRoleLinks.

Parameters ​

ParameterType
subjectSubject
teamIdTeamId

Returns ​

Promise<SubjectPermissionLink[]>

Implementation of ​

RbacAdapter.getSubjectPermissionLinks


getSubjectRoleIds() ​

ts
getSubjectRoleIds(subject, teamId): Promise<Id[]>;

Defined in: packages/core/src/adapters/memory.ts:126

Parameters ​

ParameterType
subjectSubject
teamIdTeamId

Returns ​

Promise<Id[]>

Implementation of ​

RbacAdapter.getSubjectRoleIds


ts
getSubjectRoleLinks(subject, teamId): Promise<SubjectRoleLink[]>;

Defined in: packages/core/src/adapters/memory.ts:184

The subject's role links in the team, expired ones included, each with its expiresAt (null = never). Match the subject and team exactly, like getSubjectRoleIds.

Parameters ​

ParameterType
subjectSubject
teamIdTeamId

Returns ​

Promise<SubjectRoleLink[]>

Implementation of ​

RbacAdapter.getSubjectRoleLinks


ts
getTeamLinks(teamId): Promise<SubjectLinks>;

Defined in: packages/core/src/adapters/memory.ts:211

Every role and direct-permission link held in the team, by any subject, whatever the guard. Match the team id exactly. Never called with null (the global scope).

Used by rbac.deleteTeam(). No fallback: the required methods need each subject's type and id, so without it deleteTeam() throws ADAPTER_METHOD_MISSING before writing anything.

Parameters ​

ParameterType
teamIdId

Returns ​

Promise<SubjectLinks>

Implementation of ​

RbacAdapter.getTeamLinks

Released under the MIT License. Inspired by spatie/laravel-permission.