Skip to main content

Interfaces

ChannelAware

Entities which can be assigned to Channels should implement this interface.

Signature
interface ChannelAware {
channels: Channel[];
}

channels

property

SoftDeletable

Entities which can be soft deleted should implement this interface.

Signature
interface SoftDeletable {
deletedAt: Date | null;
}

deletedAt

property
Date | null

Orderable

Entities which can be ordered relative to their siblings in a list.

Signature
interface Orderable {
position: number;
}

position

property
number

Taggable

Entities which can have Tags applied to them.

Signature
interface Taggable {
tags: Tag[];
}

tags

property
Tag[]

Translatable

Entities which have localizable string properties should implement this type.

Signature
interface Translatable {
translations: Array<Translation<VendureEntity>>;
}

translations

property
Array<Translation<VendureEntity>>