46 lines
1.2 KiB
TypeScript
46 lines
1.2 KiB
TypeScript
/**
|
|
* Helper class to generate permission strings for resources.
|
|
*/
|
|
declare class Permission {
|
|
/**
|
|
* Generate read permission string for the provided role.
|
|
*
|
|
* @param {string} role
|
|
* @returns {string}
|
|
*/
|
|
static read: (role: string) => string;
|
|
/**
|
|
* Generate write permission string for the provided role.
|
|
*
|
|
* This is an alias of update, delete, and possibly create.
|
|
* Don't use write in combination with update, delete, or create.
|
|
*
|
|
* @param {string} role
|
|
* @returns {string}
|
|
*/
|
|
static write: (role: string) => string;
|
|
/**
|
|
* Generate create permission string for the provided role.
|
|
*
|
|
* @param {string} role
|
|
* @returns {string}
|
|
*/
|
|
static create: (role: string) => string;
|
|
/**
|
|
* Generate update permission string for the provided role.
|
|
*
|
|
* @param {string} role
|
|
* @returns {string}
|
|
*/
|
|
static update: (role: string) => string;
|
|
/**
|
|
* Generate delete permission string for the provided role.
|
|
*
|
|
* @param {string} role
|
|
* @returns {string}
|
|
*/
|
|
static delete: (role: string) => string;
|
|
}
|
|
|
|
export { Permission };
|