Interface IStorageCommandOptions

interface IStorageCommandOptions {
    containerPath?: string;
    failure?: RequestFailure<any>;
    props: Record<string, any>;
    scope?: any;
    success?: RequestSuccess<StorageCommandResponse>;
    type: STORAGE_TYPES;
}

Hierarchy (view full)

Properties

containerPath? failure? props scope? success? type

Properties

Optional containerPath

containerPath?: string

The container path in which to execute the command.

Optional failure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

props

props: Record<string, any>

The specific set of props will differ for each storage item type:

  • Physical Location: name, description, locationId (rowId of the parent Physical Location)
  • Primary Storage: name, description, locationId (rowId of the parent Physical Location), temperatureControlled (boolean)
  • Freezer: name, description, locationId (rowId of the parent Physical Location), manufacturer, freezerModel, temperature, temperatureUnits, serialNumber, sensorName, lossRate, status, temperatureControlled (boolean)
  • Shelf/Rack/Canister: name, description, locationId (rowId of the parent freezer or Shelf/Rack/Canister)
  • Storage Unit Type: name, description, unitType (one of the following: "Box", "Plate", "Bag", "Cane", "Tube Rack"), rows, cols (required if positionFormat is not "Num"), positionFormat (one of the following: "Num", "AlphaNum", "AlphaAlpha", "NumAlpha", "NumNum"), positionOrder (one of the following: "RowColumn", "ColumnRow")
  • Terminal Storage Location: name, description, typeId (rowId of the Storage Unit Type), locationId (rowId of the parent freezer or Shelf/Rack/Canister)

Optional scope

scope?: any

A scoping object for the success and failure callback functions (default to this).

Optional success

success?: RequestSuccess<StorageCommandResponse>

This will be called upon successfully completing a request.

type

type: STORAGE_TYPES

Storage items can be of the following types: Physical Location, Freezer, Primary Storage, Shelf, Rack, Canister, Storage Unit Type, or Terminal Storage Location.

Settings

Member Visibility

Theme

On This Page

containerPathfailurepropsscopesuccesstype

Generated using TypeDoc