Class DirectoryCatalog

A catalog based on one or more JavaScript modules in a directory.

Hierarchy

CatalogBase
- DirectoryCatalog

Implements

ComposablePartCatalog

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DirectoryCatalog(directory: string, options?: DirectoryCatalogOptions): DirectoryCatalog

- Defined in catalogs/DirectoryCatalog.ts:45
Initializes a new instance of that class.

Parameters
- directory: string
  
  The path to the directory.
- Optional options: DirectoryCatalogOptions
Returns DirectoryCatalog

Properties

directory

directory: string

The path to the directory.

Optional options

options: DirectoryCatalogOptions

Methods

getClasses

getClasses(): Promise<any[]>

Implementation of ComposablePartCatalog.getClasses

Overrides CatalogBase.getClasses
- Defined in catalogs/DirectoryCatalog.ts:84
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/DirectoryCatalog.ts:94
Returns the list of classes.

Returns any[]

The loaded classes.

Private getGlobOptions

getGlobOptions(): Options

- Defined in catalogs/DirectoryCatalog.ts:103
Returns Options

Private getPatterns

getPatterns(): string[]

- Defined in catalogs/DirectoryCatalog.ts:115
Returns string[]

Private loadClasses

loadClasses(files: string[]): any[]

- Defined in catalogs/DirectoryCatalog.ts:129
Parameters
- files: string[]
Returns any[]

Generated using TypeDoc