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