yajsapi - JavaScript high-level API
Yagna Contributor Guide

Class: Subscription

yajsapi / Exports / rest/market / Subscription

Class: Subscription

rest/market.Subscription

Hierarchy

  • Subscription

Table of contents

Constructors

Properties

Methods

Constructors

constructor

  • new Subscription(api: RequestorApi, subscription_id: string, _details?: null | Demand): Subscription

Parameters:

Name

Type

Default value

api

RequestorApi

-

subscription_id

string

-

_details

null | Demand

null

Returns: Subscription

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

Properties

_api

_api: RequestorApi

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

_deleted

Private _deleted: boolean

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

_details

Private _details: any

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

_id

Private _id: string

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

_open

Private _open: boolean

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

Methods

close

close(): void

Returns: void

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

delete

delete(): Promise<void>

Returns: Promise<void>

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

details

details(): Demand

Returns: Demand

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

done

done(): Promise<void>

Returns: Promise<void>

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

events

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

Parameters:

Name

Type

cancellationToken?

any

Returns: AsyncGenerator<OfferProposal, any, unknown>

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

id

id(): string

Returns: string

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

ready

ready(): Promise<Subscription>

Returns: Promise<Subscription>

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