Class Module

A Module represents a single Earth Engine source code file.

Hierarchy

Module

Index

Constructors

Properties

ast code commit dependencies license name path repository stats

Methods

checkForCircularImports dependencyTree listDependencies loadDependencies parseDependencies parseLicense

Constructors

constructor

new Module(path: string, repository: Repository, code: string, stats: { size: number }, commit: string): Module
Parameters
- path: string
- repository: Repository
- code: string
- stats: { size: number }
  - size: number
- commit: string
Returns Module
- Defined in module.ts:29

Properties

ast

ast: ParseResult<File>

code

code: string

commit

commit: string

dependencies

dependencies: undefined | Module[]

license

license: string

name

name: string

path

path: string

repository

repository: Repository

stats

stats: { size: number }

Type declaration

size: number

Methods

checkForCircularImports

checkForCircularImports(): void
Recursively check for circular imports downstream of this module. Throw if any are found.

Throws
If any circular import is found between modules downstream of this module.

Returns void
- Defined in module.ts:77

dependencyTree

dependencyTree(options?: { pretty: undefined | boolean }): DependencyTree
Build a dependency tree from all downstream modules.

Returns
The dependency tree of all modules required through this module/
Parameters
- options: { pretty: undefined | boolean } = {}
  - pretty: undefined | boolean
    
    If true, colors are included in the dependency tree for terminal output.
Returns DependencyTree
- Defined in module.ts:131

listDependencies

listDependencies(): Module[]
Get a flat array of all modules required downstream.

Returns
All modules required downstream.

Returns Module[]
- Defined in module.ts:51

loadDependencies

loadDependencies(loaded??: { [k: string]: Module }): Promise<Module[]>
Parse all downstream dependencies and load them.

Returns
A promise resolving to loaded modules required downstream of this script.
Parameters
- Optional loaded: { [k: string]: Module } = {}
  
  An optional list of already loaded module paths. This is used internally to avoid circular dependencies, and should not be passed by users.
  - [k: string]: Module
Returns Promise<Module[]>
- Defined in module.ts:101

parseDependencies

parseDependencies(): string[]
Parse all module paths required by the root module code.

Returns
The path of all modules required by the given code.

Returns string[]
- Defined in module.ts:150

parseLicense

parseLicense(): string
Parse a license code block from the module AST. Currently, this only supports blocks that include a @license tag.

Returns
The license code block.

Returns string
- Defined in module.ts:176

Generated using TypeDoc