• ------------------------------
  • JS API Reference

    Module: market/demand/demand-body-builder

    Table of contents

    Enumerations

    Classes

    Type Aliases

    Type Aliases

    DemandPropertyValue

    Ƭ DemandPropertyValue: string | number | boolean | string[] | number[]

    Defines what kind of value data types one can expect in the raw Demand Properties

    Defined in

    src/market/demand/demand-body-builder.ts:6


    DemandProperty

    Ƭ DemandProperty: Object

    Represents a single property/attribute that can be set on a Demand to specify Requestor needs

    Demand properties should be understood as values for various parameters of the agreement between Provider and Requestor. By defining properties on the demand, and negotiating them, the parties settle on the Terms & Conditions of the collaboration.

    Type declaration

    NameType
    keystring
    valueDemandPropertyValue

    Defined in

    src/market/demand/demand-body-builder.ts:14


    DemandBodyPrototype

    Ƭ DemandBodyPrototype: Object

    Data structure that represents details of the body for a demand subscription request

    This type belongs to our domain (use case layer), and will later be "serialized" to the body that's sent to Yagna. You should consider this as a "draft of the demand", that can be finalized by one of the market/api.IMarketApi implementations.

    Type declaration

    NameType
    propertiesDemandProperty[]
    constraintsstring[]

    Defined in

    src/market/demand/demand-body-builder.ts:32