Majo | majo

Hierarchy

Majo

Index

Constructors

constructor

Properties

Accessors

fileList

Methods

Constructors

constructor

new Majo(): Majo

- Defined in index.ts:174
Returns Majo

Properties

Optional baseDir

baseDir: undefined | string

Base directory You normally set this by calling .source

Optional dotFiles

dotFiles: undefined | false | true

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

dest

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

- Defined in index.ts:265
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:298
Get a file by relativePath path

Parameters
- relativePath: string
  
  Relative path
Returns File

fileContents

fileContents(relativePath: string): string

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

Parameters
- relativePath: string
  
  Relative path
Returns string

fileStats

fileStats(relativePath: string): Stats

- Defined in index.ts:319
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:248
Filter files

Parameters
- fn: FilterHandler
  
  Filter handler
Returns this

process

process(): Promise<this>

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

Returns Promise<this>

source

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

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

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

use

use(middleware: Middleware): this

- Defined in index.ts:200
Use a middleware

Parameters
- middleware: Middleware
Returns this

Generated using TypeDoc