Skip to content

Latest commit

 

History

History
156 lines (83 loc) · 3.21 KB

types_config.UpdatableConfig.md

File metadata and controls

156 lines (83 loc) · 3.21 KB
Raw

@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()

Defined in

src/types/config.ts:50

Properties

config

• Private config: Config

Defined in

src/types/config.ts:13

Accessors

debug

• get debug(): boolean

Returns

boolean

Implementation of

Readonly.debug

Defined in

src/types/config.ts:19

logger

• get logger(): Logger

Returns

Logger

Implementation of

Readonly.logger

Defined in

src/types/config.ts:15

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

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

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