hn-ts/dist/get-user-by-id.d.ts

TypeScript client for the Hacker News API

import { User } from "./user";
/**
 * `getUserById` returns the `User` with the given ID.
 * If the user is not available, `getUserById` returns `undefined`.
 *
 * @example
 * ```typescript
 * import { getUserById } from 'hn-ts';
 *
 * (async () => {
 *   const user = await getUserById({
 *     id: "velut",
 *   });
 *
 *   // Output: `velut`
 *   console.log(user.id);
 * })();
 * ```
 *
 * @see {@link User}
 * @see {@link https://github.com/HackerNews/API#users}
 */
export declare function getUserById({ id, }: {
    id: string;
}): Promise<User | undefined>;
//# sourceMappingURL=get-user-by-id.d.ts.map