Interface HostOperations<SP>

interface HostOperations<SP extends object> {
    calculatePrices?(
        request: PriceCalculationRequest,
    ): Promise<PriceCalculationResponse>;
    restore?(pin: string): Promise<RestoreResult<SP>>;
    save?(params: HostSaveParams<SP>): Promise<SaveResult>;
}

Type Parameters

SP extends object

Hierarchy (View Summary)

HostOperations
- FullHostOperations

Index

Methods

calculatePrices? restore? save?

Methods

`Optional`calculatePrices

calculatePrices?(
request: PriceCalculationRequest,
): Promise<PriceCalculationResponse>
Calculates prices.
Parameters
- request: PriceCalculationRequest
Returns Promise<PriceCalculationResponse>
Since
1.6.0
- Defined in Types.ts:168

`Optional`restore

restore?(pin: string): Promise<RestoreResult<SP>>
Restores a planning from a backend.

The backend should return the data that was saved with the pin.

Will only be used when save is also implemented.
Parameters
- pin: string
Returns Promise<RestoreResult<SP>>
- Defined in Types.ts:160

`Optional`save

save?(params: HostSaveParams<SP>): Promise<SaveResult>
Saves plannings to a backend.

The backend should return a pin that can be used to restore the planning.

Will only be used when restore is also implemented.
Parameters
- params: HostSaveParams<SP>
Returns Promise<SaveResult>
- Defined in Types.ts:148