@twinfinity/permission
    Preparing search index...

    Interface IPermissionClient

    interface IPermissionClient {
        addGroupMember(
            groupId: string,
            userId: string,
            signal?: AbortSignal,
        ): Promise<GroupMember>;
        deleteGroup(
            id: string,
            request: DeleteGroupRequest,
            signal?: AbortSignal,
        ): Promise<Group>;
        listGroupMembers(
            groupId: string,
            page?: string,
            limit?: number,
            signal?: AbortSignal,
        ): Promise<PaginatedResponse<User>>;
        listGroups(
            page?: string,
            limit?: number,
            q?: string,
            signal?: AbortSignal,
        ): Promise<PaginatedResponse<Group>>;
        listUserGroups(
            userId: string,
            page?: string,
            limit?: number,
            signal?: AbortSignal,
        ): Promise<PaginatedResponse<Group>>;
        listUsers(
            page?: string,
            limit?: number,
            q?: string,
            signal?: AbortSignal,
        ): Promise<PaginatedResponse<User>>;
        putGroup(
            id: string,
            request: PutGroupRequest,
            signal?: AbortSignal,
        ): Promise<Group>;
        removeGroupMember(
            groupId: string,
            userId: string,
            signal?: AbortSignal,
        ): Promise<GroupMember>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • groupId: string
      • userId: string
      • Optionalsignal: AbortSignal

      Returns Promise<GroupMember>

    • Parameters

      • groupId: string
      • Optionalpage: string
      • Optionallimit: number
      • Optionalsignal: AbortSignal

      Returns Promise<PaginatedResponse<User>>

    • Parameters

      • Optionalpage: string
      • Optionallimit: number
      • Optionalq: string
      • Optionalsignal: AbortSignal

      Returns Promise<PaginatedResponse<Group>>

    • Parameters

      • userId: string
      • Optionalpage: string
      • Optionallimit: number
      • Optionalsignal: AbortSignal

      Returns Promise<PaginatedResponse<Group>>

    • Parameters

      • Optionalpage: string
      • Optionallimit: number
      • Optionalq: string
      • Optionalsignal: AbortSignal

      Returns Promise<PaginatedResponse<User>>

    • Parameters

      Returns Promise<Group>

    • Parameters

      • groupId: string
      • userId: string
      • Optionalsignal: AbortSignal

      Returns Promise<GroupMember>