Added a method to extend output error

[imayolas]

Use case: To take advantage of Boom and at the same time send custom data to the output object, you must manually attach properties to the the_output.payload_ boom instance. The following code is more elegant and chainable: Boom.forbidden('My message').extendOutput({customError: 123});

[hueniverse]

I'm not sure how useful this is, but either way, there must be a nicer function name...

[imayolas]

I think it's useful in some contexts for an API to return errors with additional information, like an internal error code. Let's say for example that a database finds a duplicate username while creating one, and the ORM throws an error. You might want the API to return en error , with an internal èrrorCode property, to make it easier to identify that specific error in the frontend. I particularly don't like displaying the API error messages to the end user, especially as it makes localization of frontends more complex.
I am going to use it anyway for a project, and felt it was worth the addition. Feel free to decline it if you don't see the use.
As for the name & completing the code coverage to 100%, I'd appreciate if you give me a hand here.

[hueniverse]

I'll let @arb decide.

[arb]

Why are you calling it here? Doesn't look like it's doing anything.

[imayolas]

true. useless.

[arb]

Few other things

• I'm not sure of the use case on this as well. You have to create the error object first and then extend the properties anyway, what is adding this function really saving you?
• Please rebase to fewer commits
• Tests are not passing because you do not have 100% code coverage.

[imayolas]

I'm not sure of the use case on this as well. You have to create the error object first and then extend the properties anyway, what is adding this function really saving you?

I think it comes down to flavour. I personally think it's more way verbose this code:

var boom = Boom.forbidden( "Username already exists" );
boom.output.payload.errorCode = "duplicatedUsername";
reply( boom );

than this one:

reply( Boom.forbidden("Username already exists.").extendOutput({errorCode: "duplicatedUsername"}) );

Now, as a second thought, the main use case here is, like in the example, to add an internal errorCode. Perhaps the balance between simplicity and expressivity here is to rename the method to .code, which expects a string or an integer. thoughts?

Just openly tell me if u think it's worth adding this method or not, and I'll fix the rest. A no go here is understandable.

[imayolas]

@arb Comments?

[arb]

I think we'll pass on this right now. We can re-examine this if more people ask for it. Doesn't seem useful enough to justify changing the API.

Thanks for contributing. Lots of other things you can do in the hapijs world if you're looking for more open source work 😄

[imayolas]

Thanks @arb. Fully understand. We're building our first project with hapijs and we're very very happy with it. We'll be happy to contribute where we humbly can.

[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.