Install

1# use pnpm
2$ pnpm install -D @node-kit/extra.fs
3
4# use yarn
5$ yarn add -D @node-kit/extra.fs
6
7# use npm
8$ npm install -D @node-kit/extra.fs

Usage

use import

1import { cp } from '@node-kit/extra.fs'
2
3cp()

use require

1const { cp } = require('@node-kit/extra.fs')
2
3cp()

API reference

1. cp & cpSync

copy files to new path

• Usage: cp(path, target[, options]) & cpSync(path, target[, options])
• Parameters:

• Types:

1interface CpOptions extends RmDirOptions {
2  force?: boolean
3  silent?: boolean
4}
5
6declare function cp(
7  paths: PathLike | PathLike[],
8  target: PathLike,
9  options: CpOptions = { silent: true, force: true }
10): Promise<void>
11
12declare function cpSync(
13  paths: PathLike | PathLike[],
14  target: PathLike,
15  options: CpOptions = { silent: true, force: true }
16): void

• Demos:

1. copy ./a to ./b

1import { cp, cpSync } from '@node-kit/extra.fs'
2
3cp('./a', './b').then(() => {
4  console.log('copy done')
5})
6// or
7cpSync('./a', './b')

2. copy ./a and ./b to ./c

1import { cp, cpSync } from '@node-kit/extra.fs'
2
3cp(['./a', './b'], './c').then(() => {
4  console.log('copy done')
5})
6// or
7cpSync(['./a', './b'], './c')

2. rm & rmSync

remove files

• Usage: rm(path[, options]) & rmSync(path[, options])
• Parameters:

• Types:

1interface RmOptions extends RmDirOptions {
2  force?: boolean
3  silent?: boolean
4}
5
6declare function rm(
7  paths: PathLike | PathLike[],
8  options: RmOptions = { silent: true, force: true }
9): Promise<void>
10
11declare function rmSync(
12  paths: PathLike | PathLike[],
13  options: RmOptions = { silent: true, force: true }
14): void

• Demos:

1. remove ./a

1import { rm, rmSync } from '@node-kit/extra.fs'
2
3rm('./a', './b').then(() => {
4  console.log('remove done')
5})
6// or
7rmSync('./a', './b')

2. remove ./a and ./b

1import { rm, rmSync } from '@node-kit/extra.fs'
2
3rm(['./a', './b']).then(() => {
4  console.log('remove done')
5})
6// or
7rmSync(['./a', './b'])

3. mv & mvSync

move files to new path

• Usage: mv(path, target[, options]) & mvSync(path, target[, options])
• Parameters:

• Types:

1interface MvOptions extends RmDirOptions {
2  force?: boolean
3  boolean?: boolean
4}
5
6declare function mv(
7  paths: PathLike | PathLike[],
8  target: PathLike,
9  options: MvOptions = { silent: true, force: true }
10): Promise<void>
11
12declare function mvSync(
13  paths: PathLike | PathLike[],
14  target: PathLike,
15  options: MvOptions = { silent: true, force: true }
16): void

• Demos:

1. move ./a to ./b

1import { mv, mvSync } from '@node-kit/extra.fs'
2
3mv('./a', './b').then(() => {
4  console.log('move done')
5})
6// or
7mvSync('./a', './b')

2. move ./a and ./b to ./c

1import { mv, mvSync } from '@node-kit/extra.fs'
2
3mv(['./a', './b'], './c').then(() => {
4  console.log('move done')
5})
6// or
7mvSync(['./a', './b'], './c')

4. readJSON & readJSONSync

read json file

• Usage: readJSON(path[, options]) & readJSONSync(path[, options])
• Parameters:

• Types:

1type ReadJSONOptions = Parameters<typeof promises.readFile>[1]
2
3type ReadJSONSyncOptions = Parameters<typeof promises.readFileSync>[1]
4
5declare function readJSON(
6  ...args: Parameters<typeof promises.readFile>
7): Promise<Record<string, unknown> | null>
8
9declare function readJSONSync(
10  ...args: Parameters<typeof readFileSync>
11): Record<string, unknown> | null

• Demos:

1. read ./a.json

1import { readJSON, readJSONSync } from '@node-kit/extra.fs'
2
3readJSON('./a.json').then(data => {
4  console.log(data)
5})
6// or
7const data = readJSONSync('./a.json')

5. writeJSON & writeJSONSync

write json to file

• Usage: writeJSON(path, data[, options]) & writeJSONSync(path, data[, options])
• Parameters:

• Types:

1type WriteJSONData = Record<string, unknown> | Parameters<typeof promises.writeFile>[1]
2
3type WriteJSONSyncData = Record<string, unknown> | Parameters<typeof promises.writeFileSync>[1]
4
5declare function writeJSON(
6  file: Parameters<typeof promises.writeFile>[0],
7  data: Record<string, unknown> | Parameters<typeof promises.writeFile>[1],
8  options?: WriteFileOptions
9): Promise<void>
10
11declare function writeJSONSync(
12  file: PathOrFileDescriptor,
13  data: Record<string, unknown> | Parameters<typeof writeFileSync>[1],
14  options?: WriteFileOptions
15): void

• Demos:

1. write data to ./a.json

1import { writeJSON, writeJSONSync } from '@node-kit/extra.fs'
2
3writeJSON('./a.json', { name: 'saqqdy' }).then(data => {
4  console.log(data)
5})
6// or
7const data = writeJSONSync('./a.json', { name: 'saqqdy' })

6. getRealPath & getRealPathSync

return the canonicalized absolute pathname

• Usage: getRealPath(path) & getRealPathSync(path)
• Parameters:

• Types:

1declare function getRealPath(path: string): Promise<string>
2
3declare function getRealPathSync(path: string): string

• Demos:

1. simple use

1import { getRealPath, getRealPathSync } from '@node-kit/extra.fs'
2
3getRealPath('./a.json').then(data => {
4  console.log(data)
5})
6// or
7const data = getRealPathSync('./a.json')

Issues & Support

Please open an issue here.

License

MIT