WebRequest

Web request reader.

This reader is used by the Web handler to query values from a request.

This reader supports all serializable inputs. It deals with file uploads automatically; therefore any FilePath input becomes a potential upload field. When that is the case the input gets assigned with the file path about where the file has been uploaded to. By default it tries to keep the original uploaded file name by replacing any illegal character with underscore, however you can control this behavior via uploadPreserveName (if disabled each uploaded file gets named with an unique name).

This reader works by looking for the input names in the request, for instance:

http://.../?myInput=10&myOtherInput=20

class MyAction extends Mebo.Action {
  constructor(){
    super();
    this.createInput('myInput: numeric');
    this.createInput('myOtherInput: numeric');
  }
}

When a value is found for the input, it gets loaded via Input.parseValue where each input implementation has its own way of parsing the serialized data, to find out about how a value is serialized for an specific input type you could simply set an arbitrary value to the input you are interested then query it back through Input.serializeValue. Also, Mebo provides a reference datasheet about the serialization forms for the inputs bundled with it, found at Reader.

As supported for the cli handler (--help/-h) you can also query a basic help page for any action through the web handler by including: help to the query string: http://.../?help By doing that it renders a page with the description of the action and helpful information about the inputs. This setting is available through handler/web/allowHelp (default true).

You can define the description displayed in the help of each input by setting the input's property description. Also, the description for the action itself can be defined by setting the action's metadata description.

Route parameters: If an webfied action contains route parameters defined (/users/:userId/books/:bookId) this reader is going to try to find them under the action input names. Therefore when a route parameter matches to the name of an input then the value of the parameter is loaded to the input.

Vector Inputs: Supported conventions for array parameters:

• Serialized vector value (JSON Style)

  http://.../?vectorInput=["a", "b", "c"]
  

• Repeated param names

  http://.../?vectorInput[]=a&vectorInput[]=b&vectorInput[]=c
  

  or

  http://.../?vectorInput=a&vectorInput=b&vectorInput=c
  

Options Summary

Example about defining a custom uploadDefaultMaxFileSize option from inside of an action through the metadata support:

class MyAction extends Mebo.Action{
   constructor(){
     super();

     // 'uploadDefaultMaxFileSize' option
     this.setMeta('handler.web.readOptions', {
       uploadDefaultMaxFileSize: 10 * 1024 * 1024,
     });
   }
}