Documentation

Module: arpen/services/filer

File operations service

Classes

Filer

Type Definitions

BufferFileUpdater(buffer)

Buffer updater callback
Parameters:
Name Type Description
buffer Buffer Previous file contents (Buffer)
Returns:
Returns promise resolving to new file contents (Buffer)
Type
Promise

StringFileUpdater(contents)

String updater callback
Parameters:
Name Type Description
contents string Previous file contents (string)
Returns:
Returns promise resolving to new file contents (string)
Type
Promise

ProcessFileCallback(filename)

Callback for processing a file
Parameters:
Name Type Description
filename string Path of the file
Returns:
Should return a Promise, if resolves to false processing is terminated
Type
Promise

ProcessDirCallback(filename)

Callback for processing a directory
Parameters:
Name Type Description
filename string Path of the file
Returns:
Should return a Promise resolving to true if directory needs processing
Type
Promise