index
AKASHA SDK is a modular set of utilities and apis that can be used to build your own app.
Namespaces
| Namespace | Description |
|---|---|
| typings | - |
Interfaces
SDK_API
Defined in: sdk/src/index.ts:29
Properties
| Property | Type | Defined in |
|---|---|---|
auth | AWF_Auth | sdk/src/index.ts:31 |
globalChannel | EventBus | sdk/src/index.ts:30 |
profile | AWF_Profile | sdk/src/index.ts:32 |
SDK_Services
Defined in: sdk/src/index.ts:35
Properties
| Property | Type | Defined in |
|---|---|---|
appSettings | AppSettings | sdk/src/index.ts:40 |
ceramic | CeramicService | sdk/src/index.ts:41 |
common | object | sdk/src/index.ts:43 |
common.ipfs | AWF_IpfsConnector | sdk/src/index.ts:45 |
common.lit | Lit | sdk/src/index.ts:47 |
common.misc | AWF_Misc | sdk/src/index.ts:46 |
common.notification | NotificationService | sdk/src/index.ts:48 |
common.web3 | Web3Connector | sdk/src/index.ts:44 |
db | DB | sdk/src/index.ts:42 |
gql | Gql | sdk/src/index.ts:37 |
log | Logging | sdk/src/index.ts:36 |
settings | Settings | sdk/src/index.ts:39 |
stash | Stash | sdk/src/index.ts:38 |
Type Aliases
AWF_SDK
AWF_SDK:
object
Defined in: sdk/src/index.ts:52
Type declaration
| Name | Type | Defined in |
|---|---|---|
api | SDK_API | sdk/src/index.ts:54 |
services | SDK_Services | sdk/src/index.ts:53 |
Functions
getSDK()
getSDK():
AWF_SDK
Defined in: sdk/src/index.ts:69
Creates a new SDK instance or returns a previusly created one.
Returns
Example
import getSDK from '@akashaorg/core-sdk';
const sdk = getSDK();
init()
init():
AWF_SDK
Defined in: sdk/src/index.ts:86
Creates a new SDK instance.
Returns
Example
import {init} from '@akashaorg/core-sdk';
const sdk = init();