Class: ContainerManager

ContainerManager reference for the Terminal49 TypeScript SDK, used to list containers, fetch container details, and retrieve raw and mapped transport events.

Class: ContainerManager

Extends

• BaseManager

Constructors

Constructor

new ContainerManager(transport, defaultFormat?): ContainerManager

Parameters

Parameter	Type	Default value
transport	Transport	undefined
defaultFormat	ResponseFormat	'raw'

Returns

ContainerManager

Inherited from

BaseManager.constructor

Methods

customFields()

customFields(id, options?): Promise<any>

Parameters

Parameter	Type
id	string
options?	CallOptions

Returns

Promise<any>

---

demurrage()

demurrage(id): Promise<any>

Parameters

Parameter	Type
id	string

Returns

Promise<any>

---

events()

events(id, options?): Promise<any>

Parameters

Parameter	Type
id	string
options?	CallOptions

Returns

Promise<any>

---

get()

get(id, include?, options?): Promise<any>

Parameters

Parameter	Type
id	string
include	IncludeParam<ContainerInclude>
options?	CallOptions

Returns

Promise<any>

---

iterate()

iterate(filters?, options?): AsyncGenerator<Container, void, unknown>

Parameters

Parameter	Type
filters	ContainerListFilters | undefined
options?	Omit<ListOptions, "page">

Returns

AsyncGenerator<Container, void, unknown>

---

list()

list(filters?, options?): Promise<any>

Parameters

Parameter	Type
filters	ContainerListFilters
options?	ListOptions

Returns

Promise<any>

---

map()

map(id, options?): Promise<any>

Parameters

Parameter	Type
id	string
options?	CallOptions

Returns

Promise<any>

---

rawEvents()

rawEvents(id, options?): Promise<any>

Parameters

Parameter	Type
id	string
options?	CallOptions

Returns

Promise<any>

---

refresh()

refresh(id, options?): Promise<any>

Parameters

Parameter	Type
id	string
options?	CallOptions

Returns

Promise<any>

---

route()

route(id, options?): Promise<any>

Parameters

Parameter	Type
id	string
options?	CallOptions

Returns

Promise<any>

---

setCustomField()

setCustomField(id, fieldId, value, options?): Promise<any>

Parameters

Parameter	Type
id	string
fieldId	string
value	unknown
options?	CallOptions

Returns

Promise<any>

---

summary()

summary(groupBy, filters?, options?): Promise<any>

Count the containers list would return for the same filters, grouped by one dimension, in one request (GET /containers/summary).

Parameters

Parameter	Type
groupBy	ContainerSummaryGroupBy
filters	ContainerListFilters
options?	CallOptions

Returns

Promise<any>