Skip to main content

Definition

Assembly: CloudNimble.Breakdance.DotHttp.dll Namespace: CloudNimble.Breakdance.DotHttp Inheritance: System.Object

Syntax

Summary

Loads and parses http-client.env.json environment files.

Remarks

Supports $shared variables, environment-specific values, provider-based secrets, and .user file overrides.

Examples

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetResolvedVariables

Gets the resolved variables for a specific environment, including $shared values.

Syntax

Parameters

NameTypeDescription
environmentCloudNimble.Breakdance.DotHttp.Models.DotHttpEnvironmentThe environment configuration.
environmentNamestringThe name of the environment (e.g., “dev”, “staging”).

Returns

Type: System.Collections.Generic.Dictionary<string, string> A dictionary of resolved variable names and values.

Examples

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

LoadFromFile

Loads an environment configuration from a JSON file path.

Syntax

Parameters

NameTypeDescription
filePathstringThe path to the http-client.env.json file.

Returns

Type: CloudNimble.Breakdance.DotHttp.Models.DotHttpEnvironment A DotHttpEnvironment containing the parsed configuration.

Examples

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

MergeWithUserOverrides

Merges the user override file (.user) with the base environment.

Syntax

Parameters

NameTypeDescription
baseEnvironmentCloudNimble.Breakdance.DotHttp.Models.DotHttpEnvironmentThe base environment from http-client.env.json.
userFilePathstringThe path to the http-client.env.json.user file.

Returns

Type: CloudNimble.Breakdance.DotHttp.Models.DotHttpEnvironment The merged environment configuration.

Examples

Remarks

User override values take precedence over base environment values.

Parse

Parses environment configuration from JSON content.

Syntax

Parameters

NameTypeDescription
jsonContentstringThe JSON content of the environment file.

Returns

Type: CloudNimble.Breakdance.DotHttp.Models.DotHttpEnvironment A DotHttpEnvironment containing the parsed configuration.

Examples

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?