Add Boom.internal() to API docs fixes #127

[tribou]

I followed the Joi API doc example and added internal as an alias for badImplementation since the returned statusCode and error are the same.

[arb]

I think I'm going to pass on this. I don't think I've ever once seen this used in the wild. Plus it makes the documentation for this look really ugly.

[Marsup]

@arb you authorized it in #127 :D

[arb]

That was the old me.

[mtharrison]

Nes uses it: https://github.com/hapijs/nes/blob/master/lib/socket.js#L119

[tribou]

Well, thanks for at least considering, and I respect the fact that this hapi ecosystem is run as a tight ship (which is why I use it). 😉

FYI, I believe I got it from @geek who used it in his Nodevember 2015 presentation on Seneca:

https://github.com/geek/nodevember-2015/blob/6d7793cfe60c557945042f026e165532740a3f4f/arrival_open_routeV2.js

So he might have used it other places as well? My main concern for #127 is that Boom.internal() doesn't get accidentally removed without a major version bump, since I was planning to use it in a production environment (depending on the outcome of this issue). 😄

...it also looks like it's in one of the Hapi tests, but I don't know if that's enough of a reason to document it:

https://github.com/hapijs/hapi/blob/ed5e75e467e7c5744f6dc58cd067ae1d8bab18a5/test/handler.js#L378

[AdriVanHoudt]

Also this person on SO http://stackoverflow.com/questions/33410853/returning-error-object-along-with-the-hapijs-boom-object

[Marsup]

@tribou if it's already an alias to badImplementation, why not use this one then ?

[tribou]

@Marsup yep, you're right. I would just need to go back and change all of the places I had used it before realizing it wasn't in the API docs...

But is it still an issue that internal() may be currently used in prod environments and needs to be preserved? (Though I'm still confused as to where it all originated.)

[arb]

I guess my question is why are you using it over badImplementation? It is a public method so it should be documented... just not sure I understand the use case.

[geek]

@arb 500 is an internal server error, seems obvious to use the method named internal

[arb]

Can you change this to
Boom.badImplementation([message], [data]) - (alias: internal)

[arb]

Undo this please. The TOC is automatically generated.

[tribou]

Both changes should now be updated.

[lock]

This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions.