@kentcdodds/x

X API v2 helpers for tweets, search, legacy DMs, and encrypted X Chat via a Fly XDK sidecar.

src/get-user-by-username.ts

14 lines · 634 B · TypeScript

import { getUserByUsername } from './client.ts'
import type { XGetUserByUsernameParams } from './client.ts'

/**
 * Reads an X user by username using app-only bearer auth by default.
 * @returns X API user payload from GET /users/by/username/:username.
 * @example
 * import getUserByUsername from 'kody:@kentcdodds/x/get-user-by-username'
 * const user = await getUserByUsername({ username: 'kentcdodds' })
 * // => { data: { id: '...', username: 'kentcdodds', name: 'Kent C. Dodds' } }
 */
export default async function getUserByUsernameEntrypoint(params: XGetUserByUsernameParams = {}) {
  return await getUserByUsername(params)
}