Class ListingStore

constructor

• new ListingStore(main): ListingStore

• Parameters

  • main: MainStore

  Returns ListingStore

main

get

• get(type, criteria, projection, sort?, page?, limit?, elementContext?, atTime?, skipParsing?): Promise<ApiResponse<ElementDataWrapper[]>>

• Parameters

  • type: null | string | string[]

  • criteria: QueryCriteria

  • projection: string[]

  • Optional sort: Record<string, 1 | -1>

  • page: number = 1

  • limit: number = LISTING_PER_PAGE

  • Optional elementContext: Element

  • Optional atTime: string

  • skipParsing: boolean = false

  Returns Promise<ApiResponse<ElementDataWrapper[]>>

getDynamicContext

• getDynamicContext(elementContext?): DynamicContext

• Parameters

  • Optional elementContext: Element

  Returns DynamicContext

getElements

• getElements<T>(...args): Promise<null | IListingElementsResponse<T>>

• Type Parameters

  • T extends Element

  Parameters

  • Rest ...args: [type: null | string | string[], criteria: QueryCriteria, projection: string[], sort?: Record<string, 1 | -1>, page: number, limit: number, elementContext?: Element, atTime?: string, skipParsing: boolean]

  Returns Promise<null | IListingElementsResponse<T>>

getFirstElement

• getFirstElement<T>(...args): Promise<null | T>

• Type Parameters

  • T extends Element

  Parameters

  • Rest ...args: [type: null | string | string[], criteria: QueryCriteria, projection: string[], sort?: Record<string, 1 | -1>, page: number, limit: number, elementContext?: Element, atTime?: string, skipParsing: boolean]

  Returns Promise<null | T>

getListingConfigFromMongoQuery

• getListingConfigFromMongoQuery(query): IListingConfig

• Parameters

  • query: ListingQuery

  Returns IListingConfig

loadElementQuery

• loadElementQuery(query, elementContext?): Promise<null | IListingElementsResponse<Element>>

• Parameters

  • query: ListingQuery

  • Optional elementContext: Element

  Returns Promise<null | IListingElementsResponse<Element>>

loadListingConfig

• loadListingConfig(query, elementContext?, currentPosition?): Promise<IListingElementsResponse<Element>>

• Parameters

  • query: IListingConfig | ParsedListingConfig

  • Optional elementContext: Element

  • Optional currentPosition: GPSCoordinates

  Returns Promise<IListingElementsResponse<Element>>

parseConfig

• parseConfig(config, elementContext?): ParsedListingParams

• Parameters

  • config: IListingConfig | ParsedListingConfig

  • Optional elementContext: Element

  Returns ParsedListingParams

parseCriteria

• parseCriteria(criteria, context?): FormattedCriteria

• Parameters

  • criteria: QueryCriteria

  • Optional context: DynamicContext

  Returns FormattedCriteria

transformTypes

• transformTypes(types): null | string[]

• Parameters

  • types: null | string | string[]

  Returns null | string[]