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

Abierto

#2,928 abierto el 27/5/2025 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad: 1/5
Tiempo estimado: Menos de una hora
Aptitud para principiantes: 55/100

Tipo de issue: Documentación
Claridad: Bien especificado
Estado de actividad: Estancado
Stack tecnológico: node.js, typescript
Área: documentation

Línea de trabajo

Abre src/auth/base-auth.ts alrededor de las líneas 456-469 y lee el docstring de deleteUsers(); después, compara su redacción con la documentación enlazada del Admin SDK. Añade una nota clara indicando que la eliminación masiva no activa auth.user().onDelete() para cada usuario eliminado; se considera terminado cuando el docstring de la función y la referencia de API generada exponen esta advertencia.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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().

Lenguaje dominante: TypeScript
Estrellas: 1.7k
Forks: 419
Merge medio: 4 d 20 h
PR fusionados (30 d): 16