Class Object

Operator type for representing an object value for operator input/output.

Hierarchy

BaseType
- Object
  - File
  - UploadedFile

Index

Constructors

Properties

Methods

addProperty bool defineProperty enum file float getProperty getPropertyList int list map obj oneof str tuple uploadedFile fromJSON propertiesFromJSON

Constructors

constructor

new Object(properties?: ObjectProperties): Object
You can construct operator object type optionally providing a JS Map with key representing the name of a property and the value representing the property it self. (default: new Map())
Parameters
- properties: ObjectProperties = ...
  
  initial properties on the object
Returns Object
Overrides BaseType.constructor
- Defined in packages/operators/src/types.ts:26

Properties

properties

properties: ObjectProperties = ...

initial properties on the object

Methods

addProperty

addProperty(name: string, property: Property): Property
Add a Property to an object

Returns
newly added property
Parameters
- name: string
  
  name/key for referencing the property
- property: Property
  
  the instance of Property
Returns Property
- Defined in packages/operators/src/types.ts:35

bool

bool(name: any, options?: any): Property
Define a property of type OperatorBoolean|Boolean on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:99

defineProperty

defineProperty(name: string, type: ANY_TYPE, options?: PropertyOptions): Property
Define a property on the object

Returns
newly defined property on the object
Parameters
- name: string
  
  name of the property
- type: ANY_TYPE
  
  type for the value of the property
- Optional options: PropertyOptions
Returns Property
- Defined in packages/operators/src/types.ts:54

enum

enum(name: any, values: any[], options?: any): Property
Define a property of type Enum on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- values: any[]
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:135

file

file(name: any, options?: any): Property
Define a property of type File on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:175

float

float(name: any, options?: any): Property
Define a property of type OperatorNumber|Number on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:117

getProperty

getProperty(name: string): Property
Get property defined on the object by name

Returns
value associated to the name/key provided
Parameters
- name: string
  
  name of the property
Returns Property
- Defined in packages/operators/src/types.ts:44

getPropertyList

getPropertyList(): Property[]
Get array of all properties defined on the object

Returns
properties on the object

Returns Property[]
- Defined in packages/operators/src/types.ts:72

int

int(name: any, options?: any): Property
Define a property of type OperatorNumber|Number on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:108

list

list(name: any, elementType: ANY_TYPE, options?: any): Property
Define a property of type List on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- elementType: ANY_TYPE
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:126

map

map(name: any, keyType: ANY_TYPE, valueType: ANY_TYPE, options?: any): Property
Define a property of type Map on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- keyType: ANY_TYPE
- valueType: ANY_TYPE
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:144

obj

obj(name: any, options?: any): Property
Define a property of type OperatorObject|Object on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:81

oneof

oneof(name: any, types: ANY_TYPE[], options?: any): Property
Define a property of type OneOf on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- types: ANY_TYPE[]
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:157

str

str(name: any, options?: any): Property
Define a property of type OperatorString|String on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:90

tuple

tuple(name: any, items: ANY_TYPE[], options?: any): Property
Define a property of type Tuple on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- items: ANY_TYPE[]
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:166

uploadedFile

uploadedFile(name: any, options?: any): Property
Define a property of type UploadedFile on the object

Returns
newly defined property
Parameters
- name: any
  
  name of the property
- options: any = {}
Returns Property
- Defined in packages/operators/src/types.ts:184

`Static` fromJSON

fromJSON(json: any): Object
Define an Object operator type by providing a json representing the type

Returns
operator type Object created with json provided
Parameters
- json: any
  
  json object representing the definition of the property
Returns Object
- Defined in packages/operators/src/types.ts:198

`Static` propertiesFromJSON

propertiesFromJSON(json: any): ObjectProperties
Parameters
- json: any
Returns ObjectProperties
- Defined in packages/operators/src/types.ts:187

Generated using TypeDoc