Class DevRegistry

Hierarchy

DevRegistry

Index

Constructors

constructor

Properties

openSearchApis

Methods

addBulkDocsToIndex autoComplete createDoc createIndex deleteDoc deleteScroller getTotalDocsCount liveIndex maxWindowError scrollDocs search searchAutoComplete searchById searchOwnerAddress searchQuery updateDoc updateDocs

Constructors

constructor

new DevRegistry(openSearchOptions: OpenSearchConnectionOptions): DevRegistry
Parameters
- openSearchOptions: OpenSearchConnectionOptions
Returns DevRegistry
- Defined in lib/v1/dev.ts:41

Properties

openSearchApis

openSearchApis: OpensearchRequest

Methods

addBulkDocsToIndex

addBulkDocsToIndex(index: string, developers?: DeveloperSchema[]): Promise<undefined | BulkStats>
prepare payload for bulk insert

Returns
Parameters
- index: string
- developers: DeveloperSchema[] = []
Returns Promise<undefined | BulkStats>
- Defined in lib/v1/dev.ts:182

autoComplete

autoComplete(queryTxt: string, filterOpts?: DeveloperSearchPayload): Promise<StandardResponse>
Parameters
- queryTxt: string
- filterOpts: DeveloperSearchPayload = ...
Returns Promise<StandardResponse>
- Defined in lib/v1/dev.ts:324

createDoc

createDoc(developer: DeveloperSchema): Promise<StandardResponse>
Parameters
- developer: DeveloperSchema
Returns Promise<StandardResponse>
- Defined in lib/v1/dev.ts:237

createIndex

createIndex(): Promise<{
    indexName: string;
    message: string[];
    status: number;
}>
create new search index with data from file or gitlab repo

Returns

acknowledgement

Returns Promise<{
    indexName: string;
    message: string[];
    status: number;
}>
- Defined in lib/v1/dev.ts:208

deleteDoc

deleteDoc(dappId: string): Promise<StandardResponse>
Parameters
- dappId: string
Returns Promise<StandardResponse>
- Defined in lib/v1/dev.ts:254

deleteScroller

deleteScroller(ids: string[]): Promise<any>
delete scroll snapshots

Returns
Parameters
- ids: string[]
  
  scroll ids
Returns Promise<any>
- Defined in lib/v1/dev.ts:453

getTotalDocsCount

getTotalDocsCount(filterOpts?: DeveloperSearchPayload): Promise<DocsCountResponse>
Parameters
- filterOpts: DeveloperSearchPayload = ...
Returns Promise<DocsCountResponse>
- Defined in lib/v1/dev.ts:457

liveIndex

liveIndex(indexName: string): Promise<{
    indexName: string;
    message: string[];
    status: number;
}>
set alias to deploy a index, remove alias from old index

Returns
Parameters
- indexName: string
Returns Promise<{
    indexName: string;
    message: string[];
    status: number;
}>
- Defined in lib/v1/dev.ts:226

`Private` maxWindowError

maxWindowError(finalQuery: FilterOptionsSearch, limit: number): StandardResponse
retrun Error response if

Returns

response
Parameters
- finalQuery: FilterOptionsSearch
  
  quey
- limit: number
  
  limit
Returns StandardResponse
- Defined in lib/v1/dev.ts:395

scrollDocs

scrollDocs(filterOpts: DeveloperSearchPayload): Promise<StandardResponse>
call scroll docs

Returns
Parameters
- filterOpts: DeveloperSearchPayload
  
  payload fields
Returns Promise<StandardResponse>
- Defined in lib/v1/dev.ts:416

search

search(queryTxt: string, filterOpts?: DeveloperSearchPayload): Promise<StandardResponse>
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: DeveloperSearchPayload = ...
  
  The filter options. Defaults to { isListed: true}
Returns Promise<StandardResponse>
- Defined in lib/v1/dev.ts:269

`Private` searchAutoComplete

searchAutoComplete(search: string, payload: DeveloperSearchPayload): {
finalQuery: PaginationQuery;
}
Preppaire query for autocomplete search

Returns
Parameters
- search: string
- payload: DeveloperSearchPayload
Returns {
finalQuery: PaginationQuery;
}
- finalQuery: PaginationQuery
- Defined in lib/v1/dev.ts:138

searchById

searchById(id: string): Promise<StandardResponse>
search by dapp id

Returns

if matches return dappInfo
Parameters
- id: string
Returns Promise<StandardResponse>
- Defined in lib/v1/dev.ts:305

searchOwnerAddress

searchOwnerAddress(ownerAddress: string): Promise<StandardResponse>
search by Owner Address

Returns

if matches return dappInfo
Parameters
- ownerAddress: string
  
  dappId
Returns Promise<StandardResponse>
- Defined in lib/v1/dev.ts:348

`Private` searchQuery

searchQuery(search: string, payload: DeveloperSearchPayload): {
finalQuery: PaginationQuery;
limit: number;
}
Prepaire query for search, filters, search by id, tokens, ownerAddress

Returns
Parameters
- search: string
- payload: DeveloperSearchPayload
Returns {
finalQuery: PaginationQuery;
limit: number;
}
- finalQuery: PaginationQuery
- limit: number
- Defined in lib/v1/dev.ts:51

updateDoc

updateDoc(developer: DeveloperSchema): Promise<StandardResponse>
update dapp to index, when new app is registered on dapp store

Returns

acknowledge
Parameters
- developer: DeveloperSchema
Returns Promise<StandardResponse>
- Defined in lib/v1/dev.ts:375

updateDocs

updateDocs(index: string, body: DeveloperSchemaDoc[]): Promise<PromiseSettledResult<any>[]>
update multiple docs

Returns
Parameters
- index: string
  
  string
- body: DeveloperSchemaDoc[]
  
  { isVerfied: true, dappId }
Returns Promise<PromiseSettledResult<any>[]>
- Defined in lib/v1/dev.ts:482

Class DevRegistry

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

openSearchOptions: OpenSearchConnectionOptions

Returns DevRegistry

Properties

openSearchApis

Methods

addBulkDocsToIndex

Returns

Parameters

index: string

developers: DeveloperSchema[] = []

Returns Promise<undefined | BulkStats>

autoComplete

Parameters

queryTxt: string

filterOpts: DeveloperSearchPayload = ...

Returns Promise<StandardResponse>

createDoc

Parameters

developer: DeveloperSchema

Returns Promise<StandardResponse>

createIndex

Returns

Returns Promise<{ indexName: string; message: string[]; status: number; }>

deleteDoc

Parameters

dappId: string

Returns Promise<StandardResponse>

deleteScroller

Returns

Parameters

ids: string[]

Returns Promise<any>

getTotalDocsCount

Parameters

filterOpts: DeveloperSearchPayload = ...

Returns Promise<DocsCountResponse>

liveIndex

Returns

Parameters

indexName: string

Returns Promise<{ indexName: string; message: string[]; status: number; }>

Private maxWindowError

Returns

Parameters

finalQuery: FilterOptionsSearch

limit: number

Returns StandardResponse

scrollDocs

Returns

Parameters

filterOpts: DeveloperSearchPayload

Returns Promise<StandardResponse>

search

Returns

Parameters

queryTxt: string

filterOpts: DeveloperSearchPayload = ...

Returns Promise<StandardResponse>

Private searchAutoComplete

Returns

Parameters

search: string

payload: DeveloperSearchPayload

Returns { finalQuery: PaginationQuery; }

finalQuery: PaginationQuery

searchById

Returns

Parameters

id: string

Returns Promise<StandardResponse>

searchOwnerAddress

Returns Promise<{
indexName: string;
message: string[];
status: number;
}>

Returns Promise<{
indexName: string;
message: string[];
status: number;
}>

`Private` maxWindowError

`Private` searchAutoComplete

Returns {
finalQuery: PaginationQuery;
}

`Private` searchQuery

Returns {
finalQuery: PaginationQuery;
limit: number;
}