Class BaseClientConfigBuilder

Builder class for constructing BaseClientConfig objects. Implements the IBuilder interface for type-safe construction.

Hierarchy (View Summary)

BaseClientConfigBuilder
- TokenInterfacingClientConfigBuilder
- DryRunCachingClientConfigBuilder

Implements

IBuilder<BaseClientConfig>

Index

Constructors

Methods

allowDefaults build getAOConfig isDefaultsAllowed reset validate withAOConfig withProcessId withRetriesEnabled withWallet

Constructors

constructor

new BaseClientConfigBuilder(): BaseClientConfigBuilder
Returns BaseClientConfigBuilder

Methods

allowDefaults

allowDefaults(allow: boolean): this
Controls whether default values should be allowed during building.
Parameters
- allow: boolean
  If true, allows default values to be used for unset properties
Returns this
The builder instance for method chaining
Implementation of IBuilder.allowDefaults
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:46

build

build(): BaseClientConfig
Builds and returns the final object

Returns BaseClientConfig
The constructed object of type T
Implementation of IBuilder.build
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:19

getAOConfig

getAOConfig(): undefined | ConnectArgsLegacy
Gets the current AO config

Returns undefined | ConnectArgsLegacy
The current AO config or undefined if not set
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:112

`Protected`isDefaultsAllowed

isDefaultsAllowed(): boolean
Gets whether default values are allowed.

Returns boolean
True if defaults are allowed, false otherwise
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:69

reset

reset(): this
Resets the builder to its initial state.

Returns this
The builder instance for method chaining
Implementation of IBuilder.reset
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:35

`Protected`validate

validate(): void
Validates the configuration based on whether defaults are allowed.

Returns void
Throws
Error if validation fails
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:59

withAOConfig

withAOConfig(aoConfig: ConnectArgsLegacy): this
Sets the aoConfig for the configurations
Parameters
- aoConfig: ConnectArgsLegacy
  The aoConfig to use
Returns this
The builder instance for method chaining
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:103

withProcessId

withProcessId(processId: string): this
Sets the process ID for the configuration.
Parameters
- processId: string
  The ID of the ao process
Returns this
The builder instance for method chaining
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:82

withRetriesEnabled

withRetriesEnabled(enabled: boolean): this
Sets the retries enabled to a specific value, defaults to false.
Parameters
- enabled: boolean
  whether or not to retry on rpc errors.
Returns this
The builder instance for method chaining
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:122

withWallet

withWallet(wallet: JWKInterface): this
Sets the wallet for the configuration.
Parameters
- wallet: JWKInterface
  The Arweave wallet interface
Returns this
The builder instance for method chaining
- Defined in core/ao/configuration/builder/BaseClientConfigBuilder.ts:92