Interface AvailabilityOptions<AdditionalData, Properties>

Options for creating an AvailabilityModel.

interface AvailabilityOptions<AdditionalData, Properties> {
    available: boolean;
    altId: string;
    rawId: string;
    visible: boolean;
    type: string;
}

Type Parameters

  • AdditionalData extends object = any
  • Properties extends Record<string, any> = Record<string, any>

Hierarchy

  • KosParentAware
  • NoteAware
    • AvailabilityOptions

Properties

available altId rawId visible type

Properties

available

available: boolean

is the node available as calculated by the Pour Engine

altId

altId: string

Return the alternate id for the node. The alternate id can be used to store correlation id's to link nodes to other data in the event that node id's can't be used due to potentially id collisions.

rawId

rawId: string

The raw id for the node. The raw id will generally be the beverage id in the scope of its group.

visible

visible: boolean

is the node visible as calculated by the Pour Engine.

type

type: string

the type of the node

Settings

Member Visibility

Theme

On This Page

availablealtIdrawIdvisibletype