Class MayonakaCustom<TFolder, TFile, TFolderData, TFileData>

Type Parameters

TFolder
TFile
TFolderData = any
TFileData = any

Hierarchy (view full)

MayonakaCustomFolder<TFolder, TFile, TFolderData, TFileData>
- MayonakaCustom

Index

Constructors

Properties

commandGraph createFileFn createFolderFn folder opts parentFolder

Methods

addFile addFolder build

Constructors

constructor

new MayonakaCustom<TFolder, TFile, TFolderData, TFileData>(root, createFolderFn, createFileFn, opts?): MayonakaCustom<TFolder, TFile, TFolderData, TFileData>
Type Parameters
- TFolder
- TFile
- TFolderData = any
- TFileData = any
Parameters
- root: null | TFolder
- createFolderFn: ((parentFolder: null | TFolder, data: TFolderData) => Promise<TFolder>)
  - - (parentFolder, data): Promise<TFolder>
    - Parameters
      parentFolder: null | TFolder
      data: TFolderData
      Returns Promise<TFolder>
- createFileFn: ((parentFolder: null | TFolder, data: TFileData) => Promise<void>)
  - - (parentFolder, data): Promise<void>
    - Parameters
      parentFolder: null | TFolder
      data: TFileData
      Returns Promise<void>
- Optionalopts: MayonakaCustomOptions
Returns MayonakaCustom<TFolder, TFile, TFolderData, TFileData>
Overrides MayonakaCustomFolder.constructor
- Defined in mayonaka-custom.ts:60

Properties

`Protected`commandGraph

commandGraph: CommandNode<AsyncCommand>[]

`Protected`createFileFn

createFileFn: ((parentFolder: null | TFolder, data: TFileData) => Promise<void>)

`Protected`createFolderFn

createFolderFn: ((parentFolder: null | TFolder, data: TFolderData) => Promise<TFolder>)

`Protected`folder

folder: null | TFolder = null

`Protected`opts

opts: MayonakaCustomOptions

`Protected`parentFolder

parentFolder: null | MayonakaCustomFolder<TFolder, TFile, TFolderData, TFileData> = null

Methods

addFile

addFile(dataProvider): this
Parameters
- dataProvider: (() => Promise<TFileData>)
  - - (): Promise<TFileData>
    - Returns Promise<TFileData>
Returns this
Inherited from MayonakaCustomFolder.addFile
- Defined in mayonaka-custom.ts:35

addFolder

addFolder(data, callback): this
Parameters
- data: TFolderData
- callback: ((folder: MayonakaCustomFolder<TFolder, TFile, TFolderData, TFileData>) => void)
  - - (folder): void
    - Parameters
      folder: MayonakaCustomFolder<TFolder, TFile, TFolderData, TFileData>
      Returns void
Returns this
Inherited from MayonakaCustomFolder.addFolder
- Defined in mayonaka-custom.ts:24

build

build(): Promise<null | TFolder>
Returns Promise<null | TFolder>
- Defined in mayonaka-custom.ts:72