Class File

Operator type for defining a file and its metadata.

Hierarchy

Object
- File

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 File(properties?: Map<string, Property>): File
Parameters
- properties: Map<string, Property> = ...
Returns File
Overrides Object.constructor
- Defined in packages/operators/src/types.ts:430

Properties

properties

properties: Map<string, Property> = ...

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
Inherited from Object.addProperty
- 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
Inherited from Object.bool
- 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
Inherited from Object.defineProperty
- 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
Inherited from Object.enum
- 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
Inherited from Object.file
- 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
Inherited from Object.float
- 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
Inherited from Object.getProperty
- 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[]
Inherited from Object.getPropertyList
- 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
Inherited from Object.int
- 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
Inherited from Object.list
- 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
Inherited from Object.map
- 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
Inherited from Object.obj
- 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
Inherited from Object.oneof
- 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
Inherited from Object.str
- 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
Inherited from Object.tuple
- 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
Inherited from Object.uploadedFile
- Defined in packages/operators/src/types.ts:184

`Static` fromJSON

fromJSON(json: any): File
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 File
Overrides Object.fromJSON
- Defined in packages/operators/src/types.ts:453

`Static` propertiesFromJSON

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

Generated using TypeDoc