yajsapi - JavaScript high-level API
Yagna Contributor Guide

Class: Agreement

yajsapi / Exports / rest/market / Agreement

Class: Agreement

rest/market.Agreement

Hierarchy

  • Agreement

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Parameters:

Name

Type

api

RequestorApi

subscription

Subscription

agreement_id

string

Returns: Agreement

Defined in: yajsapi/rest/market.ts:46

Properties

_api

Private _api: any

Defined in: yajsapi/rest/market.ts:44

_id

Private _id: any

Defined in: yajsapi/rest/market.ts:46

_subscription

Private _subscription: any

Defined in: yajsapi/rest/market.ts:45

Methods

confirm

confirm(): Promise<boolean>

Returns: Promise<boolean>

Defined in: yajsapi/rest/market.ts:67

details

details(): Promise<AgreementDetails>

Returns: Promise<AgreementDetails>

Defined in: yajsapi/rest/market.ts:62

id

id(): string

Returns: string

Defined in: yajsapi/rest/market.ts:58

terminate

terminate(reason?: string): Promise<boolean>

Parameters:

Name

Type

Default value

reason

string

"Finished"

Returns: Promise<boolean>

Defined in: yajsapi/rest/market.ts:78