Skip to content
v1
文档/Browser JS SDK/用户

@beeworks/imsdk


@beeworks/imsdk / user / searchUsers

searchUsers() ​

searchUsers(options): Promise<IUserSearchResult | null>

查询用户列表

根据关键词分页搜索用户(通常用于查找好友)。

Parameters ​

options ​

查询选项

kw? ​

string

搜索关键词(匹配昵称、ID等)

skip? ​

number

跳过条数(分页用,默认为 0)

limit? ​

number

返回条数(默认为 20)

Returns ​

Promise<IUserSearchResult | null>

Promise<IUserSearchResult> - 查询结果包含列表和总数

Example ​

typescript
const result = await searchUsers({
  kw: 'alice',
  skip: 0,
  limit: 10
});
console.log('Found users:', result.results);