Class ProductExpandPipelineDataService

Service that generates a pipeline for expanding products as part of the mongoDB aggregation pipeline

Index

Constructors

Methods

generatePipelineForExpand getAttributePipeline getCategoryPipeline getCategoryUrl getLocationUrl getLocationsPipeline getProductPipeline getProductUrl getVariantsPipeline performPipelineExpandForProducts

Properties

db endpoint productRepository COLLECTION_PRODUCT

Constructors

constructor

new ProductExpandPipelineDataService(db, endpoint): ProductExpandPipelineDataService
Parameters
- db: Db
- endpoint: string
Returns ProductExpandPipelineDataService
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:29

Methods

generatePipelineForExpand

generatePipelineForExpand(expand?): Promise<Document[]>
Returns a pipeline for expanding a product, which can be used both before and after the product has been returned
Parameters
- Optional expand: Expand
Returns Promise<Document[]>
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:75

`Private` getAttributePipeline

getAttributePipeline(): Document[]
Generate attribute pipeline to be used for attribute expansion

TODO: For some reason, this is implemented differently from the other pipelines.

Returns Document[]
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:334

`Private` getCategoryPipeline

getCategoryPipeline(expand, opts?): Document[]
Generate category pipeline to be used for category expansion
Parameters
- expand: undefined | ExpandData
- Optional opts: {
  fieldName?: string;
  localField?: string;
  }
  - Optional fieldName?: string
  - Optional localField?: string
Returns Document[]
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:146

`Private` getCategoryUrl

getCategoryUrl(categoryId?): string
Parameters
- Optional categoryId: string
Returns string
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:397

`Private` getLocationUrl

getLocationUrl(locationId?): string
Parameters
- Optional locationId: string
Returns string
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:402

`Private` getLocationsPipeline

getLocationsPipeline(expand, opts?): Document[]
Generate locations pipeline to be used for location expansion
Parameters
- expand: undefined | ExpandData
- Optional opts: {
  fieldName?: string;
  localField?: string;
  }
  - Optional fieldName?: string
  - Optional localField?: string
Returns Document[]
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:203

`Private` getProductPipeline

getProductPipeline(expand, opts?): Document[]
Generate pipeline for product expansion
Parameters
- expand: undefined | ExpandData
- Optional opts: {
      fieldName?: string;
      localField?: string;
      pipeline?: Document[];
  }
  - Optional fieldName?: string
  - Optional localField?: string
  - Optional pipeline?: Document[]
Returns Document[]
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:253

`Private` getProductUrl

getProductUrl(productId?): string
Parameters
- Optional productId: string
Returns string
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:392

`Private` getVariantsPipeline

getVariantsPipeline(expand, opts?): Document[]
Generate variants pipeline to be used for variant expansion
Parameters
- expand: undefined | ExpandData
- Optional opts: {
      fieldName?: string;
      foreignField?: string;
      localField?: string;
  }
  - Optional fieldName?: string
  - Optional foreignField?: string
  - Optional localField?: string
Returns Document[]
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:94

performPipelineExpandForProducts

performPipelineExpandForProducts(products, expand?): Promise<ProductResponse[]>
Perform pipeline expand for a list of products, appending the expanded fields to the product. These fields include:
- Variants
- Category
- Locations
- Attributes
Parameters
- products: ProductResponse[]
- Optional expand: Expand
Returns Promise<ProductResponse[]>
- Defined in src/adapter/default/dataServices/productExpandPipeline.dataService.ts:47

Properties

`Private` db

db: Db

`Private` endpoint

endpoint: string

`Private` productRepository

productRepository: MongoRepository<ProductEntity>

`Static` `Readonly` COLLECTION_PRODUCT

COLLECTION_PRODUCT: "products" = 'products'

Class ProductExpandPipelineDataService

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

db: Db

endpoint: string

Returns ProductExpandPipelineDataService

Methods

generatePipelineForExpand

Parameters

Optional expand: Expand

Returns Promise<Document[]>

Private getAttributePipeline

Returns Document[]

Private getCategoryPipeline

Parameters

expand: undefined | ExpandData

Optional opts: { fieldName?: string; localField?: string; }

Optional fieldName?: string

Optional localField?: string

Returns Document[]

Private getCategoryUrl

Parameters

Optional categoryId: string

Returns string

Private getLocationUrl

Parameters

Optional locationId: string

Returns string

Private getLocationsPipeline

Parameters

expand: undefined | ExpandData

Optional opts: { fieldName?: string; localField?: string; }

Optional fieldName?: string

Optional localField?: string

Returns Document[]

Private getProductPipeline

Parameters

expand: undefined | ExpandData

Optional opts: { fieldName?: string; localField?: string; pipeline?: Document[]; }

Optional fieldName?: string

Optional localField?: string

Optional pipeline?: Document[]

Returns Document[]

Private getProductUrl

Parameters

Optional productId: string

Returns string

Private getVariantsPipeline

Parameters

expand: undefined | ExpandData

Optional opts: { fieldName?: string; foreignField?: string; localField?: string; }

Optional fieldName?: string

Optional foreignField?: string

Optional localField?: string

Returns Document[]

performPipelineExpandForProducts

Parameters

products: ProductResponse[]

Optional expand: Expand

Returns Promise<ProductResponse[]>

Properties

Private db

Private endpoint

Private productRepository

Static Readonly COLLECTION_PRODUCT

Settings

Member Visibility

Theme

On This Page

`Optional` expand: Expand

`Private` getAttributePipeline

`Private` getCategoryPipeline

`Optional` opts: {
fieldName?: string;
localField?: string;
}

`Optional` fieldName?: string

`Optional` localField?: string

`Private` getCategoryUrl

`Optional` categoryId: string

`Private` getLocationUrl

`Optional` locationId: string

`Private` getLocationsPipeline

`Optional` opts: {
fieldName?: string;
localField?: string;
}

`Optional` fieldName?: string

`Optional` localField?: string

`Private` getProductPipeline

`Optional` opts: {
fieldName?: string;
localField?: string;
pipeline?: Document[];
}

`Optional` fieldName?: string

`Optional` localField?: string

`Optional` pipeline?: Document[]

`Private` getProductUrl

`Optional` productId: string

`Private` getVariantsPipeline

`Optional` opts: {
fieldName?: string;
foreignField?: string;
localField?: string;
}

`Optional` fieldName?: string

`Optional` foreignField?: string

`Optional` localField?: string

`Optional` expand: Expand

`Private` db

`Private` endpoint

`Private` productRepository

`Static` `Readonly` COLLECTION_PRODUCT