useServerPermissions Composable
File: src/composables/useServerPermissions.ts
Overview
Exports
- UserRoleInfo - interface export
- useServerPermissions - function export
Functions
useServerPermissions()
No description available.
Parameters: None
Returns: void
export function useServerPermissions()loadProfileId(_authId: string)
No description available.
Parameters:
_authId: string
Returns: Unknown
const loadProfileId = async (_authId: string) =>getCacheKey(userId: string, serverId: string)
No description available.
Parameters:
userId: stringserverId: string
Returns: Unknown
const getCacheKey = (userId: string, serverId: string) =>loadPermissions(userId: string, serverId: string)
No description available.
Parameters:
userId: stringserverId: string
Returns: Promise<Record<Permission, boolean>>
const loadPermissions = async (userId: string, serverId: string): Promise<Record<Permission, boolean>> =>loadUserRoles(userId: string, serverId: string)
No description available.
Parameters:
userId: stringserverId: string
Returns: Promise<ServerRole[]>
const loadUserRoles = async (userId: string, serverId: string): Promise<ServerRole[]> =>isServerOwner(serverId: string, profileId?: string)
No description available.
Parameters:
serverId: stringprofileId?: string
Returns: boolean
const isServerOwner = (serverId: string, profileId?: string): boolean =>getUserRole(serverId: string, profileId?: string)
No description available.
Parameters:
serverId: stringprofileId?: string
Returns: UserRoleInfo
const getUserRole = (serverId: string, profileId?: string): UserRoleInfo =>hasPermission(serverId: string, profileId: string, permission: Permission)
No description available.
Parameters:
serverId: stringprofileId: stringpermission: Permission
Returns: boolean
const hasPermission = (
serverId: string,
profileId: string,
permission: Permission
): boolean =>2
3
4
5
hasPermissionAsync(serverId: string, profileId: string, permission: Permission, channelId?: string)
No description available.
Parameters:
serverId: stringprofileId: stringpermission: PermissionchannelId?: string
Returns: Promise<boolean>
const hasPermissionAsync = async (
serverId: string,
profileId: string,
permission: Permission,
channelId?: string
): Promise<boolean> =>2
3
4
5
6
hasCurrentUserPermission(permission: Permission)
No description available.
Parameters:
permission: Permission
Returns: boolean
const hasCurrentUserPermission = (permission: Permission): boolean =>checkServerPermission(serverId: string, permission: Permission, userId?: string)
No description available.
Parameters:
serverId: stringpermission: PermissionuserId?: string
Returns: boolean
const checkServerPermission = (
serverId: string,
permission: Permission,
userId?: string
): boolean =>2
3
4
5
clearServerCache(serverId: string)
No description available.
Parameters:
serverId: string
Returns: Unknown
const clearServerCache = (serverId: string) =>refreshPermissions()
No description available.
Parameters: None
Returns: Unknown
const refreshPermissions = async () =>getServerRoles(serverId: string)
No description available.
Parameters:
serverId: string
Returns: Promise<ServerRole[]>
const getServerRoles = async (serverId: string): Promise<ServerRole[]> =>Interfaces
UserRoleInfo
No description available.
interface UserRoleInfo {
id: string
name: string
permissions: Permission[]
isOwner: boolean
isModerator: boolean
isAdmin: boolean
color?: string
position: number
roles: ServerRole[]
}2
3
4
5
6
7
8
9
10
11
12
13
Source Code Insights
File Size: 15661 characters Lines of Code: 477 Imports: 8
Usage Example
import { UserRoleInfo, useServerPermissions } from '@/composables/useServerPermissions'
// Example usage
useServerPermissions()2
3
4
This documentation was automatically generated from the source code.
