@amityco/ts-sdk-react-native/dist/userRepository/api/getUser.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { getUser } from '~/user/api'
 * const { data: user } = await getUser('foobar')
 * ```
 *
 * Fetches a {@link Amity.User} object
 *
 * @param userId the ID of the {@link Amity.User} to fetch
 * @returns the associated {@link Amity.User} object
 *
 * @category Private
 * @async
 */
export declare const getUser: {
    (userId: Amity.User['userId']): Promise<Amity.Cached<Amity.User>>;
    /**
     * ```js
     * import { getUser } from '@amityco/ts-sdk-react-native'
     * const { data: user } = getUser.locally('foobar')
     * ```
     *
     * Fetches a {@link Amity.User} object from cache
     *
     * @param userId the ID of the {@link Amity.User} to fetch
     * @returns the associated {@link Amity.User} object
     *
     * @category User API
     */
    locally(userId: Amity.User['userId']): Amity.Cached<Amity.User> | undefined;
};
//# sourceMappingURL=getUser.d.ts.map