Majo | majo

Hierarchy

Majo

Index

Constructors

constructor

Properties

Accessors

fileList

Methods

Constructors

constructor

new Majo(): Majo

- Defined in index.ts:74
Returns Majo

Properties

Optional baseDir

baseDir: undefined | string

Base directory You normally set this by calling .source

Optional dotFiles

dotFiles: undefined | false | true

files

files: object

Type declaration

[filename: string]: File

meta

meta: object

An object you can use across middleware to share states

Type declaration

[k: string]: any

middlewares

middlewares: Middleware[]

Optional onWrite

onWrite: OnWrite

Optional sourcePatterns

sourcePatterns: string[]

Accessors

fileList

fileList:

Get an array of sorted file paths

Methods

createFile

createFile(relativePath: string, file: File): this

- Defined in index.ts:245
Create a new file

Parameters
- relativePath: string
  
  Relative path
- file: File
Returns this

deleteFile

deleteFile(relativePath: string): this

- Defined in index.ts:235
Delete a file

Parameters
- relativePath: string
  
  Relative path
Returns this

dest

dest(dest: string, options?: DestOptions): Promise<this>

- Defined in index.ts:172
Run middlewares and write processed files to disk

Parameters
- dest: string
  
  Target directory
- Default value options: DestOptions = {}
Returns Promise<this>

file

file(relativePath: string): File

- Defined in index.ts:227
Get a file by relativePath path

Parameters
- relativePath: string
  
  Relative path
Returns File

fileContents

fileContents(relativePath: string): string

- Defined in index.ts:201
Get file contents as a UTF-8 string

Parameters
- relativePath: string
  
  Relative path
Returns string

fileStats

fileStats(relativePath: string): Stats

- Defined in index.ts:219
Get the fs.Stats object of specified file

para

relativePath Relative path

Parameters
- relativePath: string
Returns Stats

filter

filter(fn: FilterHandler): this

- Defined in index.ts:144
Filter files

Parameters
- fn: FilterHandler
  
  Filter handler
Returns this

process

process(): Promise<this>

- Defined in index.ts:109
Process middlewares against files

Returns Promise<this>

rename

rename(fromPath: string, toPath: string): this

- Defined in index.ts:257
Parameters
- fromPath: string
- toPath: string
Returns this

source

source(patterns: string | string[], options?: SourceOptions): this

- Defined in index.ts:89
Find files from specific directory

Parameters
- patterns: string | string[]
- Default value options: SourceOptions = {}
Returns this

transform

transform(relativePath: string, fn: TransformHandler): Promise<void>

- Defined in index.ts:159
Transform file at given path

Parameters
- relativePath: string
  
  Relative path
- fn: TransformHandler
  
  Transform handler
Returns Promise<void>

use

use(middleware: Middleware): this

- Defined in index.ts:101
Use a middleware

Parameters
- middleware: Middleware
Returns this

writeContents

writeContents(relativePath: string, contents: string): this

- Defined in index.ts:210
Write contents to specific file

Parameters
- relativePath: string
  
  Relative path
- contents: string
Returns this

Generated using TypeDoc