Class DappStoreRegistry

Hierarchy

DappStoreRegistry

Index

Constructors

constructor

Properties

cachedRegistry githubOwner githubRepo initialized lastRegistryCheckedAt registryRemoteUrl searchEngine strategy TTL

Methods

buildSearchIndex dApps enrichMetadataForDappStore filterDapps getAllCategories getAllDappIds getFeaturedDapps getRegistryTitle init localRegistry queryRemoteRegistry registry search searchByDappId validateRegistryJson

Constructors

constructor

new DappStoreRegistry(strategy?: RegistryStrategy): DappStoreRegistry
Parameters
- strategy: RegistryStrategy = RegistryStrategy.GitHub
Returns DappStoreRegistry
- Defined in lib/registry.ts:58

Properties

`Private` cachedRegistry

cachedRegistry: undefined | DAppStoreSchema

`Private` `Readonly` githubOwner

githubOwner: "merokudao" = "merokudao"

`Private` `Readonly` githubRepo

githubRepo: "dapp-store-registry" = "dapp-store-registry"

`Private` initialized

initialized: boolean = false

`Private` lastRegistryCheckedAt

lastRegistryCheckedAt: undefined | Date

`Readonly` registryRemoteUrl

registryRemoteUrl: string = ...

`Private` searchEngine

searchEngine: undefined | MiniSearch<any>

strategy

strategy: RegistryStrategy

`Static` `Private` TTL

TTL: number = ...

Methods

`Private` buildSearchIndex

buildSearchIndex(): Promise<void>
Returns Promise<void>
- Defined in lib/registry.ts:244

dApps

dApps(filterOpts?: FilterOptions): Promise<DAppSchema[]>
Returns the list of dApps that are listed in the registry. You can optionally filter the results.

Returns

The list of dApps that are listed in the registry
Parameters
- filterOpts: FilterOptions = ...
  
  The filter options. Defaults to { isListed: true}
Returns Promise<DAppSchema[]>
- Defined in lib/registry.ts:442

enrichMetadataForDappStore

enrichMetadataForDappStore(storeKey: string, res: DAppSchema[], dappsEnrichData?: EnrichSchema[]): DAppSchema[]
Parameters
- storeKey: string
- res: DAppSchema[]
- dappsEnrichData: EnrichSchema[] = []
Returns DAppSchema[]
- Defined in lib/registry.ts:249

`Private` filterDapps

filterDapps(dapps: DAppSchema[], filterOpts: FilterOptions): DAppSchema[]
Parameters
- dapps: DAppSchema[]
- filterOpts: FilterOptions
Returns DAppSchema[]
- Defined in lib/registry.ts:294

getAllCategories

getAllCategories(): {
category: string;
subCategory: string[];
}[]
Returns {
category: string;
subCategory: string[];
}[]
- Defined in lib/registry.ts:496

getAllDappIds

getAllDappIds(): Promise<number>
Returns Promise<number>
- Defined in lib/registry.ts:500

getFeaturedDapps

getFeaturedDapps(): Promise<undefined | FeaturedSection[]>
Gets all the featured sections defined in the registry. Along with the dApps. If no featured section is defined, returns undefined

Returns

The list of featured sections and the dApps in that section

Returns Promise<undefined | FeaturedSection[]>
- Defined in lib/registry.ts:492

getRegistryTitle

getRegistryTitle(): Promise<string>
Returns

The title of the registry

Returns Promise<string>
- Defined in lib/registry.ts:432

init

init(): Promise<void>
Initializes the registry. This is required before you can use the registry. It builds the search Index and caches the registry. Specifically it performs the following steps
1. If there's no cached Registry or the cached registry is stale, it fetches the registry from the remote URL
2. It builds the search index
If the strategy is Static, then the first load will always happen from local registry.json file. Any subsequent calls after TTL will fetch the registry from the remote URL (if static is stale) & rebuild the search index.

Returns

A promise that resolves when the registry is initialized
Returns Promise<void>
- Defined in lib/registry.ts:421

`Private` localRegistry

localRegistry(): DAppStoreSchema
Returns DAppStoreSchema
- Defined in lib/registry.ts:99

`Private` queryRemoteRegistry

queryRemoteRegistry(remoteFile: string): Promise<DAppStoreSchema>
Parameters
- remoteFile: string
Returns Promise<DAppStoreSchema>
- Defined in lib/registry.ts:112

registry

registry(): Promise<DAppStoreSchema>
Returns Promise<DAppStoreSchema>
- Defined in lib/registry.ts:190

search

search(queryTxt: string, filterOpts?: FilterOptions): DAppSchema[]
Performs search & filter on the dApps in the registry. This always returns the dApps that are listed.

Returns

The filtered & sorted list of dApps
Parameters
- queryTxt: string
  
  The text to search for
- filterOpts: FilterOptions = ...
  
  The filter options. Defaults to { isListed: true}
Returns DAppSchema[]
- Defined in lib/registry.ts:461

searchByDappId

searchByDappId(queryTxt: string): DAppSchema[]
search by dapp id

Returns

if matches return dappInfo
Parameters
- queryTxt: string
  
  dappId
Returns DAppSchema[]
- Defined in lib/registry.ts:479

`Static` validateRegistryJson

validateRegistryJson(json: DAppStoreSchema): (string | boolean)[]
Parameters
- json: DAppStoreSchema
Returns (string | boolean)[]
- Defined in lib/registry.ts:146

Generated using TypeDoc