Channel

Channel

Package: @vendure/core File: channel.entity.ts

A Channel represents a distinct sales channel and configures defaults for that channel.

Signature

class Channel extends VendureEntity {
  constructor(input?: DeepPartial<Channel>)
  @Column({ unique: true })
    code: string;
  @Column({ unique: true })
    token: string;
  @Column('varchar') defaultLanguageCode: LanguageCode;
  @ManyToOne(type => Zone)
    defaultTaxZone: Zone;
  @ManyToOne(type => Zone)
    defaultShippingZone: Zone;
  @Column('varchar')
    currencyCode: CurrencyCode;
  @Column(type => CustomChannelFields)
    customFields: CustomChannelFields;
  @Column() pricesIncludeTax: boolean;
}

Extends

VendureEntity

Members

constructor

method

type:

(input?: DeepPartial<Channel>) => Channel

code

property

type:

string

token

property

type:

string

defaultLanguageCode

property

type:

LanguageCode

defaultTaxZone

property

type:

Zone

defaultShippingZone

property

type:

Zone

currencyCode

property

type:

CurrencyCode

customFields

property

type:

CustomChannelFields

pricesIncludeTax

property

type:

boolean