Class TestDirectivePatternBuilder

Namespace

TeaPie.Testing

Assembly

TeaPie.dll

A builder for constructing regular expression patterns for test directives used in '.http' files.

public sealed class TestDirectivePatternBuilder

Inheritance

object

TestDirectivePatternBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

JsonExtensions.ToJsonString(object)

Methods

AddBooleanArrayParameter(string?)

Adds a parameter that accepts an array of bool.

public TestDirectivePatternBuilder AddBooleanArrayParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddBooleanParameter(string?)

Adds a bool parameter.

public TestDirectivePatternBuilder AddBooleanParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddDateTimeParameter(string?)

Adds a DateTime parameter.

public TestDirectivePatternBuilder AddDateTimeParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddHeaderNameParameter(string?)

Adds a parameter for HTTP header names.

public TestDirectivePatternBuilder AddHeaderNameParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddNumberArrayParameter(string?)

Adds a parameter that accepts an array of numbers.

public TestDirectivePatternBuilder AddNumberArrayParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddNumberParameter(string?)

Adds a numeric parameter.

public TestDirectivePatternBuilder AddNumberParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddParameter(string, string?)

Adds a custom parameter with a specified pattern.

public TestDirectivePatternBuilder AddParameter(string pattern, string? parameterName = null)

Parameters

pattern string

The regex pattern for the parameter.

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddStatusCodesParameter(string?)

Adds a parameter for HTTP status codes.

public TestDirectivePatternBuilder AddStatusCodesParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddStringArrayParameter(string?)

Adds a parameter that accepts an array of string.

public TestDirectivePatternBuilder AddStringArrayParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddStringParameter(string?)

Adds a string parameter.

public TestDirectivePatternBuilder AddStringParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

AddTimeOnlyParameter(string?)

Adds a TimeOnly parameter.

public TestDirectivePatternBuilder AddTimeOnlyParameter(string? parameterName = null)

Parameters

parameterName string

The optional name of the parameter. If not provided, a default name ("Parameter" + index, starting from 1) is assigned (e.g., "Parameter3").

Returns

TestDirectivePatternBuilder

The updated TestDirectivePatternBuilder instance.

Build()

Builds the final directive pattern as a string.

public string Build()

Returns

string

The constructed directive pattern.

Create(string)

Creates a new instance of TestDirectivePatternBuilder.

public static TestDirectivePatternBuilder Create(string directiveName)

Parameters

directiveName string

The name of the directive.

Returns

TestDirectivePatternBuilder

A new TestDirectivePatternBuilder instance.