@amityco/ts-sdk/dist/communityRepository/communityMembership/observers/searchMembers.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { searchMembers } from '@amityco/ts-sdk'
 *
 * let communityMembers = []
 * const unsub = searchMembers({
 *   communityId: Amity.Community['communityId'],
 * }, response => merge(communityMembers, response.data))
 * ```
 *
 * Observe all mutations on a list of {@link Amity.CommunityUser}s
 *
 * @param params for querying community users
 * @param callback the function to call when new data are available
 * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the community users
 *
 * @category Community Live Collection
 */
export declare const searchMembers: (params: Amity.SearchCommunityMemberLiveCollection, callback: Amity.LiveCollectionCallback<Amity.Membership<'community'>>, config?: Amity.LiveCollectionConfig) => () => void;
//# sourceMappingURL=searchMembers.d.ts.map