close
The Wayback Machine - https://web.archive.org/web/20201001052849/https://github.com/pnpm/fs-locker
Skip to content
This repository has been archived by the owner. It is now read-only.
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

This package was used by pnpm v4 and older versions

@pnpm/fs-locker

An fs locker for pnpm

npm version Build Status

Installation

<pnpm|yarn|npm> add @pnpm/fs-locker

Usage

'use strict'
const lock = require('@pnpm/fs-locker').default
const path = require('path')

const locks = path.resolve('_locks')

lock(process.cwd(), {stale: 100, locks})
  .then(unlock => {
    // do some stuff...
    return unlock() // or unlock.sync()
  })
  .then(() => {
    console.log('folder unlocked')
    //> folder unlocked
  })
  .catch(err => console.error(err))

API

lock(filename, opts) => unlock[.sync]()

Locks the specified file. Returns an async and sync unlock function.

Arguments

  • filename - the file to lock
  • opts.stale - duration in milliseconds in which the lock is considered stale
  • opts.locks - the folder that contains the lock files
  • opts.whenLocked - function that is called if a lock is found when trying to create the lock

License

MIT © Zoltan Kochan

About

An fs locker for pnpm

Resources

License

Packages

No packages published
You can’t perform that action at this time.