Skip to content

wrote/exists

Repository files navigation

@wrote/exists

npm version

@wrote/exists Checks If The File Or Directory Exists, And Return Stats.

yarn add -E @wrote/exists

Table Of Contents

API

The package is available by importing its default function:

import exists from '@wrote/exists'

async exists(
  path: string,
): boolean

Returns whether the path exists or not. If it exists, returns the lstat result, otherwise returns null.

/* yarn example/ */
import exists from '@wrote/exists'

(async () => {
  const res = await exists('example')
  const isDir = res.isDirectory()
  console.log(
    'example exists: %s, is dir: %s', !!res, isDir,
  )
  const res2 = await exists('hello')
  console.log('hello exists: %s', res2)
})()
example exists: true, is dir: true
hello exists: null

Copyright

Art Deco © Art Deco for Wrote 2019 Wrote Tech Nation Visa Tech Nation Visa Sucks

About

Check If The File Or Directory Exists, And Return Stats.

Resources

License

Stars

Watchers

Forks

Packages

No packages published