Class PermissionManager

The main class of the permission manager.

Index

Other

Resolver

createRoleContext

Schema storage

addPermissionSchema addRoleSchema deletePermissionSchema deleteRoleSchema doesPermissionSchemaExist doesRoleSchemaExist getPermissionSchema getRoleSchema updatePermissionSchema updateRoleSchema

Other

constructor

new PermissionManager(options?: PermissionManagerOptions): PermissionManager
Parameters
- Optionaloptions: PermissionManagerOptions
Returns PermissionManager
- Defined in PermissionManager.ts:20

Resolver

createRoleContext

createRoleContext(roles: string | string[]): RoleContext
Creates a new RoleContext by resolving the given roles.
Parameters
- roles: string | string[]
  List of roles which are included in the context
Returns RoleContext
- Defined in PermissionManager.ts:199

Schema storage

addPermissionSchema

addPermissionSchema(
permissionSchemaName: string,
permissionSchema: PermissionSchema,
): void
Add a permission schema
Parameters
- permissionSchemaName: string
- permissionSchema: PermissionSchema
Returns void
- Defined in PermissionManager.ts:226

addRoleSchema

addRoleSchema(roleSchemaName: string, roleSchema: RoleSchema): void
Add a role schema
Parameters
- roleSchemaName: string
- roleSchema: RoleSchema
Returns void
- Defined in PermissionManager.ts:273

deletePermissionSchema

deletePermissionSchema(permissionSchemaName: string): void
Delete a permission schema by unique name
Parameters
- permissionSchemaName: string
Returns void
- Defined in PermissionManager.ts:254

deleteRoleSchema

deleteRoleSchema(roleSchemaName: string): void
Delete a role schema by unique name
Parameters
- roleSchemaName: string
Returns void
- Defined in PermissionManager.ts:301

doesPermissionSchemaExist

doesPermissionSchemaExist(permissionSchemaName: string): boolean
Check if a permission schema with the given name exists
Parameters
- permissionSchemaName: string
Returns boolean
- Defined in PermissionManager.ts:216

doesRoleSchemaExist

doesRoleSchemaExist(roleSchemaName: string): boolean
Check if a role schema with the given name exists
Parameters
- roleSchemaName: string
Returns boolean
- Defined in PermissionManager.ts:263

getPermissionSchema

getPermissionSchema(permissionSchemaName: string): PermissionSchema
Get a permission schema by unique name
Parameters
- permissionSchemaName: string
Returns PermissionSchema
- Defined in PermissionManager.ts:235

getRoleSchema

getRoleSchema(roleSchemaName: string): RoleSchema
Get a role schema by unique name
Parameters
- roleSchemaName: string
Returns RoleSchema
- Defined in PermissionManager.ts:282

updatePermissionSchema

updatePermissionSchema(
permissionSchemaName: string,
permissionSchema: PermissionSchema,
): void
Update a permission schema by name
Parameters
- permissionSchemaName: string
- permissionSchema: PermissionSchema
Returns void
- Defined in PermissionManager.ts:245

updateRoleSchema

updateRoleSchema(roleSchemaName: string, roleSchema: RoleSchema): void
Update a role schema by name
Parameters
- roleSchemaName: string
- roleSchema: RoleSchema
Returns void
- Defined in PermissionManager.ts:292