JS API Reference

Class: Yagna

utils/yagna/yagna.Yagna

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Yagna(options?): Yagna

Parameters

NameType
options?YagnaOptions

Returns

Yagna

Defined in

src/utils/yagna/yagna.ts:61

Properties

apiKey

Protected Readonly apiKey: string

Defined in

src/utils/yagna/yagna.ts:57


apiBaseUrl

Protected Readonly apiBaseUrl: string

Defined in

src/utils/yagna/yagna.ts:58

Methods

getApi

getApi(): YagnaApi

Returns

YagnaApi

Defined in

src/utils/yagna/yagna.ts:70


connect

connect(): Promise<IdentityModel>

Returns

Promise<IdentityModel>

Defined in

src/utils/yagna/yagna.ts:74


end

end(): Promise<void>

Returns

Promise<void>

Defined in

src/utils/yagna/yagna.ts:99


getVersion

getVersion(): Promise<string>

Returns

Promise<string>

Defined in

src/utils/yagna/yagna.ts:104


createApi

createApi(): YagnaApi

Returns

YagnaApi

Defined in

src/utils/yagna/yagna.ts:117


getApiConfig

getApiConfig(): Configuration

Returns

Configuration

Defined in

src/utils/yagna/yagna.ts:142


getApiUrl

getApiUrl(apiName?): string

Parameters

NameType
apiName?string

Returns

string

Defined in

src/utils/yagna/yagna.ts:153


errorHandler

errorHandler(error): Promise<Error>

Parameters

NameType
errorError

Returns

Promise<Error>

Defined in

src/utils/yagna/yagna.ts:157


addErrorHandler

addErrorHandler(api): void

Parameters

NameType
apiYagnaApi

Returns

void

Defined in

src/utils/yagna/yagna.ts:169

Was this helpful?