TypeScript SDK Reference
api/client.gen.Label
A simple key value object that represents a label.
Hierarchy
-
BaseClient
↳
Label
Constructors
constructor
new Label(parent?
, _id?
, _name?
, _value?
): Label
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? | LabelID |
_name? | string |
_value? | string |
Returns
Overrides
BaseClient.constructor
Properties
_id
Private
Optional
Readonly
_id: LabelID
= undefined
_name
Private
Optional
Readonly
_name: string
= undefined
_value
Private
Optional
Readonly
_value: string
= undefined
Methods
id
id(): Promise
<LabelID
>
A unique identifier for this Label.
Returns
Promise
<LabelID
>
name
name(): Promise
<string
>
The label name.
Returns
Promise
<string
>
value
value(): Promise
<string
>
The label value.
Returns
Promise
<string
>