UpdatableConfig
@algorandfoundation/algokit-utils / types/config / UpdatableConfig
types/config.UpdatableConfig
Updatable AlgoKit config
Implements
Section titled “Implements”Readonly<Config>
Table of contents
Section titled “Table of contents”Constructors
Section titled “Constructors”Properties
Section titled “Properties”Accessors
Section titled “Accessors”Methods
Section titled “Methods”Constructors
Section titled “Constructors”constructor
Section titled “constructor”• new UpdatableConfig(): UpdatableConfig
Returns
Section titled “Returns”Defined in
Section titled “Defined in”Properties
Section titled “Properties”config
Section titled “config”• Private config: Config
Defined in
Section titled “Defined in”Accessors
Section titled “Accessors”• get debug(): boolean
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”Readonly.debug
Defined in
Section titled “Defined in”events
Section titled “events”• get events(): AsyncEventEmitter
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”Readonly.events
Defined in
Section titled “Defined in”logger
Section titled “logger”• get logger(): Logger
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”Readonly.logger
Defined in
Section titled “Defined in”maxSearchDepth
Section titled “maxSearchDepth”• get maxSearchDepth(): number
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”Readonly.maxSearchDepth
Defined in
Section titled “Defined in”populateAppCallResources
Section titled “populateAppCallResources”• get populateAppCallResources(): boolean
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”Readonly.populateAppCallResources
Defined in
Section titled “Defined in”projectRoot
Section titled “projectRoot”• get projectRoot(): null | string
Returns
Section titled “Returns”null | string
Implementation of
Section titled “Implementation of”Readonly.projectRoot
Defined in
Section titled “Defined in”traceAll
Section titled “traceAll”• get traceAll(): boolean
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”Readonly.traceAll
Defined in
Section titled “Defined in”traceBufferSizeMb
Section titled “traceBufferSizeMb”• get traceBufferSizeMb(): number
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”Readonly.traceBufferSizeMb
Defined in
Section titled “Defined in”Methods
Section titled “Methods”configure
Section titled “configure”▸ configure(newConfig): void
Update the AlgoKit configuration with your own configuration settings
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
newConfig | Partial<Config> | Partial or complete config to replace |
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”getLogger
Section titled “getLogger”▸ getLogger(returnNullLogger?): Logger
Returns the current logger, or the null logger if true is passed in to returnNullLogger
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
returnNullLogger? | boolean | Whether or not to return the null logger |
Returns
Section titled “Returns”The requested logger
Defined in
Section titled “Defined in”withDebug
Section titled “withDebug”▸ withDebug(lambda): void
Temporarily run with debug set to true.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
lambda | () => unknown | A lambda expression with code to run with debug config set to true |
Returns
Section titled “Returns”void