cloudfire-auth / DeleteUsersResult

Interface: DeleteUsersResult

Defined in: types/firebase-admin/index.ts:200

Represents the result of the CloudFireAuth.deleteUsers. API.

Properties

errors

errors: FirebaseArrayIndexError[]

Defined in: types/firebase-admin/index.ts:216

A list of FirebaseArrayIndexError instances describing the errors that were encountered during the deletion. Length of this list is equal to the return value of DeleteUsersResult.failureCount.

---

failureCount

failureCount: number

Defined in: types/firebase-admin/index.ts:204

The number of user records that failed to be deleted (possibly zero).

---

successCount

successCount: number

Defined in: types/firebase-admin/index.ts:210

The number of users that were deleted successfully (possibly zero). Users that did not exist prior to calling deleteUsers() are considered to be successfully deleted.