\mmir-tooling\view | mmir Tools and Plugins v7.0.0-beta1

Index

Variables

Functions

compile

Variables

Const _default

_default: { compile: typeof compile }

Type declaration

compile: typeof compile

Const _default

_default: { addViewsToAppConfig: (views: ViewEntry[], ctrls: ImplementationBuildEntry[], appConfig: BuildAppConfig | WebpackAppConfig, directories: DirectoriesInfo, resources: ResourceConfig, _runtimeConfiguration: RuntimeConfiguration) => void; applyDefaultOptions: (options: ViewBuildOptions, viewList: ViewEntry[]) => ViewEntry[]; viewTemplatesFromDir: (dir: string, appRootDir: string, options?: ViewBuildOptions) => ViewBuildEntry[] }

Type declaration

addViewsToAppConfig: (views: ViewEntry[], ctrls: ImplementationBuildEntry[], appConfig: BuildAppConfig | WebpackAppConfig, directories: DirectoriesInfo, resources: ResourceConfig, _runtimeConfiguration: RuntimeConfiguration) => void

add views to (webpack) app build configuration

param

list of ViewEntry objects: view.id {String}: the view id view.file {String}: the path to the eHTML view template (from which the executable view will be created)

param

list of ControllerEntry objects: ctrl.id {String}: the controller id

param

the app configuration to which the views will be added

param

the directories.json representation

param

the resources configuration

param

the configuration.json representation
- - (views: ViewEntry[], ctrls: ImplementationBuildEntry[], appConfig: BuildAppConfig | WebpackAppConfig, directories: DirectoriesInfo, resources: ResourceConfig, _runtimeConfiguration: RuntimeConfiguration): void
  - Parameters
    - views: ViewEntry[]
    - ctrls: ImplementationBuildEntry[]
    - appConfig: BuildAppConfig | WebpackAppConfig
    - directories: DirectoriesInfo
    - resources: ResourceConfig
    - _runtimeConfiguration: RuntimeConfiguration
    Returns void
applyDefaultOptions: (options: ViewBuildOptions, viewList: ViewEntry[]) => ViewEntry[]

apply the "global" options from options or default values to the entries from viewList if its corresponding options-field is not explicitly specified.

param

the view options

param

returns
- - (options: ViewBuildOptions, viewList: ViewEntry[]): ViewEntry[]
  - Parameters
    - options: ViewBuildOptions
    - viewList: ViewEntry[]
    Returns ViewEntry[]
viewTemplatesFromDir: (dir: string, appRootDir: string, options?: ViewBuildOptions) => ViewBuildEntry[]
add views from a base-directory that adheres to the structure:
```
//view1.ehtml
                         /view2.ehtml
                         ...
//view1.ehtml
                         /view2.ehtml
                         ...
...
/layouts/default.ehtml
             /.ehtml
             ...
```
param

the direcotry from which to parse/collect the views

param

the root directory of the app (against which relative paths will be resolved)

param

OPTIONAL unsupported TODO

returns

a list of ViewEntry objects: { id: String ctrlName: String, viewName: String, file: String, viewImpl: 'mmirf/layout' | 'mmirf/partial' | 'mmirf/view', isLayout: Boolean isPartial: Boolean }
- - (dir: string, appRootDir: string, options?: ViewBuildOptions): ViewBuildEntry[]
  - Parameters
    - dir: string
    - appRootDir: string
    - Optional options: ViewBuildOptions
    Returns ViewBuildEntry[]

Functions

compile

compile(content: string, viewFile: string, options: ViewCompilerOptions, callback: CompilerCallback, _map: any, _meta: any): void

- Defined in mmir-tooling/view/view-gen.d.ts:12
compile view defintion (eHTML) into an executable JS view

Parameters
- content: string
  
  the view definition (eHTML) as string
- viewFile: string
  
  the path of the view file (for debugging/error information)
- options: ViewCompilerOptions
  
  the ViewLoadOptions with property mapping (list of ViewOptions)
- callback: CompilerCallback
  
  the callback when view compilation has been completed: callback(error | null, compiledView, map, meta)
- _map: any
- _meta: any
Returns void

Index

Variables

Functions

Variables

Const _default

Type declaration

compile: typeof compile

Const _default

Type declaration

addViewsToAppConfig: (views: ViewEntry[], ctrls: ImplementationBuildEntry[], appConfig: BuildAppConfig | WebpackAppConfig, directories: DirectoriesInfo, resources: ResourceConfig, _runtimeConfiguration: RuntimeConfiguration) => void

Parameters

views: ViewEntry[]

ctrls: ImplementationBuildEntry[]

appConfig: BuildAppConfig | WebpackAppConfig

directories: DirectoriesInfo

resources: ResourceConfig

_runtimeConfiguration: RuntimeConfiguration

Returns void

applyDefaultOptions: (options: ViewBuildOptions, viewList: ViewEntry[]) => ViewEntry[]

Parameters

options: ViewBuildOptions

viewList: ViewEntry[]

Returns ViewEntry[]

viewTemplatesFromDir: (dir: string, appRootDir: string, options?: ViewBuildOptions) => ViewBuildEntry[]

Parameters

dir: string

appRootDir: string

Optional options: ViewBuildOptions

Returns ViewBuildEntry[]

Functions

compile

Parameters

content: string

viewFile: string

options: ViewCompilerOptions

callback: CompilerCallback

_map: any

_meta: any

Returns void