Class ListingStore

constructor

• new ListingStore(main: MainStore): ListingStore

• Parameters

  • main: MainStore

  Returns ListingStore

main

get

• get(
      type: null | string | string[],
      criteria: QueryCriteria,
      projection: string[],
      sort?: Record<string, -1 | 1>,
      page?: number,
      limit?: number,
      elementContext?: Element,
      atTime?: string,
      skipParsing?: boolean,
  ): Promise<ApiResponse<ElementDataWrapper[]>>

• Parameters

  • type: null | string | string[]
  • criteria: QueryCriteria
  • projection: string[]
  • Optionalsort: Record<string, -1 | 1>
  • page: number = 1
  • limit: number = LISTING_PER_PAGE
  • OptionalelementContext: Element
  • OptionalatTime: string
  • skipParsing: boolean = false

  Returns Promise<ApiResponse<ElementDataWrapper[]>>

getDynamicContext

• getDynamicContext(elementContext?: Element): DynamicContext

• Parameters

  • OptionalelementContext: Element

  Returns DynamicContext

getElements

• getElements<T extends Element>(
      ...args: [
          type: null
          | string
          | string[],
          criteria: QueryCriteria,
          projection: string[],
          sort?: Record<string, -1 | 1>,
          page: number,
          limit: number,
          elementContext?: Element,
          atTime?: string,
          skipParsing: boolean,
      ],
  ): Promise<null | IListingElementsResponse<T>>

• Type Parameters

  • T extends Element

  Parameters

  • ...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 extends Element>(
      ...args: [
          type: null
          | string
          | string[],
          criteria: QueryCriteria,
          projection: string[],
          sort?: Record<string, -1 | 1>,
          page: number,
          limit: number,
          elementContext?: Element,
          atTime?: string,
          skipParsing: boolean,
      ],
  ): Promise<null | T>

• Type Parameters

  • T extends Element

  Parameters

  • ...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: ListingQuery): IListingConfig

• Parameters

  • query: ListingQuery

  Returns IListingConfig

loadElementQuery

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

• Parameters

  • query: ListingQuery
  • OptionalelementContext: Element

  Returns Promise<null | IListingElementsResponse<Element>>

loadListingConfig

• loadListingConfig(
      query: IListingConfig | ParsedListingConfig,
      elementContext?: Element,
      currentPosition?: GPSCoordinates,
  ): Promise<IListingElementsResponse<Element>>

• Parameters

  • query: IListingConfig | ParsedListingConfig
  • OptionalelementContext: Element
  • OptionalcurrentPosition: GPSCoordinates

  Returns Promise<IListingElementsResponse<Element>>

parseConfig

• parseConfig(
      config: IListingConfig | ParsedListingConfig,
      elementContext?: Element,
  ): ParsedListingParams

• Parameters

  • config: IListingConfig | ParsedListingConfig
  • OptionalelementContext: Element

  Returns ParsedListingParams

parseCriteria

• parseCriteria(
      criteria: QueryCriteria,
      context?: DynamicContext,
  ): FormattedCriteria

• Parameters

  • criteria: QueryCriteria
  • Optionalcontext: DynamicContext

  Returns FormattedCriteria

transformTypes

• transformTypes(types: null | string | string[]): null | string[]

• Parameters

  • types: null | string | string[]

  Returns null | string[]