knight-path v1.0.3

Knight Path by Coderitter

Install

npm install knight-path

Overview

Create

import { Path } from 'knight-path'

new Path('path/to/something')
new Path('path', 'to', 'something')
new Path('path', 'to/something')

let path = new Path('path/to/something')
path.path = 'path/to/something'
path.parts == ['path', 'to', 'something']

let otherPath = new Path(path, 'which/is', 'awesome')
otherPath.path == 'path/to/something/which/is/awesome'
otherPath.parts == ['path', 'to', 'something', 'which', 'is', 'awesome']

let rootPath = new Path('/path/to/something')
rootPath.path == '/path/to/something'
rootPath.parts == ['/', 'path', 'to', 'something']

let dotsPath = new Path('some/path', '..', 'other/path')
dots.path == 'some/other/path'
dots.parts == ['some', 'path', '..', 'other/path']

path.length == 3

Change

let path = new Path('some/path')

path.parts = ['some', 'other', 'path']
path.path = 'some/other/path'
path.setPath('some', new Path('other'), 'path'))

Path

path.equals('in/any/directory') == true
path.startsWith('in/any') == true
path.endsWith('any/directory') == true
path.indexOf('any/directory') == 1

path.prepend('in')
path.prependToNew('in')
path.parts == 'in/some/directory'

path.append('for/content')
path.appendToNew('for/content')
path.path == 'in/some/directory/for/content'

path.insert(4, 'awesome')
path.insertToNew(4, 'awesome')
path.path == 'in/some/directory/for/awesome/content'

path.subtract('for/awesome/content')
path.subtractToNew('for/awesome/content')
path.path == 'in/some/directory'

path.replace('some', 'any')
path.replaceToNew('some', 'any')
path.path == 'in/any/directory'

Directory

let dir = new Path('some/directory')

dir.exists()
dir.isDir()

dir.mkDir() // creates the whole file path if not exists
dir.delete() // deletes the whole directory including its contents and sub contents
dir.copyTo(new Path('to/another/directory')) // copies the directory
dir.copyFilesTo(new Path('to/another/directory')) // copies the files inside the directory

let recursive = true
dir.iterateFiles((file: Path) => { ... }, recursive)

for (let path of dir.readDir()) {
  // iterate through directories and files
}

File

let file = new Path('some/directory/awesome.file')

file.exists()
file.isFile()

file.filename == 'awesome.file'
file.extension == '.file'
file.filenameWithoutExtension == 'awesome'
file.dir == 'some/directory'
file.dirPath == new Path('some/directory')

file.filename = 'amazing.file'
file.path = 'some/directory/amazing.file'

file.extension = 'ext'
file.extension = '.ext'
file.path == 'some/directory/amazing.ext'

file.filenameWithoutExtension = 'awesome'
file.path == 'some/directory/awesome.ext'

file.dir = 'some/other/directory'
file.path == 'some/other/directory/awesome.ext'

file.size()
file.touch()
let buffer = file.readFile()
let utf8 = file.readFileAsUtf8()
file.writeFile('some content')
file.prependToFile('something before')
file.appendToFile('something after')

// if directory is a directory it will append the file
file.copyTo(new Path('into/another/directory'))
// if a file.ext is not a directory it will assume it as the filename
file.copyTo(new Path('into/another/directory/file.ext'))

file.copyFilesTo(new Path('into/another/directory')) // does the same as copyTo
file.copyFilesTo(new Path('into/another/directory/file.ext')) // does the same as copyTo

file.delete()

import * as fs from 'fs'
let writeStream: fs.WriteStream = file.writeStream({ flags: 'a' }) // creates a Node fs.WriteStream in append mode
let readStream: fs.ReadStream = file.readStream() // creates a Node fs.ReadStream