Class NamePublishRuleBuilder

A builder to allow defining rules that will mock IPNS name publication requests.

Hierarchy

  • NamePublishRuleBuilder

Constructors

constructor

Methods

thenAcceptPublish thenAcceptPublishAs thenCloseConnection thenTimeout withContent

Constructors

constructor

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

    Parameters

    • nameKey: undefined | string
    • addRuleCallback: ((data: RequestRuleData) => Promise<void>)
        • (data: RequestRuleData): Promise<void>

        • Parameters

          • data: RequestRuleData

          Returns Promise<void>

    Returns NamePublishRuleBuilder

Methods

thenAcceptPublish

  • Return a successful result, as if the IPNS name was published, returning a default mock IPNS result.

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

    Returns Promise<void>

thenAcceptPublishAs

  • Return a successful result, as if the IPNS name was published, returning a given IPNS name.

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

    Parameters

    • name: string

    Returns Promise<void>

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<void>

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<void>

withContent

Settings

Member Visibility

Theme

Generated using TypeDoc