File Reader


Stuff You Need to Know

This component reads a file from file system.


How to Configure

Component-specific settings:

This component can be configured in one of two ways. You can send it data from the incoming component, or you can configure it in the Settings.

  • Filename (field) - The filename entered should be relative to application root. Please note that if the incoming components sends 'path', then this value will be ignored.
  • Read as (droplist) - Select either Buffer to stream the file as a buffer into the circuit; or Text to read the file as a text file.
  • Encoding (field) - This field is only used when 'Read as' is 'Text'. The default encoding is utf8. Read more about text file encoding here.

Standard settings:

Click here to view information on standard settings.


What Happens Next

Example of incoming object
{ 
    path: '/public/robots.txt', 
    type: 'text', // optional, default text 
    encoding: 'utf8' // optional, default utf8
}