fs-gui
Overview
Welcome to the fs-gui
. This package allows you to add file selection menus to your programs. See below to example usage.
How to use
- First you have to install the package using
npm i fs-gui
or fork the repo - You need to
require
it in your code.
const Explorer = require("fs-gui")
- Use the functions below, you can change
Explorer
for whatever you would like.
-
Explorer.searchDir(message)
The
searchDir
function creates a selection menu for selecting a directory.This function returns the path of the directory selected.
The
message
parameter is the message to show the user, [e.g."Select a folder"
]
-
Explorer.searchAll(message)
The
searchAll
function creates a selection menu for selecting all files.This function returns the path to file/directory chosen.
The
message
parameter is the message to show the user, [e.g."Select a file or folder"
]
-
Explorer.searchCustom(message, ext)
The
searchCustom
function creates a selection menu for selecting all files. This function returns the path to file/directory chosenThe
message
parameter is the message to show the user, [e.g."Select a file or folder"
].The
ext
parameter is an array, containing the file extensions. [e.g.[".txt",".pdf"]
] -
Explorer.createFile(data)
The
createFile
functions creates a menu, showing the normal folders, but adds an extra optionCreate File
. Once selectedCreate File
asks for the name and extension. Thedata
parameter is the contents of the file. It must be string. -
Explorer.createCustomFile(data, name)
Similar to
createFile
, but the name is already specified. -
Explorer.createFolder()
The
createFolder
functions creates a menu, showing the normal folders, but adds an extra optionCreate Folder
. Once selectedCreate Folder
asks for the folder name. -
Explorer.deleteFile()
The delete folder function is like the
searchAll
function, but for deleting files -
Explorer.deletFolder()
The delete folder function is like the
searchDir
function, but for deleting folders.
Examples
The examples below are assuming your code has the following line
const Explorer = require("fs-gui")
- If you wanted the user to select a
pdf
file
Explorer.searchCustom("Select a PDF", [".pdf"])
- If you wanted the user to select a directory in the
node_modules
folder
process.chdir("node_modules")
Explorer.searchDir("Select a directory")