API deprecations

[kanongil]

Remove unused:

• formatStack()
• formatTrace()
• callStack()
• displayStack()
• abort()
• escapeJavaScript()
• format()
• transform()
• isInteger() - was mapped to Number.isSafeInteger()
• inherits() - was mapped to Util.inherits()
• mapToObject()
• shallow() - can be replaced with Object.assign({}, obj)
• unique

Move to b64:

• base64urlEncode()
• base64urlDecode()

[hueniverse]

I'll go over the list and let you know.

[sholladay]

I wonder how often the key feature of hoek.unique() is used.

For those who don't,hoek.unique(array) literally just calls Array.from(new Set(array))

[kanongil]

Yes, there are a few methods that are basically wrappers or direct alias to javascript / node features.

We might want to prune some of these as well. While they might make sense to hapi developers, when encountered in some code, the ES version should be easier to grok for new users.

[kanongil]

It would seem that some of these are used in the extended hapi universe. Eg. I found base64urlEncode() and base64urlDecode() are used in hueniverse/iron.

Further analysis shows that those are the only additional methods used in any public hueniverse/ repo.

[hueniverse]

Leaving once() and contain() alone for now.

[hueniverse]

I don't think we need to publish release notes for this, but you can if you want.

[nathanchapman]

@hueniverse Why would there not be release notes for this? I just went to look back at the documentation for transform and found nothing.. Searched the code base and found nothing..

I finally came across this issue and found the corresponding commit. I don't see any of these functions as ever being marked @deprecated so having them evaporate with no release notes can't be good. I understand this was major versioned (correctly following semantic versioning), but the intention of major versioning something is so that someone upgrading will go look and see what changed before updating the module and breaking their application.

[hueniverse]

hoek has always been an internal hapi utility belt. I do not treat it as a generally useful module. Following hapi policies, a breaking changes issue is clearly marked that documents the changes. We expect people using hapi modules to be familiar with this practice and when there is a new major release, to look for either release notes or breaking changes labels.

The maintainer of this module might still choose to publish release notes if he finds that useful but I think this issue is enough documentation.