@selfcommunity/react-core/lib/cjs/utils/user.d.ts

React Core Components useful for integrating UI Community components (react-ui).

import { SCUserType } from '@selfcommunity/types';
/**
 * Staff Roles
 * @type {string}
 */
export declare const ADMIN_ROLE = "admin";
export declare const MODERATOR_ROLE = "moderator";
export declare const EDITOR_ROLE = "editor";
export declare const COMMUNITY_CREATOR = 1;
/**
 * Get user role from roles(set)
 * @param user
 * @returns role or null
 */
export declare function getUserRole(user: SCUserType): string | null;
/**
 * Check if user is admin
 * @param user
 * @returns boolean
 */
export declare function isAdmin(user: SCUserType): boolean;
/**
 * Check if user is admin
 * @param user
 * @returns boolean
 */
export declare function isCommunityCreator(user: SCUserType): boolean;
/**
 * Check if user is moderator
 * @param user
 * @returns boolean
 */
export declare function isModerator(user: SCUserType): boolean;
/**
 * Check if user is editor
 * @param user
 * @returns boolean
 */
export declare function isEditor(user: SCUserType): boolean;
/**
 * Check if user is admin or moderator
 * @param user
 * @returns boolean
 */
export declare function isStaff(user: SCUserType): boolean;
/**
 * Check if user is blocked/banned
 * User status values:
 *  a (approved), b (blocked), d (deleted; soft deleted),
 *  u (unregistered; hard deleted). Default: a.
 * @param user
 * @returns {*}
 */
export declare function isBlocked(user: SCUserType): boolean;