Class JikeUser<M>

constructor

• new JikeUser<M extends boolean = boolean>(
      client: JikeClient,
      username?: string,
      profile?: ApiResponses.Users.Profile<M>,
  ): JikeUser<M>

  Type Parameters

  • M extends boolean = boolean

  Parameters

  • client: JikeClient
  • Optionalusername: string
  • Optionalprofile: ApiResponses.Users.Profile<M>

  Returns JikeUser<M>

Optionalprofile

follow

• follow(): Promise<void>

  关注用户

  Returns Promise<void>

getId

• getId(): Promise<string>

  获取用户 ID

  Returns Promise<string>

  用户 ID

getScreenName

• getScreenName(): Promise<string>

  获取用户昵称

  Returns Promise<string>

  用户昵称

getUsername

• getUsername(): Promise<string>

  获取用户名

  Returns Promise<string>

  用户名

isFollowing

• isFollowing(
      user: string | JikeUser<boolean>,
      mode: "following" | "auto" | "follower",
  ): Promise<boolean>

  是否关注用户

  Parameters

  • user: string | JikeUser<boolean>

    用户名或用户实例
  • mode: "following" | "auto" | "follower"

    following: 从 当前用户 的 关注 列表查找 目标用户 是否存在； follower : 从 目标用户 的 被关注 列表查找 当前用户 是否存在。 auto : 根据 following 和 follower 数量，自动选择上述两种模式。

    为提升查询速度，建议哪个数量少使用哪个。

  Returns Promise<boolean>

mute

• mute(): Promise<void>

  不看 TA 的内容

  Returns Promise<void>

queryFollowers

• queryFollowers(option?: PaginatedOption<User, never, string>): Promise<User[]>

  查询用户被关注

  Parameters

  • option: PaginatedOption<User, never, string> = {}

  Returns Promise<User[]>

queryFollowersWithTime

• queryFollowersWithTime(
      option?: PaginatedOption<FollowerWithTime, "followTime", string>,
  ): Promise<FollowerWithTime[]>

  查询用户被关注，带关注时间。逐个用户查询，耗时较长。

  Parameters

  • option: PaginatedOption<FollowerWithTime, "followTime", string> = {}

  Returns Promise<FollowerWithTime[]>

queryFollowings

• queryFollowings(option?: PaginatedOption<User, never, string>): Promise<User[]>

  查询用户关注

  Parameters

  • option: PaginatedOption<User, never, string> = {}

  Returns Promise<User[]>

queryPersonalUpdate

• queryPersonalUpdate(
      option?: PaginatedOption<PersonalPost, "createdAt", string>,
  ): Promise<JikePostWithDetail[]>

  查询用户动态

  Parameters

  • option: PaginatedOption<PersonalPost, "createdAt", string> = {}

  Returns Promise<JikePostWithDetail[]>

queryProfile

• queryProfile(ignoreCache?: boolean): Promise<ApiResponses.Users.Profile<M>>

  查询用户信息

  Parameters

  • ignoreCache: boolean = false

    不使用缓存

  Returns Promise<ApiResponses.Users.Profile<M>>

unfollow

• unfollow(option?: UserUnfollowOption): Promise<void>

  取消关注用户

  Parameters

  • option: UserUnfollowOption = {}

  Returns Promise<void>

unmute

• unmute(): Promise<void>

  重新看 TA 的内容

  Returns Promise<void>