vibedrive / managed-folder

:open_file_folder: emit namespaced events with a when the files inside a managed subfolder change

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

managed-folder

Create subfolders inside a given folder and emit a namespaced event when a change happens inside any of them.

Currently handles 3 types of events: add, remove, change. Can be passed a map of namespace to folder name as an option.

// default subfolder map (namespace -> folder name)
{
  inbox: 'Inbox'
}

usage

var Folder = require('managed-folder')
var opts = {
  appdir: '/Users/kareniel/Vibedrive',
  subfolders: { inbox: 'Inbox' }
}

var folder = Folder(opts)

folder.on('ready', function () {
  folder.on('inbox:add' function (filepath) {
    console.log('file added to inbox folder:', filepath)
  })
})

api

folder.on(eventName, callback) register an event handler. events are named after the subfolder's key followed by add, remove or change ie: mySubfolder:add

folder.subfolder(key) return the full path to a given subfolder key


if used from the command line you can pass opts either

  1. through cli arguments
node managed-folder --appdir /Users/kareniel/Vibedrive

or

  1. with a config file (/.config)
appdir=/Users/kareniel/Vibedrive

About

:open_file_folder: emit namespaced events with a when the files inside a managed subfolder change

License:Apache License 2.0


Languages

Language:JavaScript 100.0%