Module : file

Module overview

This module contains services that register listeners against a local folder and identify events that create, modify, and delete files.

Samples

The sample given below shows how a Listener is used to listen to the local folder. The onCreate() resource method gets invoked when a file is created inside the target/fs folder. Use the onDelete() and onModify() methods to listen to the delete and modify events.

import ballerina/file;

listener file:Listener localFolder = new ({
    path: "target/fs",
    recursive: false
});

service fileSystem on localFolder {

    resource function onCreate(file:FileEvent m) {
    
    }
}

Records

FileEvent Represents an event which will trigger when there is a changes to listining direcotry.
ListenerConfig Represents configurations that required for directory listener.

Listeners

Listener

Represents directory listener endpoint where used to listen to a directory in the local file system.