StreamClient

​

构造器

​

构造函数

• new StreamClient(client): StreamClient

​

参数

名称	类型
client	Client

​

返回值

StreamClient

​

定义位置

stream/stream_client.ts:560

​

方法

​

postsFirehoseJa

▸ postsFirehoseJa(partition, options?): Promise<EventDrivenStream>

日语 Post 流 实时传输所有公开的日语 Post。

返回一个易用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持使用 for await…of 进行异步迭代。

​

参数

名称	类型	描述
partition	number	分区号。
options	PostsFirehoseJaStreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流数据的事件驱动型流

​

定义于

stream/stream_client.ts:580

---

​

posts

▸ posts(options?): Promise<EventDrivenStream>

按规则过滤的 Post 流 实时流式传输与当前规则集匹配的 Post。

返回一个易用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持使用 for await…of 进行异步迭代。

​

参数

名称	类型
options	PostsStreamingOptions

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动型流

​

定义于

stream/stream_client.ts:710

---

​

postsSample10

▸ postsSample10(partition, options?): Promise<EventDrivenStream>

流式传输 10% 抽样的 Post 实时流式传输 10% 的公开 Post 样本。

返回一个易用的事件驱动流。 使用 .on() 监听诸如 ‘data’、‘error’、‘close’ 等事件。 也支持使用 for await…of 进行异步迭代。

​

参数

名称	类型	说明
partition	number	分区号。
options	PostsSample10StreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动流

​

定义于

stream/stream_client.ts:839

---

​

likesFirehose

▸ likesFirehose(partition, options?): Promise<EventDrivenStream>

流式获取所有点赞 实时传输所有公开的点赞。

返回一个易于使用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持配合 for await…of 进行异步迭代。

​

参数

名称	类型	描述
partition	number	分区号。
options	LikesFirehoseStreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动型流

​

定义位置

stream/stream_client.ts:973

---

​

likesCompliance

▸ likesCompliance(options?): Promise<EventDrivenStream>

流式传输 Likes 合规数据 为用户流式传输所有与 Likes 相关的合规数据。

返回一个易用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持使用 for await…of 进行异步迭代。

​

参数

名称	类型
options	LikesComplianceStreamingOptions

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动流

​

定义于

stream/stream_client.ts:1094

---

​

postsFirehoseEn

▸ postsFirehoseEn(partition, options?): Promise<EventDrivenStream>

英语 Post 实时流 实时传输所有公开的英语 Post。

返回一个易于使用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持通过 for await…of 进行异步迭代。

​

参数

名称	类型	描述
partition	number	分区号。
options	PostsFirehoseEnStreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动型流

​

定义位置

stream/stream_client.ts:1189

---

​

postsCompliance

▸ postsCompliance(partition, options?): Promise<EventDrivenStream>

流式传输 Post 的合规数据 流式传输与 Post 相关的所有合规数据。

返回一个易用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持使用 for await…of 进行异步迭代。

​

参数

名称	类型	说明
partition	number	分区号。
options	PostsComplianceStreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动流

​

定义于

stream/stream_client.ts:1323

---

​

postsFirehose

▸ postsFirehose(partition, options?): Promise<EventDrivenStream>

流式获取所有 Post 实时获取所有公开的 Post。

返回一个易用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持通过 for await…of 进行异步迭代。

​

参数

名称	类型	描述
partition	number	分区编号。
options	PostsFirehoseStreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流式 data 的事件驱动流

​

定义于

stream/stream_client.ts:1421

---

​

likesSample10

▸ likesSample10(partition, options?): Promise<EventDrivenStream>

采样 Likes 的流 实时传输 10% 的公开 Likes 样本。

返回一个易用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持通过 for await…of 进行异步迭代。

​

参数

名称	类型	描述
partition	number	分区号。
options	LikesSample10StreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动流

​

定义于

stream/stream_client.ts:1555

---

​

postsFirehosePt

▸ postsFirehosePt(partition, options?): Promise<EventDrivenStream>

葡萄牙语 Post 火hose 流 实时获取所有公开的葡萄牙语 Post。

返回一个易用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持使用 for await…of 进行异步迭代。

​

参数

名称	类型	描述
partition	number	分区号。
options	PostsFirehosePtStreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动流

​

定义于

stream/stream_client.ts:1680

---

​

postsFirehoseKo

▸ postsFirehoseKo(partition, options?): Promise<EventDrivenStream>

韩语 Post 实时流 实时获取所有公开的韩语 Post。

返回一个易用的事件驱动流。 使用 .on() 监听诸如 “data”、“error”、“close” 等事件。 也支持使用 for await…of 进行异步迭代。

​

参数

名称	类型	描述
partition	number	分区号。
options	PostsFirehoseKoStreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流式 data 的事件驱动流

​

定义于

stream/stream_client.ts:1814

---

​

labelsCompliance

▸ labelsCompliance(options?): Promise<EventDrivenStream>

Post 标签流 对应用于 Post 的所有标签事件进行流式传输。

返回一个易用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持通过 for await…of 进行异步迭代。

​

参数

参数名	类型
options	LabelsComplianceStreamingOptions

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动流

​

定义于

stream/stream_client.ts:1944

---

​

usersCompliance

▸ usersCompliance(partition, options?): Promise<EventDrivenStream>

流式传输 Users 的合规性 data 流式传输与 Users 相关的所有合规性 data。

返回一个易用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持通过 for await…of 进行异步迭代。

​

参数

名称	类型	说明
partition	number	分区号。
options	UsersComplianceStreamingOptions	-

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动流

​

定义于

stream/stream_client.ts:2039

---

​

postsSample

▸ postsSample(options?): Promise<EventDrivenStream>

流式抽样 Post 实时流式传输 1% 的公开 Post 样本。

返回一个易于使用的事件驱动流。 使用 .on() 监听 ‘data’、‘error’、‘close’ 等事件。 也支持通过 for await…of 进行异步迭代。

​

参数

名称	类型
options	PostsSampleStreamingOptions

​

返回

Promise<EventDrivenStream>

用于处理流式数据的事件驱动型流

​

定义位置

stream/stream_client.ts:2133

---

​

getRuleCounts

▸ getRuleCounts(options?): Promise<Get2TweetsSearchStreamRulesCountsResponse>

获取流规则计数 获取用于过滤流的当前生效规则集中的规则数量。

​

参数

名称	类型
options	GetRuleCountsStreamingOptions

​

返回

Promise<Get2TweetsSearchStreamRulesCountsResponse>

包含 API 响应的 Promise

​

定义于

stream/stream_client.ts:2242

---

​

getRules

▸ getRules(options?): Promise<RulesLookupResponse>

获取流规则 检索过滤流的活动规则集或其子集。

​

参数

名称	类型
options	GetRulesStreamingOptions

​

返回

Promise<RulesLookupResponse>

包含 API 响应的 Promise

​

定义于

stream/stream_client.ts:2299

---

​

updateRules

▸ updateRules(body, options?): Promise<AddOrDeleteRulesResponse>

更新流规则 向过滤流的当前规则集添加或删除规则。

​

参数

名称	类型
body	any
options	UpdateRulesStreamingOptions

​

返回

Promise<AddOrDeleteRulesResponse>

返回包含 API 响应的 Promise

​

定义于

stream/stream_client.ts:2368