Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SnConfigFieldModel

Class that represents a model for a field in the SnConfig (usually sn.config.js) module file

Hierarchy

  • SnConfigFieldModel

Index

Properties

Behavior

Behavior: SnConfigBehavior = SnConfigBehavior.Default

The behavoir of the field, can be flagged

default

SnConfigBehavior.Default

Optional FieldDescription

FieldDescription: undefined | string

Optional description. Will be dislpayed in the CLI Help screen.

Optional FieldName

FieldName: undefined | string

The name of the field (e.g. RepositoryUrl). This will be used also as a key in command line options and in the sn.config.js module

Question

Question: string

This question will be asked when the field is needed but not provided.

Optional StoreKey

StoreKey: undefined | string

The field will be stored with this name in the SnConfigFieldModelStore (usually 'ModelName.FieldName')

Generated using TypeDoc