Interface Flexi

Hierarchy

Flexi

Index

Properties

concat empty exists isEmpty isRoot path pathString root walk

Properties

concat

concat: ((path, ...paths) => FlexiPath)

Type declaration

- (path, ...paths): FlexiPath
- Concatinates multiple paths into a new path
  Parameters
  - path: Path
  - Rest ...paths: Path[]
  Returns FlexiPath

empty

empty: (() => FlexiPath)

Type declaration

- (): FlexiPath
- Represents an empty path
  
  Returns FlexiPath

exists

exists: ((path) => boolean)

Type declaration

- (path): boolean
- boolean value indicating if the path exists or not
  Parameters
  - path: Path
  Returns boolean

isEmpty

isEmpty: ((path) => boolean)

Type declaration

- (path): boolean
- boolean value indicating if the path is [[empty]] or not
  Parameters
  - path: Path
  Returns boolean

isRoot

isRoot: ((path) => boolean)

Type declaration

- (path): boolean
- Indicates if the path is [[root]] or not
  Parameters
  - path: Path
  Returns boolean

path

path: ((path) => FlexiPath)

Type declaration

- (path): FlexiPath
- creates a new path
  Parameters
  - path: Path
    
    A path to a file, directory or any arbitrary path
  Returns FlexiPath
  The parsed FlexiPath
  Example
```
import flexi from "flexi";

const path = flexi.path("any path");
```

pathString

pathString: ((path) => string)

Type declaration

- (path): string
- Returns the string path of a path
  Parameters
  - path: Path
  Returns string

root

root: (() => FlexiPath)

Type declaration

- (): FlexiPath
- A path representing the root path
  
  Returns FlexiPath

walk

walk: Walker

Generated using TypeDoc