MajoContext | majo

Hierarchy

MajoContext

Index

Constructors

constructor

Accessors

fileList

Methods

Constructors

constructor

new MajoContext(majo: Majo, files: Map<string, File>): MajoContext

- Defined in index.ts:58
Parameters
- majo: Majo
- files: Map<string, File>
Returns MajoContext

Accessors

fileList

fileList:

Get an array of sorted file paths

Methods

createFile

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

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

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

deleteFile

deleteFile(relativePath: string): this

- Defined in index.ts:121
Delete a file

Parameters
- relativePath: string
  
  Relative path
Returns this

file

file(relativePath: string): File

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

Parameters
- relativePath: string
  
  Relative path
Returns File

fileContents

fileContents(relativePath: string): string

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

Parameters
- relativePath: string
  
  Relative path
Returns string

fileStats

fileStats(relativePath: string): Stats

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

para

relativePath Relative path

Parameters
- relativePath: string
Returns Stats

rename

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

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

transform

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

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

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

writeContents

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

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

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

Generated using TypeDoc