Documentation for Simbo's Packages
    Preparing search index...

    Module @simbo/accessible - v1.0.1

    Accessible

    📦 @simbo/accessible

    A lightweight utility library that provides reliable checks for file system accessibility.

    It helps you determine whether files or directories are existing, readable, writable, or executable — with a simple, async-first API.

    • Check if a file or directory exists

    • Verify if a path is readable, writable, or executable

    • Minimal and dependency-free

    • Fully typed TypeScript API

    Install @simbo/accessible from the npm registry:

    npm i [-D] @simbo/accessible
    

    For a complete API reference, see the documentation.

    Use the provided functions in your code:

    import { isReadableFile, isWritableDirectory } from '@simbo/accessible';

    if (await isReadableFile('path/to/file')) {
    console.log('File is readable');
    }

    if (await isWritableDirectory('path/to/directory')) {
    console.log('Directory is writable');
    }

    MIT © Simon Lepel

    Functions

    isAccessible
    isDirectory
    isExecutableDirectory
    isExecutableFile
    isFile
    isReadableDirectory
    isReadableFile
    isWritableDirectory
    isWritableFile