wj-elements/dist/packages/utils/permissions.d.ts

WebJET Elements is a modern set of user interface tools harnessing the power of web components designed to simplify web application development.

/**
 * PermissionsApi is a utility class for managing permissions.
 * It allows setting, retrieving, and checking permissions stored in the browser's local storage.
 */
export class Permissions {
    static _permissionKey: string;
    /**
     * Sets the permission key for the PermissionsApi.
     * The key is stored internally and defaults to 'permissions' if no value is provided.
     * @param {string} value The key to set for permissions. If no value is provided, the default is 'permissions'.
     */
    static set permissionKey(value: string);
    /**
     * Retrieves the permission key used for accessing the permissions API.
     * @returns {string} The permission key associated with the PermissionsApi.
     */
    static get permissionKey(): string;
    /**
     * Sets the permissions by storing them in the local storage.
     * @param {object} value The permissions object to be stored.
     */
    static set permissions(value: object);
    /**
     * Retrieves the list of permissions stored in the browser's local storage.
     * @returns {Array} An array of permissions. If no permissions are found, returns an empty array.
     */
    static get permissions(): any[];
    /**
     * Determines whether the specified key exists in the permissions list.
     * @param {string} key The key to check for existence in the permissions list.
     * @returns {boolean} Returns true if the key exists in the permissions list; otherwise, returns false.
     */
    static includesKey(key: string): boolean;
    /**
     * Checks if at least one of the given permissions is fulfilled, based on the permissions available in `PermissionsApi`.
     * @param {Array<string>} permissions The list of permissions to check against the permissions available in `PermissionsApi`.
     * @returns {boolean} Returns `true` if any of the given permissions match the permissions available in `PermissionsApi`, otherwise returns `false`.
     */
    static isPermissionFulfilled(permissions: Array<string>): boolean;
}