Class DatasetCatalog

Dataset catalog lookup and on-demand cached generation.

Index

Constructors

Methods

EnsureGenerated EntrySpecHash Find IsScenarioID IsWorldID

Constructors

constructor

new DatasetCatalog(): DatasetCatalog
Returns DatasetCatalog

Methods

`Static`EnsureGenerated

EnsureGenerated(
    entry: CatalogEntry,
    seed: number,
    dataRoot?: string,
): Promise<string>
Ensure seed of entry is generated under dataRoot. Returns the seed directory once .complete exists.
Parameters
- entry: CatalogEntry
- seed: number
- dataRoot: string = ...
Returns Promise<string>
- Defined in data/catalog.ts:137

`Static`EntrySpecHash

EntrySpecHash(entry: CatalogEntry): string
The cache key of a catalog entry: its spec, its generator, its extra inputs, the shared generator modules and the Loom pin.
Parameters
- entry: CatalogEntry
Returns string
- Defined in data/catalog.ts:95

`Static`Find

Find(kind: "world" | "scenario", id: string): CatalogEntry
Find a catalog entry by kind and ID.
Parameters
- kind: "world" | "scenario"
- id: string
Returns CatalogEntry
- Defined in data/catalog.ts:88

`Static`IsScenarioID

IsScenarioID(code: string): code is ScenarioID
True when code names a scenario of the catalog (T3-lag included).
Parameters
- code: string
Returns code is ScenarioID
- Defined in data/catalog.ts:83

`Static`IsWorldID

IsWorldID(code: string): code is WorldID
True when code names a world of the catalog.
Parameters
- code: string
Returns code is WorldID
- Defined in data/catalog.ts:78