error_from_app: return an error from a Rook app

View source: R/error_from_app.R

error_from_appR Documentation

return an error from a Rook app

Description

This function is called to generate an in-band error reply to the API request. The remote requestor will still receive a bzip2-compressed JSON-formatted object, but that object will have a single field named "error", whose value is the string passed to this function.

Usage

error_from_app(error, ...)

Arguments

error

character scalar error message to return to app caller

...

additional parameters describing the error. These are JSON-encoded into the API response.

Details

Objects returned from successful API calls never include a top-level field called "error".

Value

Similar to the return value from


MotusWTS/motusServer documentation built on April 12, 2025, 2:34 p.m.