Class SearchRequestProperty

Hierarchy

SearchRequestProperty

Index

Constructors

Properties

Methods

_requestFacets request requestCount requestFacets requestMembers

Constructors

constructor

new SearchRequestProperty(getClient): SearchRequestProperty
Parameters
- getClient: (() => SearchRequest)
  - - (): SearchRequest
    - Returns SearchRequest
Returns SearchRequestProperty
- Defined in src/RcsbSeacrh/SearchRequestProperty.ts:17

Properties

`Private` `Readonly` getClient

getClient: (() => SearchRequest)

Type declaration

- (): SearchRequest
- Returns SearchRequest

Methods

`Private` _requestFacets

_requestFacets(config): Promise<null | QueryResult>
Parameters
- config: {
      facets: FacetType[];
      query: SearchQueryType;
      resultsContentType: ResultsContentType;
      returnType: ReturnType;
  }
  - facets: FacetType[]
  - query: SearchQueryType
  - resultsContentType: ResultsContentType
  - returnType: ReturnType
Returns Promise<null | QueryResult>
- Defined in src/RcsbSeacrh/SearchRequestProperty.ts:21

request

request(query): Promise<null | QueryResult>
Parameters
- query: SearchQuery
Returns Promise<null | QueryResult>
- Defined in src/RcsbSeacrh/SearchRequestProperty.ts:71

requestCount

requestCount(query): Promise<number>
Parameters
- query: SearchQuery
Returns Promise<number>
- Defined in src/RcsbSeacrh/SearchRequestProperty.ts:60

requestFacets

requestFacets(query, facets, returnType, resultsContentType): Promise<null | QueryResult>
Parameters
- query: SearchQueryType
- facets: FacetType[]
- returnType: ReturnType
- resultsContentType: ResultsContentType
Returns Promise<null | QueryResult>
- Defined in src/RcsbSeacrh/SearchRequestProperty.ts:43

requestMembers

requestMembers(query): Promise<string[]>
Parameters
- query: SearchQuery
Returns Promise<string[]>
- Defined in src/RcsbSeacrh/SearchRequestProperty.ts:48

src

Generated using TypeDoc