Variable useCheckPermissions`Const`

useCheckPermissions: <Permission extends string>(
    resourceType: AccessResourceType,
    resourceId: string,
    permissions: Permission[],
) => FetcherHookResult<Record<Permission, boolean>> = ...

Checks whether the current user holds the given permissions on a resource.

The hook suspends until the first fetch succeeds, so data is always present. data maps each requested permission to whether the user has it — keyed by exactly the permission strings you passed.

Type declaration

- <Permission extends string>(
      resourceType: AccessResourceType,
      resourceId: string,
      permissions: Permission[],
  ): FetcherHookResult<Record<Permission, boolean>>
- Type Parameters
  - Permission extends string
  Parameters
  - resourceType: AccessResourceType
    The type of resource (e.g. 'project', 'organization').
  - resourceId: string
    The resource id.
  - permissions: Permission[]
    The permission names to check.
  Returns FetcherHookResult<Record<Permission, boolean>>
  The result envelope {data, isFetching, error, refetch}.

Variable useCheckPermissionsConst

Type declaration

Type Parameters

Parameters

Returns FetcherHookResult<Record<Permission, boolean>>

Settings

Variable useCheckPermissions`Const`