UpdatableConfig
Defined in: src/updatable-config.ts:28
Updatable AlgoKit config
Implements
Section titled “Implements”Readonly<AlgoKitConfig>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UpdatableConfig():
UpdatableConfig
Defined in: src/updatable-config.ts:90
Returns
Section titled “Returns”UpdatableConfig
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get debug():
boolean
Defined in: src/updatable-config.ts:39
Whether or not debug mode is enabled
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”events
Section titled “events”Get Signature
Section titled “Get Signature”get events():
AsyncEventEmitter
Defined in: src/updatable-config.ts:59
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”logger
Section titled “logger”Get Signature
Section titled “Get Signature”get logger():
Logger
Defined in: src/updatable-config.ts:35
Logger
Returns
Section titled “Returns”Logger
Implementation of
Section titled “Implementation of”maxSearchDepth
Section titled “maxSearchDepth”Get Signature
Section titled “Get Signature”get maxSearchDepth():
number
Defined in: src/updatable-config.ts:55
The maximum depth to search for a specific file
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”populateAppCallResources
Section titled “populateAppCallResources”Get Signature
Section titled “Get Signature”get populateAppCallResources():
boolean
Defined in: src/updatable-config.ts:31
Whether to enable populateAppCallResources in sendParams by default. Default value is false.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”AlgoKitConfig.populateAppCallResources
projectRoot
Section titled “projectRoot”Get Signature
Section titled “Get Signature”get projectRoot():
string|null
Defined in: src/updatable-config.ts:43
The path to the project root directory
Returns
Section titled “Returns”string | null
Implementation of
Section titled “Implementation of”traceAll
Section titled “traceAll”Get Signature
Section titled “Get Signature”get traceAll():
boolean
Defined in: src/updatable-config.ts:47
Indicates whether to trace all operations
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”traceBufferSizeMb
Section titled “traceBufferSizeMb”Get Signature
Section titled “Get Signature”get traceBufferSizeMb():
number
Defined in: src/updatable-config.ts:51
The size of the trace buffer in megabytes
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”AlgoKitConfig.traceBufferSizeMb
Methods
Section titled “Methods”configure()
Section titled “configure()”configure(
newConfig):void
Defined in: src/updatable-config.ts:107
Update the AlgoKit configuration with your own configuration settings
Parameters
Section titled “Parameters”newConfig
Section titled “newConfig”Partial<AlgoKitConfig>
Partial or complete config to replace
Returns
Section titled “Returns”void
getLogger()
Section titled “getLogger()”getLogger(
returnNullLogger?):Logger
Defined in: src/updatable-config.ts:68
Returns the current logger, or the null logger if true is passed in to returnNullLogger
Parameters
Section titled “Parameters”returnNullLogger?
Section titled “returnNullLogger?”boolean
Whether or not to return the null logger
Returns
Section titled “Returns”Logger
The requested logger
withDebug()
Section titled “withDebug()”withDebug(
lambda):void
Defined in: src/updatable-config.ts:80
Temporarily run with debug set to true.
Parameters
Section titled “Parameters”lambda
Section titled “lambda”() => unknown
A lambda expression with code to run with debug config set to true
Returns
Section titled “Returns”void