Getting Started

Installation

Use your favourite package manager to install the module from @abw/badger-filesystem.

npm

npm add @abw/badger-filesystem

pnpm

pnpm add @abw/badger-filesystem

yarn

yarn add @abw/badger-filesystem

Basic Use

Import the file() and/or dir() functions using ESM syntax.

import { file, dir } from '@abw/badger-filesystem'

Or via require() if you're still using Common JS format.

const { file, dir } = require('@abw/badger-filesystem')

Create a Directory object using the dir() function.

const config = dir('config')

Create a File object using the file() function.

const hello = file('config/hello.txt')
// write to the file
await hello.write('Hello World!')
// read from the file
const message = await hello.read()

Do the Happy Badger Dance

You are now all set to do the Happy Badger Dance