Global API

Here are the global api methods and their types. I'll add more explanation/organization soooooon :D

Note: These are all proxied/lazy loaded. They won't be "required" until you actually invoke the method.

cd: typeof shelljs.cd
cp: typeof shelljs.cp
chmod: typeof shelljs.chmod
echo: typeof shelljs.echo
exec: typeof shelljs.exec
exit: typeof shelljs.exit
grep: typeof shelljs.grep
ln: typeof shelljs.ln
ls: typeof shelljs.ls
mkdir: typeof shelljs.mkdir
mv: typeof shelljs.mv
sed: typeof shelljs.sed
tempdir: typeof shelljs.tempdir
test: typeof shelljs.test
which: typeof shelljs.which
rm: typeof trashType //use `trash` instead
spawn: typeof child_process.spawn
spawnSync: typeof child_process.spawnSync
fork: typeof child_process.fork

get: AxiosInstance["get"]
put: AxiosInstance["put"]
post: AxiosInstance["post"]
patch: AxiosInstance["patch"]

readFile: typeof fsPromises.readFile
writeFile: typeof fsPromises.writeFile
appendFile: typeof fsPromises.appendFile
createWriteStream: typeof fs.createWriteStream
readdir: typeof fsPromises.readdir

compile: typeof handlebars.compile_

cwd: typeof process.cwd
pid: typeof process.pid
stderr: typeof process.stderr
stdin: typeof process.stdin
stdout: typeof process.stdout
uptime: typeof process.uptime

path: typeof import("path")

_: LoDashStatic

uuid: typeof uuidType.v4
chalk: ChalkFunction
paste: typeof clipboardy.read
copy: typeof clipboardy.write

db: DB

trash: typeof trashType

wait: Wait

home: Path
isFile: IsCheck
isDir: IsCheck
isBin: IsCheck

tmp: Path
inspect: Inspect

compileTemplate: CompileTemplate

md: Markdown

applescript: AppleScript

setPlaceholder: SetAppProp
setPanel: SetAppProp
setHint: SetAppProp
setInput: SetAppProp
setIgnoreBlur: SetAppProp
setChoices: (choices: Choices<any>) => void

sendResponse: (value: any) => void


show: ShowAppWindow
showImage: ShowAppWindow

edit: Edit

terminal: (script: string) => Promise<string>
iterm: (iterm: string) => Promise<string>


notify: typeof notifyType

Discuss Post