yajsapi - JavaScript high-level API
Yagna Contributor Guide

Class: Subscription

yajsapi / Exports / rest/market / Subscription

Class: Subscription

rest/market.Subscription

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Subscription(api, subscription_id, _details?)

Parameters

Name

Type

Default value

api

RequestorApi

undefined

subscription_id

string

undefined

_details

null | Demand

null

Defined in

yajsapi/rest/market.ts:201

Properties

_api

_api: RequestorApi

Defined in

yajsapi/rest/market.ts:197

_deleted

Private _deleted: boolean

Defined in

yajsapi/rest/market.ts:200

_details

Private _details: any

Defined in

yajsapi/rest/market.ts:201

_id

Private _id: string

Defined in

yajsapi/rest/market.ts:198

_open

Private _open: boolean

Defined in

yajsapi/rest/market.ts:199

Methods

close

close(): void

Returns

void

Defined in

yajsapi/rest/market.ts:219

delete

delete(): Promise

Returns

Promise

Defined in

yajsapi/rest/market.ts:236

details

details(): Demand

Returns

Demand

Defined in

yajsapi/rest/market.ts:231

done

done(): Promise

Returns

Promise

Defined in

yajsapi/rest/market.ts:227

events

events(cancellationToken?): AsyncGenerator<OfferProposal, any, unknown>

Parameters

Name

Type

cancellationToken?

any

Returns

AsyncGenerator<OfferProposal, any, unknown>

Defined in

yajsapi/rest/market.ts:243

id

id(): string

Returns

string

Defined in

yajsapi/rest/market.ts:215

ready

ready(): Promise<Subscription>

Returns

Promise<Subscription>

Defined in

yajsapi/rest/market.ts:223