Install

``bash


use pnpm

$ pnpm install -D @node-kit/extra.fs

use yarn

$ yarn add -D @node-kit/extra.fs

use npm

$ npm install -D @node-kit/extra.fs
`

Usage

use import

`js
import { cp } from '@node-kit/extra.fs'

cp()
`

use require

`js
const { cp } = require('@node-kit/extra.fs')

cp()
`

API reference

$3

copy files to new path

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

- Types:

`ts
interface CpOptions extends RmDirOptions {
force?: boolean
silent?: boolean
}

declare function cp(
paths: PathLike | PathLike[],
target: PathLike,
options: CpOptions = { silent: true, force: true }
): Promise

declare function cpSync(
paths: PathLike | PathLike[],
target: PathLike,
options: CpOptions = { silent: true, force: true }
): void
`

- Demos:

1. copy ./a to ./b

`ts
import { cp, cpSync } from '@node-kit/extra.fs'

cp('./a', './b').then(() => {
console.log('copy done')
})
// or
cpSync('./a', './b')
`

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

`ts
import { cp, cpSync } from '@node-kit/extra.fs'

cp(['./a', './b'], './c').then(() => {
console.log('copy done')
})
// or
cpSync(['./a', './b'], './c')
`

$3

remove files

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

- Types:

`ts
interface RmOptions extends RmDirOptions {
force?: boolean
silent?: boolean
}

declare function rm(
paths: PathLike | PathLike[],
options: RmOptions = { silent: true, force: true }
): Promise

declare function rmSync(
paths: PathLike | PathLike[],
options: RmOptions = { silent: true, force: true }
): void
`

- Demos:

1. remove ./a

`ts
import { rm, rmSync } from '@node-kit/extra.fs'

rm('./a', './b').then(() => {
console.log('remove done')
})
// or
rmSync('./a', './b')
`

2. remove ./a and ./b

`ts
import { rm, rmSync } from '@node-kit/extra.fs'

rm(['./a', './b']).then(() => {
console.log('remove done')
})
// or
rmSync(['./a', './b'])
`

$3

move files to new path

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

- Types:

`ts
interface MvOptions extends RmDirOptions {
force?: boolean
boolean?: boolean
}

declare function mv(
paths: PathLike | PathLike[],
target: PathLike,
options: MvOptions = { silent: true, force: true }
): Promise

declare function mvSync(
paths: PathLike | PathLike[],
target: PathLike,
options: MvOptions = { silent: true, force: true }
): void
`

- Demos:

1. move ./a to ./b

`ts
import { mv, mvSync } from '@node-kit/extra.fs'

mv('./a', './b').then(() => {
console.log('move done')
})
// or
mvSync('./a', './b')
`

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

`ts
import { mv, mvSync } from '@node-kit/extra.fs'

mv(['./a', './b'], './c').then(() => {
console.log('move done')
})
// or
mvSync(['./a', './b'], './c')
`

$3

read json file

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

- Types:

`ts
type ReadJSONOptions = Parameters[1]

type ReadJSONSyncOptions = Parameters[1]

declare function readJSON(
...args: Parameters
): Promise | null>

declare function readJSONSync(
...args: Parameters
): Record | null
`

- Demos:

1. read ./a.json

`ts
import { readJSON, readJSONSync } from '@node-kit/extra.fs'

readJSON('./a.json').then(data => {
console.log(data)
})
// or
const data = readJSONSync('./a.json')
`

$3

write json to file

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

- Types:

`ts
type WriteJSONData = Record | Parameters[1]

type WriteJSONSyncData = Record | Parameters[1]

declare function writeJSON(
file: Parameters[0],
data: Record | Parameters[1],
options?: WriteFileOptions
): Promise

declare function writeJSONSync(
file: PathOrFileDescriptor,
data: Record | Parameters[1],
options?: WriteFileOptions
): void
`

- Demos:

1. write data to ./a.json

`ts
import { writeJSON, writeJSONSync } from '@node-kit/extra.fs'

writeJSON('./a.json', { name: 'saqqdy' }).then(data => {
console.log(data)
})
// or
const data = writeJSONSync('./a.json', { name: 'saqqdy' })
`

$3

return the canonicalized absolute pathname

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

- Types:

`ts
declare function getRealPath(path: string): Promise

declare function getRealPathSync(path: string): string
`

- Demos:

1. simple use

`ts
import { getRealPath, getRealPathSync } from '@node-kit/extra.fs'

getRealPath('./a.json').then(data => {
console.log(data)
})
// or
const data = getRealPathSync('./a.json')
``

Issues & Support

Please open an issue here.

License

MIT

[npm-image]: https://img.shields.io/npm/v/@node-kit/extra.fs.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@node-kit/extra.fs
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/@node-kit/extra.fs/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/@node-kit/extra.fs&utm_campaign=Badge_Grade
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/@node-kit/extra.fs.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/@node-kit/extra.fs?branch=master
[download-image]: https://img.shields.io/npm/dm/@node-kit/extra.fs.svg?style=flat-square
[download-url]: https://npmjs.org/package/@node-kit/extra.fs
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_node-kit
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_node-kit