mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2025-05-13 22:54:42 -04:00
762a0a850e
Doing this BEFORE the merge prevents a lot of merge conflicts. Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
20 lines
688 B
TypeScript
20 lines
688 B
TypeScript
/*
|
|
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
|
|
*
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
|
|
import type { GroupInfo } from './types'
|
|
import { GetApiRequestBuilder } from '../common/api-request-builder/get-api-request-builder'
|
|
|
|
/**
|
|
* Retrieves information about a group with a given name.
|
|
*
|
|
* @param groupName The name of the group.
|
|
* @return Information about the group.
|
|
* @throws {Error} when the api request wasn't successful.
|
|
*/
|
|
export const getGroup = async (groupName: string): Promise<GroupInfo> => {
|
|
const response = await new GetApiRequestBuilder<GroupInfo>('groups/' + groupName).sendRequest()
|
|
return response.asParsedJsonObject()
|
|
}
|