The Combies Library

/* @provengo summon combies */

The Combies library makes combies that were created using the combi table editor available for the rest of the model.

.combi files can be created using the Combi GUI plugin for vscode and need to be placed in the project/spec/combies directory.

vscode combi plugin

You can simply add a new combi file to an existing Provengo project, Fill in the details and specifications by adding field values and dependencies, then run the Provengo sub-commands to generate the model, analyze it, etc..

plugin 1

The image above demonstrates adding a new combi file to the project via the command palette

  1. Open the command palette with cmd+shift+p / ctrl+shift+p

  2. Start typing combi.. to see the available commands.

  3. Select the command "Create New Combi File".

Combies library API

Combies.get(combiName)

Returns the combi object with the passed combiName.

combiName

The name of the combi object to be returned.

Combies.getNames()

Returns an array of strings with the names of all registered combi objects.