Neverending Puppy Marathon

    fslockjs

    2.0.2 • Public • Published

    FSLockJS

    NPM Version Build Status

    Easy to use file system queue with locking and events. Provide Asynchronous utilities for Directories and File

    This library's goal is to provide nothing than a easy way to wait for the asynchronous execution of a FS operation in a lock environment.

    Table of Contents

    Installation

    npm install fslock

    Usage

    mkdir myproject
    cd myproject
    npm init
    npm install fslock
    touch index.js
    

    And there just use that snipets to start playing ! :

    const {FSLock, File, Directory} = require('fslockjs');
    const queue = new FSLock();
    
    const start = async function () {
      const doc = {_id:'507f1f77bcf86cd799439011',name:"Alex", age:28};
      const doc2 = {_id:'507f1f77bcf86cd799439011',name:"Alex", age:27};
      const job = queue.add('File.create','.db/507f1f77bcf86cd799439011.json',doc);
      const job2 = queue.add('File.overwrite','.db/507f1f77bcf86cd799439011.json',doc2);
      const job3 = queue.add('File.read','.db/507f1f77bcf86cd799439011.json');
    
      await job3.execution();
      console.log(job3.results===doc2) //true
      
      const isExisting = await File.exists('.db/507f1f77bcf86cd799439011.json')//true
    }
    start();

    Alternatively, you could suppress the autoexec, and deal with it this way

      const queue = new FSLock({autoexec:false});
      const doc = {_id:'507f1f77bcf86cd799439011',name:"Alex", age:28};
      queue.add('File.create','.db/507f1f77bcf86cd799439011.json',doc);
      const job = queue.add('File.read','.db/507f1f77bcf86cd799439011.json');
    
      await queue.processNext();
      await queue.processNext();
      console.log(job.results===doc) //true

    Also, we provide events on job

      const queue = new FSLock({autoexec:false});
      const doc = {_id:'507f1f77bcf86cd799439011',name:"Alex", age:28};
      queue.add('File.create','.db/507f1f77bcf86cd799439011.json',doc);
      const job = queue.add('File.read','.db/507f1f77bcf86cd799439011.json');
      job.on('executed',()=>{
        console.log(job.results);
        console.log(job.results===doc) //true
      });
      queue.start();

    Documentation

    FAQ :

    Why ?

    Because of being able to do await job.execution()

    Which end up being a nice way to wait for the resolvement of a FS Job in concurrent conditions

    const job = await this.queue.add('File.exists', path).execution(); 
    const isExistingFile = job.results;

    Alternatively equal to this below, that will only returns results when having it.

    const results = await this.queue.add('File.exists', path).getResults(); 

    Caveat ?

    Right now, an instance of FSLock only deal locally with the locks. If needed, we can make two instance working together with using real os lock.
    Submit issue if you need such features.

    Install

    npm i fslockjs

    DownloadsWeekly Downloads

    11

    Version

    2.0.2

    License

    MIT

    Unpacked Size

    38.7 kB

    Total Files

    48

    Last publish

    Collaborators

    • alex-werner