Class PackageObject`No Self`

Represents a package in the Create logistics system.

Index

Constructors

Methods

getAddress getItemDetail getOrderData isEditable list setAddress

Constructors

constructor

new PackageObject(): PackageObject
Returns PackageObject

Methods

getAddress

getAddress(): string
Gets the package's address

Returns string
- Defined in libraries/helpers/src/integrations/create.ts:13

getItemDetail

getItemDetail(slot: number): undefined | ItemDetail
Gets detailed information about an item in the package
Parameters
- slot: number
Returns undefined | ItemDetail
- Defined in libraries/helpers/src/integrations/create.ts:15

getOrderData

getOrderData(): undefined | OrderDataObject
Gets the OrderDataObject if this is an encoded package

Returns undefined | OrderDataObject
- Defined in libraries/helpers/src/integrations/create.ts:17

isEditable

isEditable(): boolean
Checks if the package is currently editable (inside a packager/repackager)

Returns boolean
- Defined in libraries/helpers/src/integrations/create.ts:19

list

list(): SlotDetail[]
Lists all items in the package

Returns SlotDetail[]
- Defined in libraries/helpers/src/integrations/create.ts:21

setAddress

setAddress(address: string): void
Sets the package's address (only works if editable)
Parameters
- address: string
Returns void
- Defined in libraries/helpers/src/integrations/create.ts:23