DataSnapshot forEach method should be able to return void

[Francescu]

Code from the doc doesn't use the return boolean from the forEach function when it doesn't want to interrupt the enumeration.

Example

var query = firebase.database().ref("users").orderByKey();
query.once("value")
  .then(function(snapshot) {
    snapshot.forEach(function(childSnapshot) {
      // key will be "ada" the first time and "alan" the second time
      var key = childSnapshot.key;
      // childData will be the actual contents of the child
      var childData = childSnapshot.val();
  });
});

Problem

This code is not valid with the current Typescript definitions.

export interface DataSnapshot {
  forEach(action: (a: DataSnapshot) => boolean): boolean;
}

Proposal

I'm new to Firebase so I'd be careful there. But it seems that adding to the closure return type |void would fix the issue. I can provide a PR, if you're OK with this solution.

export interface DataSnapshot {
  forEach(action: (a: DataSnapshot) => boolean|void): boolean;
}

[google-oss-bot]

Hmmm this issue does not seem to follow the issue template. Make sure you provide all the required information.

[google-oss-bot]

Hey there! I couldn't figure out what this issue is about, so I've labeled it for a human to triage. Hang tight.

[schmidt-sebastian]

Thanks for sending this over @Francescu. We should indeed update the types. If you want to take a stab at this, I would be more than welcome to review your PR.

Take a look here: https://github.com/firebase/firebase-js-sdk/blob/master/packages/database-types/index.d.ts

[jspri]

https://github.com/firebase/firebase-js-sdk/blob/master/packages/database-types/index.d.ts#L78 Can be changed to Promise<DataSnapshot>

[jshcrowthe]

Closing this as it seems things have been taken care of. Thanks!