@kentcdodds/groupme

GroupMe REST API helpers for listing groups, reading messages, ranking activity, and preparing relevance-filtered digests for Kody agents.

src/list-groups.ts

14 lines · 607 B · TypeScript

import { listGroups } from './domain.ts'
import type { GroupMeListGroupsOptions } from './types.ts'

/**
 * List the authenticated user's GroupMe groups (GET /groups).
 * @returns Array of group summaries with id, name, and message metadata.
 * @example
 * import listGroups from 'kody:@kentcdodds/groupme/list-groups'
 * const groups = await listGroups({ omitMemberships: true, limit: 20 })
 * // => [{ id: '...', name: 'Finding Neverland', messages: { count: 1200, ... } }]
 */
export default async function listGroupsEntrypoint(params: GroupMeListGroupsOptions = {}) {
	return await listGroups(params)
}