@kody/reddit

src/get-user.ts

17 lines · 659 B · TypeScript
import { getUser, requireRecord, requireStringField } from './client.ts'
import type { GetUserInput } from './client.ts'

/**
 * Read a Reddit user about page, or their submitted / comments / overview listing.
 * @example
 * import getUser from 'kody:@kody/reddit/get-user'
 * const user = await getUser({ username: 'spez' })
 * // => { user: { name: 'spez', commentKarma: 0, linkKarma: 0, ... } }
 */
export default async function getUserEntrypoint(
	params: Partial<GetUserInput> & Record<string, unknown> = {},
) {
	const input = requireRecord(params, 'get-user')
	requireStringField(input, 'username', 'get-user')
	return getUser(input as GetUserInput)
}