Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMustr

Hierarchy

  • IMustr

Implemented by

Index

Properties

Engine

Engine: Object

components

components: IMap<IComponent>

cwd

cwd: string

log

log: ILogger

options

options: IMustrOptions

outputPath

outputPath: string

registerPath

registerPath: string

renderer

renderer: RenderMethod

templates

templates: IMap<ITemplate>

templatesGlob

templatesGlob: string[]

templatesPath

templatesPath: string

Methods

configure

  • Parameters

    Returns ITemplate

  • Parameters

    • name: string
    • output: string
    • group: string

    Returns any

  • Parameters

    Returns ITemplate

getRollbacks

  • Parameters

    • Optional display: boolean

    Returns IMap<IRollbackStat>

init

  • init(force?: boolean): void
  • Parameters

    • Optional force: boolean

    Returns void

inject

  • Parameters

    Returns void

  • Parameters

    • filename: string | IInject
    • find: string | RegExp | NodeCallback
    • insert: string | string[]
    • strategy: "before" | "after" | "first" | "last" | "replace"
    • Optional done: NodeCallback

    Returns void

load

  • Returns IMustr

loadRollbacks

  • loadRollbacks(reindex?: boolean): IMustr
  • Parameters

    • Optional reindex: boolean

    Returns IMustr

register

registerComponent

  • registerComponent(name: string, series: boolean): IMustr
  • registerComponent(name: string, ...args: string[]): IMustr
  • Parameters

    • name: string
    • series: boolean

    Returns IMustr

  • Parameters

    • name: string
    • Rest ...args: string[]

    Returns IMustr

removeRollbacks

  • removeRollbacks(by: string | number | Date, save?: boolean): IMustr
  • Parameters

    • by: string | number | Date
    • Optional save: boolean

    Returns IMustr

render

rollback

  • rollback(name?: string, output?: string): IMustr
  • Parameters

    • Optional name: string
    • Optional output: string

    Returns IMustr

saveRollbacks

  • saveRollbacks(prune?: boolean): IMustr
  • Parameters

    • Optional prune: boolean

    Returns IMustr

setEngine

  • Parameters

    Returns any

transformCase

  • transformCase(str: string, to: string): string
  • Parameters

    • str: string
    • to: string

    Returns string

Generated using TypeDoc