TypeScript SDK Reference
api/client.gen.Socket
A Unix or TCP/IP socket that can be mounted into a container.
Hierarchy
-
BaseClient
↳
Socket
Constructors
constructor
new Socket(parent?
, _id?
): Socket
Constructor is used for internal usage only, do not create object from it.
Parameters
Name | Type |
---|---|
parent? | Object |
parent.ctx | Context |
parent.queryTree? | QueryTree [] |
_id? | SocketID |
Returns
Overrides
BaseClient.constructor
Properties
_id
Private
Optional
Readonly
_id: SocketID
= undefined
Methods
id
id(): Promise
<SocketID
>
A unique identifier for this Socket.
Returns
Promise
<SocketID
>