majo
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Majo

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns Majo

Properties

Optional baseDir

baseDir: undefined | string

Optional dotFiles

dotFiles: undefined | false | true

files

files: object

Type declaration

  • [filename: string]: File

meta

meta: object

Type declaration

  • [k: string]: any

middlewares

middlewares: Middleware[]

Optional onWrite

onWrite: OnWrite

Optional sourcePatterns

sourcePatterns: string[]

Accessors

fileList

fileList:

Methods

createFile

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

  • Parameters

    • relativePath: string
    • file: File

    Returns this

deleteFile

  • deleteFile(relativePath: string): this

  • Parameters

    • relativePath: string

    Returns this

dest

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

  • Parameters

    • dest: string
    • Default value options: DestOptions = {}

    Returns Promise<this>

file

  • file(relativePath: string): File

  • Parameters

    • relativePath: string

    Returns File

fileContents

  • fileContents(relativePath: string): string

  • Parameters

    • relativePath: string

    Returns string

fileStats

  • fileStats(relativePath: string): Stats

  • Parameters

    • relativePath: string

    Returns Stats

filter

  • Parameters

    Returns this

process

  • process(): Promise<this>

  • Returns Promise<this>

rename

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

  • Parameters

    • fromPath: string
    • toPath: string

    Returns this

source

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

  • Parameters

    • patterns: string | string[]
    • Default value options: SourceOptions = {}

    Returns this

transform

  • Parameters

    Returns Promise<void>

use

  • Parameters

    Returns this

writeContents

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

  • Parameters

    • relativePath: string
    • contents: string

    Returns this

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc