Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Models

Models are an abstraction for AWS DynamoDB Tables.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Models(rootPath: string): Models

  • Create a new instance by providing a folder path.

    Will populate the filePaths property with the result of the listFiles method using the rootPath as a parameter.

    Parameters

    • rootPath: string

      absolute folder where to load files from

    Returns Models

Properties

filePaths

filePaths: string[] = []

array of files (absolute paths) inside the given rootPath

modules

modules: any[] = []

array of modules, 1:1 mapped to the filePaths compiled from source

rootPath

rootPath: string

the folder where the files are located

Accessors

resources

  • get resources(): object

  • Accessor for a ready-built CloudFormation Resource Object which includes all Models as AWS SimpleDB CloudFormation Templates.

    Returns object

    • [name: string]: Resource

Methods

listFiles

  • listFiles(cwd: string): string[]

  • Convenience method for loading files recursively from a folder. Returns an array of file paths as strings. Will be called from the constructor with the pre-filled rootPath.

    Parameters

    • cwd: string

      the absolute path where to search for files from

    Returns string[]

loadModule

  • loadModule(filePath: string): any

  • Read and compile a javascript module directly. Is NOT cached and does NOT use the native 'require' naively. This should work even when mocked.

    Parameters

    • filePath: string

    Returns any

Generated using TypeDoc