Collection
Collection
A Collection is a grouping of Products based on various configurable criteria.
Signature
class Collection extends VendureEntity implements Translatable, HasCustomFields, ChannelAware, Orderable {
constructor(input?: DeepPartial<Collection>)
@Column({ default: false })
isRoot: boolean;
@Column()
position: number;
@Column({ default: false })
isPrivate: boolean;
name: LocaleString;
description: LocaleString;
slug: LocaleString;
@OneToMany((type) => CollectionTranslation, (translation) => translation.base, { eager: true })
translations: Array<Translation<Collection>>;
@ManyToOne((type) => Asset, { onDelete: 'SET NULL' })
featuredAsset: Asset;
@OneToMany((type) => CollectionAsset, (collectionAsset) => collectionAsset.collection)
assets: CollectionAsset[];
@Column('simple-json') filters: ConfigurableOperation[];
@ManyToMany((type) => ProductVariant, (productVariant) => productVariant.collections)
@JoinTable()
productVariants: ProductVariant[];
@Column((type) => CustomCollectionFields)
customFields: CustomCollectionFields;
@TreeChildren()
children: Collection[];
@TreeParent()
parent: Collection;
@ManyToMany((type) => Channel)
@JoinTable()
channels: Channel[];
}
Extends
Implements
- Translatable
- HasCustomFields
- ChannelAware
- Orderable
Members
constructor
(input?: DeepPartial<Collection>) => Collection
isRoot
boolean
position
number
isPrivate
boolean
name
LocaleString
description
LocaleString
slug
LocaleString
translations
Array<Translation<Collection>>
featuredAsset
Asset
assets
CollectionAsset[]
filters
ConfigurableOperation[]
productVariants
ProductVariant[]
customFields
CustomCollectionFields
children
Collection[]
parent
Collection
channels
Channel[]