Skip to main content

GlobalSettings

GlobalSettings​

@vendure/coreglobal-settings.entity.ts

Stores global settings for the whole application

Signature
class GlobalSettings extends VendureEntity implements HasCustomFields {
    constructor(input?: DeepPartial<GlobalSettings>)
    @Column('simple-array')
    availableLanguages: LanguageCode[];
    @Column({ default: true })
    trackInventory: boolean;
    @Column({ default: 0 })
    outOfStockThreshold: number;
    @Column(type => CustomGlobalSettingsFields)
    customFields: CustomGlobalSettingsFields;
}

constructor​

method
(input?: DeepPartial<GlobalSettings>) => GlobalSettings

availableLanguages​

property
LanguageCode[]

trackInventory​

property
boolean

Specifies the default value for inventory tracking for ProductVariants. Can be overridden per ProductVariant, but this value determines the default if not otherwise specified.

outOfStockThreshold​

property
number

Specifies the value of stockOnHand at which a given ProductVariant is considered out of stock.

customFields​

property
CustomGlobalSettingsFields