Class MayonakaCustomFolder<TFolder, TFile, TFolderData, TFileData>

Type Parameters

TFolder
TFile
TFolderData
TFileData

Hierarchy (view full)

MayonakaCustomFolder
- MayonakaCustom

Index

Constructors

Properties

commandGraph createFileFn createFolderFn folder opts parentFolder

Methods

addFile addFolder

Constructors

constructor

new MayonakaCustomFolder<TFolder, TFile, TFolderData, TFileData>(createFolderFn, createFileFn, opts?): MayonakaCustomFolder<TFolder, TFile, TFolderData, TFileData>
Type Parameters
- TFolder
- TFile
- TFolderData
- TFileData
Parameters
- 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 MayonakaCustomFolder<TFolder, TFile, TFolderData, TFileData>
- Defined in mayonaka-custom.ts:13

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
- 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
- Defined in mayonaka-custom.ts:24