Class AttributeEditor

Editor for attributes.

Hierarchy

AttributeEditor

Index

Properties

onApply operations

Methods

apply removeAttribute removeJsonAttribute setAttribute setJsonAttribute

Properties

onApply

onApply: ((operations: AttributeOperation[]) => Promise<void>)

Type declaration

- (operations: AttributeOperation[]): Promise<void>
- Parameters
  - operations: AttributeOperation[]
  Returns Promise<void>

operations

operations: AttributeOperation[]

Methods

apply

apply(): Promise<void>
Applies the attribute operations.

Returns Promise<void>
- Defined in AttributeEditor.ts:158

removeAttribute

removeAttribute(name: string): AttributeEditor
Removes an attribute.

Returns
The attribute editor instance.
Parameters
- name: string
  
  The name of the attribute to remove.
Returns AttributeEditor
- Defined in AttributeEditor.ts:137

removeJsonAttribute

removeJsonAttribute(name: string, instanceId: string): AttributeEditor
Removes a JSON attribute.

Returns
The attribute editor instance.
Parameters
- name: string
  
  The name of the attribute to remove.
- instanceId: string
  
  The instance ID.
Returns AttributeEditor
- Defined in AttributeEditor.ts:149

setAttribute

setAttribute(name: string, value: string | number | boolean | Date): AttributeEditor
Adds an attribute.

Returns
The attribute editor instance.
Parameters
- name: string
  
  The attribute name.
- value: string | number | boolean | Date
  
  The attribute value.
Returns AttributeEditor
- Defined in AttributeEditor.ts:61

setJsonAttribute

setJsonAttribute(name: string, instanceId: string, json: Record<string, any>, expiration?: Date): AttributeEditor
Adds a JSON attribute.

Returns
The attribute editor instance.
Parameters
- name: string
  
  The attribute name.
- instanceId: string
  
  The instance ID.
- json: Record<string, any>
  
  The json value. Must not contain exp as top level key.
- Optional expiration: Date
Returns AttributeEditor
- Defined in AttributeEditor.ts:109

Generated using TypeDoc