Document that auth.deleteUsers() does not trigger auth.user().onDelete() in the docstring

未关闭

#2,928 创建于 2025年5月27日 0 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 1/5
预计耗时: 1 小时以内
新手友好度: 55/100

Issue 类型: 文档
描述清晰度: 描述清楚
活跃度: 停滞
技术栈: node.js, typescript
领域: documentation

调研方向

打开 src/auth/base-auth.ts 的第456-469行附近并阅读 deleteUsers() 的 docstring，然后将其措辞与链接的 Admin SDK 文档进行比较。添加一条明确说明：批量删除不会针对每个被删除的用户触发 auth.user().onDelete()；完成标准是函数 docstring 和生成的 API 参考中都公开这一警告。

由索引模型根据 Issue 内容生成。

描述

api: auth

[REQUIRED] Step 2: Describe your environment

Operating System version: NA
Firebase SDK version: 13.4.0
Firebase Product: auth (node.js admin sdk)
Node.js version: 20
NPM version: NA

[REQUIRED] Step 3: Describe the problem

The deleteUsers() API does not trigger auth.user().onDelete() function calls for each individually deleted user.

This was unexpected for me, and the issue here is that this behavior was not documented in the place where I looked: the function docstring.

After https://github.com/firebase/firebase-functions/issues/860, I can see that this behavior was documented here https://firebase.google.com/docs/auth/admin/manage-users#delete_multiple_users

However, it is not documented on the actual function docstring: https://github.com/firebase/firebase-admin-node/blob/3c2cb9f0265ae836469198a7ff18d5454f18aefd/src/auth/base-auth.ts#L456-L469 (which is used to generate the API reference version at https://firebase.google.com/docs/reference/admin/node/firebase-admin.auth.baseauth#baseauthdeleteusers)

I would have preferred to see the same warning there, since this is what appears in IDEs when you may be poking around for a bulk version of deleteUser().

主要语言: TypeScript
星标: 1.7k
派生: 419
平均合并: 4 天 20 小时
30 天内合并 PR: 16