Class StorageAdapter

Generic StorageAdapter

Index

Cache

addCompiledRoleContext getCompiledRoleContext createCacheKeyFromStringArray

Other

constructor cacheTTL

Storage

addPermissionSchema addRoleSchema deletePermissionSchema deleteRoleSchema doesPermissionSchemaExist doesRoleSchemaExist getPermissionSchema getRoleSchema updatePermissionSchema updateRoleSchema

Cache

addCompiledRoleContext

addCompiledRoleContext(key: string, ctx: compiledRoleContext): void
Check if cache for this key exists
Parameters
- key: string
  The caching key
- ctx: compiledRoleContext
  The context to cache
Returns void
- Defined in storage/StorageAdapter.ts:65

getCompiledRoleContext

getCompiledRoleContext(key: string): undefined | compiledRoleContext
Search for cached contexts
Parameters
- key: string
  The caching key
Returns undefined | compiledRoleContext
- Defined in storage/StorageAdapter.ts:49

`Static`createCacheKeyFromStringArray

createCacheKeyFromStringArray(arr: string | string[]): string
Generates the cache key for the given strings. Is used as the function to create unique cache keys
Parameters
- arr: string | string[]
  The strings to use for the cache key
Returns string
- Defined in storage/StorageAdapter.ts:35

Other

constructor

new StorageAdapter(options?: StorageManagerOptions): StorageAdapter
Parameters
- Optionaloptions: StorageManagerOptions
Returns StorageAdapter
- Defined in storage/StorageAdapter.ts:22

`Readonly`cacheTTL

cacheTTL: number = 5000

Storage

addPermissionSchema

addPermissionSchema(
permissionSchemaName: string,
permissionSchema: PermissionSchema,
): void
Add a permission schema
Parameters
- permissionSchemaName: string
- permissionSchema: PermissionSchema
Returns void
- Defined in storage/StorageAdapter.ts:87

addRoleSchema

addRoleSchema(roleSchemaName: string, roleSchema: RoleSchema): void
Add a role schema
Parameters
- roleSchemaName: string
- roleSchema: RoleSchema
Returns void
- Defined in storage/StorageAdapter.ts:146

deletePermissionSchema

deletePermissionSchema(permissionSchemaName: string): void
Delete a permission schema by unique name
Parameters
- permissionSchemaName: string
Returns void
- Defined in storage/StorageAdapter.ts:124

deleteRoleSchema

deleteRoleSchema(roleSchemaName: string): void
Delete a role schema by unique name
Parameters
- roleSchemaName: string
Returns void
- Defined in storage/StorageAdapter.ts:183

doesPermissionSchemaExist

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

doesRoleSchemaExist

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

getPermissionSchema

getPermissionSchema(permissionSchemaName: string): PermissionSchema
Get a permission schema by unique name
Parameters
- permissionSchemaName: string
Returns PermissionSchema
- Defined in storage/StorageAdapter.ts:99

getRoleSchema

getRoleSchema(roleSchemaName: string): RoleSchema
Get a role schema by unique name
Parameters
- roleSchemaName: string
Returns RoleSchema
- Defined in storage/StorageAdapter.ts:158

updatePermissionSchema

updatePermissionSchema(
permissionSchemaName: string,
permissionSchema: PermissionSchema,
): void
Update a permission schema by name
Parameters
- permissionSchemaName: string
- permissionSchema: PermissionSchema
Returns void
- Defined in storage/StorageAdapter.ts:112

updateRoleSchema

updateRoleSchema(roleSchemaName: string, roleSchema: RoleSchema): void
Update a role schema by name
Parameters
- roleSchemaName: string
- roleSchema: RoleSchema
Returns void
- Defined in storage/StorageAdapter.ts:171