https://github.com/isaacs/infer-owner
Infer the owner of a path based on the owner of its nearest existing parent
https://github.com/isaacs/infer-owner
npm-cli
Last synced: over 1 year ago
JSON representation
Infer the owner of a path based on the owner of its nearest existing parent
- Host: GitHub
- URL: https://github.com/isaacs/infer-owner
- Owner: isaacs
- License: isc
- Created: 2019-07-19T22:16:36.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2022-10-15T01:23:16.000Z (over 3 years ago)
- Last Synced: 2025-03-09T07:23:07.701Z (over 1 year ago)
- Topics: npm-cli
- Language: JavaScript
- Homepage:
- Size: 72.3 KB
- Stars: 6
- Watchers: 10
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.