summaryrefslogtreecommitdiffstats
path: root/node_modules/infer-owner/README.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-18 23:26:45 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-18 23:26:45 +0100
commit81ddf9b700bc48a1f8e472209f080f9c1d9a9b09 (patch)
tree8b959d50c5a614cbf9fcb346ed556140374d4b6d /node_modules/infer-owner/README.md
parent1870f3fdf43707a15fda0f609a021f516f45eb63 (diff)
downloadwebsite_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.tar.gz
website_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.tar.bz2
website_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.zip
rm node_modules
Diffstat (limited to 'node_modules/infer-owner/README.md')
-rw-r--r--node_modules/infer-owner/README.md41
1 files changed, 0 insertions, 41 deletions
diff --git a/node_modules/infer-owner/README.md b/node_modules/infer-owner/README.md
deleted file mode 100644
index 146caf7..0000000
--- a/node_modules/infer-owner/README.md
+++ /dev/null
@@ -1,41 +0,0 @@
-# infer-owner
-
-Infer the owner of a path based on the owner of its nearest existing parent
-
-## USAGE
-
-```js
-const inferOwner = require('infer-owner')
-
-inferOwner('/some/cache/folder/file').then(owner => {
- // owner is {uid, gid} that should be attached to
- // the /some/cache/folder/file, based on ownership
- // of /some/cache/folder, /some/cache, /some, or /,
- // whichever is the first to exist
-})
-
-// same, but not async
-const owner = inferOwner.sync('/some/cache/folder/file')
-
-// results are cached! to reset the cache (eg, to change
-// permissions for whatever reason), do this:
-inferOwner.clearCache()
-```
-
-This module endeavors to be as performant as possible. Parallel requests
-for ownership of the same path will only stat the directories one time.
-
-## API
-
-* `inferOwner(path) -> Promise<{ uid, gid }>`
-
- If the path exists, return its uid and gid. If it does not, look to
- its parent, then its grandparent, and so on.
-
-* `inferOwner(path) -> { uid, gid }`
-
- Sync form of `inferOwner(path)`.
-
-* `inferOwner.clearCache()`
-
- Delete all cached ownership information and in-flight tracking.