Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@universal-packages/fs-utils

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@universal-packages/fs-utils

Extended functionality for fs

  • 1.0.1
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

fs Utils

npm version Testing codecov

Extended functionality for fs, when you need to know something in disk exists or want to ensure it exists.

Install

npm install @universal-packages/fs-utils

Global methods

checkDirectory(location: String)

Checks if a string is a valid path to a directory and expands it.

import { checkDirectory } from '@universal-packages/fs-utils'

const finalPath = checkDirectory('./src')

console.log(finalPath)

// > /Users/david/project/src

Any other case is thrown as an error.

import { checkDirectory } from '@universal-packages/fs-utils'

try {
  const finalPath = checkDirectory('./src/fake')
} catch (error) {
  console.log(error)
}

// > Error "/Users/david/project/src/fake" does not exists
// > Error "/Users/david/project/src/fake" is not a directory or can not be accessed
checkFile(location: String)

Checks if a string is a valid path to a file and expands it.

import { checkFile } from '@universal-packages/fs-utils'

const finalPath = checkFile('./src/README.md')

console.log(finalPath)

// > /Users/david/project/src/README.md

Any other case is thrown as an error.

import { checkFile } from '@universal-packages/fs-utils'

try {
  const finalPath = checkFile('./src/NOT.md')
} catch (error) {
  console.log(error)
}

// > Error "/Users/david/project/src/NOT.md" does not exists
// > Error "/Users/david/project/src/NOT.md" is not a file or can not be accessed
ensureDirectory(location: String)

Checks and expand a path and tries to create the directory if the check fails.

import { ensureDirectory } from '@universal-packages/fs-utils'

const finalPath = ensureDirectory('./src/tmp')

console.log(finalPath)

// > /Users/david/project/src/tmp

Any other case is thrown as an error.

import { ensureDirectory } from '@universal-packages/fs-utils'

try {
  const finalPath = ensureDirectory('/new')
} catch (error) {
  console.log(error)
}

// > Error Directory "/new" is an invalid path or greater permisons are reaquired
ensureFile(location: String)

Checks and expand a path and tries to create an empty file if the check fails

import { ensureFile } from '@universal-packages/fs-utils'

const finalPath = ensureFile('./src/tmp/development.log')

console.log(finalPath)

// > /Users/david/project/src/tmp/development.log

Any other case is thrown as an error.

import { ensureFile } from '@universal-packages/fs-utils'

try {
  const finalPath = ensureFile('/file.rb')
} catch (error) {
  console.log(error)
}

// > Error File location "/file.rb" is an invalid path or greater permisons are reaquired
expandPath(location: String)

Tries to expand a path by resolving the tilde and resolving to an absolute path.

import { expandPath } from '@universal-packages/fs-utils'

console.log(expandPath('./src/tmp'))
console.log(expandPath('~/directory'))

// > /Users/david/directory

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

License

MIT licensed.

FAQs

Package last updated on 29 Jan 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc