Skip to content

Create Publication

We are looking for publications that demonstrate building dApps or smart contracts!
See the full list of Gitcoin bounties that are eligible for rewards.

types config.UpdatableConfig

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

Class: UpdatableConfig

types/config.UpdatableConfig

Updatable AlgoKit config

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new UpdatableConfig(): UpdatableConfig

Returns

UpdatableConfig

Defined in

src/types/config.ts:76

Properties

config

Private config: Config

Defined in

src/types/config.ts:23

Accessors

debug

get debug(): boolean

Returns

boolean

Implementation of

Readonly.debug

Defined in

src/types/config.ts:29


logger

get logger(): Logger

Returns

Logger

Implementation of

Readonly.logger

Defined in

src/types/config.ts:25


maxSearchDepth

get maxSearchDepth(): number

Returns

number

Implementation of

Readonly.maxSearchDepth

Defined in

src/types/config.ts:45


projectRoot

get projectRoot(): null | string

Returns

null | string

Implementation of

Readonly.projectRoot

Defined in

src/types/config.ts:33


traceAll

get traceAll(): boolean

Returns

boolean

Implementation of

Readonly.traceAll

Defined in

src/types/config.ts:37


traceBufferSizeMb

get traceBufferSizeMb(): number

Returns

number

Implementation of

Readonly.traceBufferSizeMb

Defined in

src/types/config.ts:41

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:106


configureProjectRoot

configureProjectRoot(): void

Configures the project root by searching for a specific file within a depth limit.

Returns

void

Defined in

src/types/config.ts:91


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:54


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:66