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
new MemoryAdapter(options?): MemoryAdapter;Defined in: packages/core/src/adapters/memory.ts:50
Parameters
| Parameter | Type |
|---|---|
options? | MemoryAdapterOptions |
Returns
MemoryAdapter
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
supportsExpiry | readonly | boolean | true 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()
attachRolePermissions(roleId, permissionIds): Promise<void>;Defined in: packages/core/src/adapters/memory.ts:111
Parameters
| Parameter | Type |
|---|---|
roleId | Id |
permissionIds | readonly Id[] |
Returns
Promise<void>
Implementation of
RbacAdapter.attachRolePermissions
attachSubjectPermissions()
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
| Parameter | Type |
|---|---|
subject | Subject |
permissionIds | readonly Id[] |
teamId | TeamId |
options? | AttachLinkOptions |
Returns
Promise<void>
Implementation of
RbacAdapter.attachSubjectPermissions
attachSubjectRoles()
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
| Parameter | Type |
|---|---|
subject | Subject |
roleIds | readonly Id[] |
teamId | TeamId |
options? | AttachLinkOptions |
Returns
Promise<void>
Implementation of
RbacAdapter.attachSubjectRoles
createPermission()
createPermission(data): Promise<Permission>;Defined in: packages/core/src/adapters/memory.ts:56
Parameters
| Parameter | Type |
|---|---|
data | { guardName: string; name: string; } |
data.guardName | string |
data.name | string |
Returns
Promise<Permission>
Implementation of
createRole()
createRole(data): Promise<Role>;Defined in: packages/core/src/adapters/memory.ts:81
Parameters
| Parameter | Type |
|---|---|
data | { guardName: string; name: string; teamId: TeamId; } |
data.guardName | string |
data.name | string |
data.teamId | TeamId |
Returns
Promise<Role>
Implementation of
deleteExpiredLinks()
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
| Parameter | Type |
|---|---|
now | Date |
Returns
Promise<DeletedLinkCounts>
Implementation of
RbacAdapter.deleteExpiredLinks
deletePermission()
deletePermission(id): Promise<void>;Defined in: packages/core/src/adapters/memory.ts:73
Parameters
| Parameter | Type |
|---|---|
id | Id |
Returns
Promise<void>
Implementation of
deleteRole()
deleteRole(id): Promise<void>;Defined in: packages/core/src/adapters/memory.ts:99
Parameters
| Parameter | Type |
|---|---|
id | Id |
Returns
Promise<void>
Implementation of
detachRolePermissions()
detachRolePermissions(roleId, permissionIds?): Promise<void>;Defined in: packages/core/src/adapters/memory.ts:118
Parameters
| Parameter | Type |
|---|---|
roleId | Id |
permissionIds? | readonly Id[] |
Returns
Promise<void>
Implementation of
RbacAdapter.detachRolePermissions
detachSubjectPermissions()
detachSubjectPermissions(
subject,
permissionIds,
teamId
): Promise<void>;Defined in: packages/core/src/adapters/memory.ts:156
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
permissionIds | readonly Id[] | undefined |
teamId | TeamId |
Returns
Promise<void>
Implementation of
RbacAdapter.detachSubjectPermissions
detachSubjectRoles()
detachSubjectRoles(
subject,
roleIds,
teamId
): Promise<void>;Defined in: packages/core/src/adapters/memory.ts:139
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
roleIds | readonly Id[] | undefined |
teamId | TeamId |
Returns
Promise<void>
Implementation of
RbacAdapter.detachSubjectRoles
detachTeamLinks()
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
| Parameter | Type |
|---|---|
teamId | Id |
Returns
Promise<void>
Implementation of
findPermissions()
findPermissions(query?): Promise<Permission[]>;Defined in: packages/core/src/adapters/memory.ts:62
Parameters
| Parameter | Type |
|---|---|
query? | FindPermissionsQuery |
Returns
Promise<Permission[]>
Implementation of
findRoles()
findRoles(query?): Promise<Role[]>;Defined in: packages/core/src/adapters/memory.ts:87
Parameters
| Parameter | Type |
|---|---|
query? | FindRolesQuery |
Returns
Promise<Role[]>
Implementation of
getRolePermissionLinks()
getRolePermissionLinks(roleIds): Promise<RolePermissionLink[]>;Defined in: packages/core/src/adapters/memory.ts:107
Parameters
| Parameter | Type |
|---|---|
roleIds | readonly Id[] |
Returns
Promise<RolePermissionLink[]>
Implementation of
RbacAdapter.getRolePermissionLinks
getSubjectIdsWithPermissions()
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
| Parameter | Type |
|---|---|
subjectType | string |
permissionIds | readonly Id[] |
teamId | TeamId |
options? | ActiveLinkOptions |
Returns
Promise<Id[]>
Implementation of
RbacAdapter.getSubjectIdsWithPermissions
getSubjectIdsWithRoles()
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
| Parameter | Type |
|---|---|
subjectType | string |
roleIds | readonly Id[] |
teamId | TeamId |
options? | ActiveLinkOptions |
Returns
Promise<Id[]>
Implementation of
RbacAdapter.getSubjectIdsWithRoles
getSubjectLinks()
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
| Parameter | Type |
|---|---|
subject | Subject |
Returns
Promise<SubjectLinks>
Implementation of
getSubjectPermissionIds()
getSubjectPermissionIds(subject, teamId): Promise<Id[]>;Defined in: packages/core/src/adapters/memory.ts:143
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
teamId | TeamId |
Returns
Promise<Id[]>
Implementation of
RbacAdapter.getSubjectPermissionIds
getSubjectPermissionLinks()
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
| Parameter | Type |
|---|---|
subject | Subject |
teamId | TeamId |
Returns
Promise<SubjectPermissionLink[]>
Implementation of
RbacAdapter.getSubjectPermissionLinks
getSubjectRoleIds()
getSubjectRoleIds(subject, teamId): Promise<Id[]>;Defined in: packages/core/src/adapters/memory.ts:126
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
teamId | TeamId |
Returns
Promise<Id[]>
Implementation of
getSubjectRoleLinks()
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
| Parameter | Type |
|---|---|
subject | Subject |
teamId | TeamId |
Returns
Promise<SubjectRoleLink[]>
Implementation of
RbacAdapter.getSubjectRoleLinks
getTeamLinks()
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
| Parameter | Type |
|---|---|
teamId | Id |
Returns
Promise<SubjectLinks>
