Interface HostOperations<SP>

interface HostOperations<SP extends object> {
    calculatePrices?(
        request: PriceCalculationRequest,
    ): Promise<PriceCalculationResponse>;
    executeCustom?(payload: { type: string }): Promise<unknown>;
    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? executeCustom? 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:174

`Optional`executeCustom

executeCustom?(payload: { type: string }): Promise<unknown>
Executes a custom host operation.

The payload is required to have a type attribute used to distinguish between different operations.

If the host encounters an operation it is not equipped to handle, it should throw an error with the name set to NotSupportedError.
Parameters
- payload: { type: string }
Returns Promise<unknown>
- Defined in Types.ts:187

`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:166

`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:154