Class SDK

The SDK class is the entry point to the framework. Call init() to initialize the indexer.

Hierarchy

SDK

Index

Constructors

Properties

apiEndpoints defaultDataPath

Methods

init initApi initMainFetcher initMainIndexer

Constructors

constructor

new SDK(): SDK
Returns SDK

Properties

`Private` apiEndpoints

apiEndpoints: GraphQLEndpoint[] = []

`Private` defaultDataPath

defaultDataPath: string = 'data'

Methods

init

init(config: IndexerConfig): Promise<void>
Initializes the indexer. Generates configs for the services, creates workers and starts the services.
Parameters
- config: IndexerConfig
  
  The configuration to initialize the indexer with.
Returns Promise<void>
- Defined in packages/framework/src/main.ts:160

`Private` initApi

initApi(config: IndexerConfig): void
Parameters
- config: IndexerConfig
Returns void
- Defined in packages/framework/src/main.ts:379

`Private` initMainFetcher

initMainFetcher(config: IndexerConfig, channels: AllWorkerChannels, fetchers: WorkerInfo[]): Promise<void>
@todo: This is very similar to initMainIndexer. Can we refactor?
Parameters
- config: IndexerConfig
- channels: AllWorkerChannels
- fetchers: WorkerInfo[]
Returns Promise<void>
- Defined in packages/framework/src/main.ts:331

`Private` initMainIndexer

initMainIndexer(config: IndexerConfig, channels: AllWorkerChannels, indexers: WorkerInfo[]): Promise<void>
Private
Initializes the main indexer service. It starts the local broker and waits for all workers to be ready. It then imports the domain class, passed as a config parameter, and calls the init() method on it. If an apiSchemaPath is passed, it will create an API schema and append endpoints, but will NOT start the API.
Parameters
- config: IndexerConfig
  
  The configuration to initialize the main indexer service with.
- channels: AllWorkerChannels
  
  The matrix of all possible message channels.
- indexers: WorkerInfo[]
  
  List of all available workers and their state
Returns Promise<void>
- Defined in packages/framework/src/main.ts:279

Generated using TypeDoc