@twinfinity/permission
Preparing search index...
IPermissionClient
Interface IPermissionClient
interface
IPermissionClient
{
deleteGroup
(
id
:
string
,
request
:
DeleteGroupRequest
,
signal
?:
AbortSignal
,
)
:
Promise
<
Group
>
;
listGroups
(
page
?:
string
,
limit
?:
number
,
signal
?:
AbortSignal
,
)
:
Promise
<
PaginatedResponse
<
Group
>
>
;
listUsers
(
page
?:
string
,
limit
?:
number
,
signal
?:
AbortSignal
,
)
:
Promise
<
PaginatedResponse
<
User
>
>
;
putGroup
(
id
:
string
,
request
:
PutGroupRequest
,
signal
?:
AbortSignal
,
)
:
Promise
<
Group
>
;
}
Implemented by
PermissionClient
Index
Methods
delete
Group
list
Groups
list
Users
put
Group
Methods
delete
Group
deleteGroup
(
id
:
string
,
request
:
DeleteGroupRequest
,
signal
?:
AbortSignal
,
)
:
Promise
<
Group
>
Parameters
id
:
string
request
:
DeleteGroupRequest
Optional
signal
:
AbortSignal
Returns
Promise
<
Group
>
list
Groups
listGroups
(
page
?:
string
,
limit
?:
number
,
signal
?:
AbortSignal
,
)
:
Promise
<
PaginatedResponse
<
Group
>
>
Parameters
Optional
page
:
string
Optional
limit
:
number
Optional
signal
:
AbortSignal
Returns
Promise
<
PaginatedResponse
<
Group
>
>
list
Users
listUsers
(
page
?:
string
,
limit
?:
number
,
signal
?:
AbortSignal
,
)
:
Promise
<
PaginatedResponse
<
User
>
>
Parameters
Optional
page
:
string
Optional
limit
:
number
Optional
signal
:
AbortSignal
Returns
Promise
<
PaginatedResponse
<
User
>
>
put
Group
putGroup
(
id
:
string
,
request
:
PutGroupRequest
,
signal
?:
AbortSignal
,
)
:
Promise
<
Group
>
Parameters
id
:
string
request
:
PutGroupRequest
Optional
signal
:
AbortSignal
Returns
Promise
<
Group
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
delete
Group
list
Groups
list
Users
put
Group
@twinfinity/permission
Loading...