Class BlockNumberRuleBuilder

A rule builder to allow defining rules that mock the current block number.

Hierarchy

  • SingleValueRuleBuilder
    • BlockNumberRuleBuilder

Constructors

constructor

Methods

thenCloseConnection thenError thenReturn thenTimeout

Constructors

constructor

  • This builder should not be constructed directly. Call mockNode.forBlockNumber() instead.

    Parameters

    • addRuleCallback: ((rule: RequestRuleData) => Promise<MockedEndpoint>)
        • (rule: RequestRuleData): Promise<MockedEndpoint>

        • Parameters

          • rule: RequestRuleData

          Returns Promise<MockedEndpoint>

    Returns BlockNumberRuleBuilder

Methods

thenCloseConnection

  • Close the connection immediately after receiving the matching request, without sending any response.

    This method completes the rule definition, and returns a promise that resolves once the rule is active.

    Returns Promise<MockedEndpoint>

thenError

  • Fail and return an error message.

    Parameters

    • message: string

    Returns Promise<MockedEndpoint>

thenReturn

  • Successfully return a given value.

    Parameters

    • value: number

    Returns Promise<MockedEndpoint>

thenTimeout

  • Timeout, accepting the request but never returning a response.

    This method completes the rule definition, and returns a promise that resolves once the rule is active.

    Returns Promise<MockedEndpoint>

Settings

Member Visibility

Theme

Generated using TypeDoc