Class FileCatalog

A catalog based on a JavaScript module in a file.

Hierarchy

CatalogBase
- FileCatalog

Implements

ComposablePartCatalog

Index

Constructors

constructor

Properties

file
options

Methods

Constructors

constructor

new FileCatalog(file: string, options?: FileCatalogOptions): FileCatalog

- Defined in catalogs/FileCatalog.ts:36
Initializes a new instance of that class.

Parameters
- file: string
  
  The path to the file.
- Optional options: FileCatalogOptions
Returns FileCatalog

Properties

file

file: string

The path to the file.

Optional options

options: FileCatalogOptions

Methods

getClasses

getClasses(): Promise<any[]>

Implementation of ComposablePartCatalog.getClasses

Inherited from CatalogBase.getClasses
- Defined in catalogs/CatalogBase.ts:26
Returns the list of classes.

Returns Promise<any[]>

The promise with the loaded classes.

getClassesSync

getClassesSync(): any[]

Implementation of ComposablePartCatalog.getClassesSync

Overrides CatalogBase.getClassesSync
- Defined in catalogs/FileCatalog.ts:75
Returns the list of classes.

Returns any[]

The loaded classes.

Generated using TypeDoc