Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Stream all at-risk users as an async generator — no pagination needed.
atRiskAll() is an async generator that yields all at-risk users above a threshold, handling pagination automatically. Use it when you need to process the full list without managing offset / total yourself.
churn.atRiskAll(options?: AtRiskAllOptions): AsyncGenerator<AtRiskUser>
0.5.100.for await (const user of churn.atRiskAll({ threshold: 0.7 })) {
await sendOutreachEmail(user.userId, user.recommendation)
}
const users: AtRiskUser[] = []
for await (const user of churn.atRiskAll()) {
users.push(user)
}
console.log(`Total at-risk: ${users.length}`)
// Process only the first 50, then stop
let count = 0
for await (const user of churn.atRiskAll({ threshold: 0.8 })) {
await alert(user)
if (++count >= 50) break
}
// Build a map of userId → risk for a bulk email tool
const riskMap = new Map<string, AtRiskUser>()
for await (const user of churn.atRiskAll({ threshold: 0.6, plan: 'pro' })) {
riskMap.set(user.userId, user)
}
atRisk() | atRiskAll() | |
|---|---|---|
| Returns | One page | All pages (streaming) |
| Pagination | Manual | Automatic |
| Memory | Bounded | Unbounded (collects all if you push to array) |
| Use case | Dashboard, preview | Bulk processing, exports |