types config.UpdatableConfig

@algorandfoundation/algokit-utils / types/config / UpdatableConfig

Class: UpdatableConfig

types/config.UpdatableConfig

Updatable AlgoKit config

Implements

• Readonly\<Config>

Table of contents

Constructors

• constructor

Properties

• config

Accessors

• debug
• logger
• maxSearchDepth
• populateAppCallResources
• projectRoot
• traceAll
• traceBufferSizeMb

Methods

• configure
• configureProjectRoot
• getLogger
• withDebug

Constructors

constructor

• new UpdatableConfig(): UpdatableConfig

Returns

UpdatableConfig

Defined in

src/types/config.ts:88

Properties

config

• Private config: Config

Defined in

src/types/config.ts:31

Accessors

debug

• get debug(): boolean

Returns

boolean

Implementation of

Readonly.debug

Defined in

src/types/config.ts:41

---

logger

• get logger(): Logger

Returns

Logger

Implementation of

Readonly.logger

Defined in

src/types/config.ts:37

---

maxSearchDepth

• get maxSearchDepth(): number

Returns

number

Implementation of

Readonly.maxSearchDepth

Defined in

src/types/config.ts:57

---

populateAppCallResources

• get populateAppCallResources(): boolean

Returns

boolean

Implementation of

Readonly.populateAppCallResources

Defined in

src/types/config.ts:33

---

projectRoot

• get projectRoot(): null | string

Returns

null | string

Implementation of

Readonly.projectRoot

Defined in

src/types/config.ts:45

---

traceAll

• get traceAll(): boolean

Returns

boolean

Implementation of

Readonly.traceAll

Defined in

src/types/config.ts:49

---

traceBufferSizeMb

• get traceBufferSizeMb(): number

Returns

number

Implementation of

Readonly.traceBufferSizeMb

Defined in

src/types/config.ts:53

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

src/types/config.ts:135

---

configureProjectRoot

▸ configureProjectRoot(): Promise\<void>

Configures the project root by searching for a specific file within a depth limit. This is only supported in a Node environment.

Returns

Promise\<void>

Defined in

src/types/config.ts:108

---

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

Logger

The requested logger

Defined in

src/types/config.ts:66

---

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

Defined in

src/types/config.ts:78