Class FutureContainerModel

Name

FutureContainerModel

Version

1.0.0

Author

Matthew Holman maholman@coca-cola.com

Represents a list of Future

Implements

IFutureContainerModel

Index

Action

removeFuture createFuture

Action Internally adds the provided Future to the map

addFutureModel removeFutureModel

Computed

Other

getFuture handleFutureUpdated

Action

removeFuture

removeFuture(id): Promise<void>
Removes a Future model from the collection.
Parameters
- id: string
  the id of the Future to be removed
Returns Promise<void>
Remarks
If a remove service function was passed in as part of the options in the constructor then it will be used. Otherwise the default delete service will be invoked.

See
deleteFutureService

Implementation of IFutureContainerModel.removeFuture

createFuture

createFuture(model): Promise<any>
Adds a Future model into the collection.
Parameters
- model: FutureRequest
  the Future model to be added
Returns Promise<any>
Remarks
If an add service function was passed in as part of the options in the constructor then it will be used. Otherwise the default add service will be invoked.

See
addFutureService

Implementation of IFutureContainerModel.createFuture

Action Internally adds the provided Future to the map

addFutureModel

addFutureModel(model): void
Parameters
- model: IFutureModel<Record<string, unknown>>
Returns void
Implementation of IFutureContainerModel.addFutureModel

removeFutureModel

removeFutureModel(id): void
Parameters
- id: string
Returns void
Implementation of IFutureContainerModel.removeFutureModel

Computed

futures

get futures(): IFutureModel<Record<string, unknown>>[]
Returns IFutureModel<Record<string, unknown>>[]
the list of Futures

Getter
Computed value that will recalculate automatically whenever Futures are added or removed from the map.

Implementation of IFutureContainerModel.futures

Other

getFuture

getFuture(futureId): undefined | IFutureModel<Record<string, unknown>>
Convenience function that will retrieve the IFutureModel based on the id.
Parameters
- futureId: string
  the id of the future to be retrieved
Returns undefined | IFutureModel<Record<string, unknown>>
the IFutureModel or undefined if not available in the list

Implementation of IFutureContainerModel.getFuture

handleFutureUpdated

handleFutureUpdated(future, payload): void
------------------SUBSCRIPTIONS----------------------
Parameters
- future: FutureResponse
- payload: ApiCallback<string>
Returns void