firebase / firebase/firebase-admin-node

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

Đang mở
#2,928 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
api: auth
Ngôn ngữ chính
TypeScript
Star
1.7k
Fork
419
Merge trung bình
3 ngày 10 giờ
Pull request đã merge (30 ngày)
16

Mô tả

### [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()`.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.