cloudfire-auth / FirebaseArrayIndexError

Interface: FirebaseArrayIndexError

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

Composite type which includes both a FirebaseError object and an index which can be used to get the errored item.

Example

var registrationTokens = [token1, token2, token3];
admin.messaging().subscribeToTopic(registrationTokens, 'topic-name')
  .then(function(response) {
    if (response.failureCount > 0) {
      console.log("Following devices unsucessfully subscribed to topic:");
      response.errors.forEach(function(error) {
        var invalidToken = registrationTokens[error.index];
        console.log(invalidToken, error.error);
      });
    } else {
      console.log("All devices successfully subscribed to topic:", response);
    }
  })
  .catch(function(error) {
    console.log("Error subscribing to topic:", error);
  });

Properties

error

error: FirebaseError

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

The error object.

---

index

index: number

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

The index of the errored item within the original array passed as part of the called API method.