Class EntityPartialUpdateBuilder<T>

Type Parameters

T extends Entity

Hierarchy

PartialUpdateBuilder<T>
- EntityPartialUpdateBuilder

Index

Constructors

constructor

Properties

entity operations

Constructors

constructor

new EntityPartialUpdateBuilder<T>(entity: T, operations: JsonMap): EntityPartialUpdateBuilder<T>
Type Parameters
- T extends Entity<T>
Parameters
- entity: T
- operations: JsonMap
Returns EntityPartialUpdateBuilder<T>
Overrides PartialUpdateBuilder.constructor
- Defined in lib/partialupdate/EntityPartialUpdateBuilder.ts:12

Properties

`Readonly` entity

entity: T

operations

operations: UpdateOperation[] = []

Methods

add

add(field: string, item: any): EntityPartialUpdateBuilder<T>
Adds an item to a set

Returns
Parameters
- field: string
  
  The field to perform the operation on
- item: any
  
  The item to add
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.add
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:288

`Private` addOperation

addOperation(path: string, operator: string, value?: any): EntityPartialUpdateBuilder<T>
Private
Adds an update operation on the partial update

Returns
Parameters
- path: string
  
  The path which gets modified by the operation
- operator: string
  
  The operator of the operation to add
- Optional value: any
  
  The value used to execute the operation
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.addOperation
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:396

`Private` addOperations

addOperations(json: JsonMap): void
Private
Adds initial operations
Parameters
- json: JsonMap
Returns void
Inherited from PartialUpdateBuilder.addOperations
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:433

and

and(path: string, bitmask: number): EntityPartialUpdateBuilder<T>
Performs a bitwise AND on a path

Returns
Parameters
- path: string
  
  The path to perform the operation on
- bitmask: number
  
  The bitmask taking part in the operation
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.and
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:325

atLeast

atLeast(field: string, value: number): EntityPartialUpdateBuilder<T>
Sets the smallest possible value of a field

Returns
Parameters
- field: string
  
  The field to compare with
- value: number
  
  The smalles possible value
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.atLeast
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:81

atMost

atMost(field: string, value: number): EntityPartialUpdateBuilder<T>
Sets the highest possible value of a field

Returns
Parameters
- field: string
  
  The field to compare with
- value: number
  
  The highest possible value
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.atMost
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:72

currentDate

currentDate(field: string): EntityPartialUpdateBuilder<T>
Sets a datetime field to the current moment

Returns
Parameters
- field: string
  
  The field to perform the operation on
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.currentDate
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:314

dec

dec(field: string, by?: number): EntityPartialUpdateBuilder<T>
Decrements a field by a given value

Returns
Parameters
- field: string
  
  The field to decrement
- Optional by: number
  
  The number to decrement by, defaults to 1
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.dec
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:145

decrement

decrement(field: string, by?: number): EntityPartialUpdateBuilder<T>
Decrements a field by a given value

Returns
Parameters
- field: string
  
  The field to decrement
- Optional by: number
  
  The number to decrement by, defaults to 1
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.decrement
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:45

div

div(field: string, divisor: number): EntityPartialUpdateBuilder<T>
Divides a field by a given number

Returns
Parameters
- field: string
  
  The field to divide
- divisor: number
  
  The number to divide by
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.div
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:171

divide

divide(field: string, divisor: number): EntityPartialUpdateBuilder<T>
Divides a field by a given number

Returns
Parameters
- field: string
  
  The field to divide
- divisor: number
  
  The number to divide by
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.divide
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:63

execute

execute(): Promise<T>
Executes the partial update

Returns
The promise resolves when the partial update has been executed successfully

Abstract

Returns Promise<T>
Overrides PartialUpdateBuilder.execute
- Defined in lib/partialupdate/EntityPartialUpdateBuilder.ts:19

`Private` hasOperationOnPath

hasOperationOnPath(path: string): boolean
Private
Checks whether an operation on the field exists already

Returns
True, if the operation does exist
Parameters
- path: string
  
  The path where the operation is executed on
Returns boolean
Inherited from PartialUpdateBuilder.hasOperationOnPath
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:450

inc

inc(field: string, by?: number): EntityPartialUpdateBuilder<T>
Increments a field by a given value

Returns
Parameters
- field: string
  
  The field to increment
- Optional by: number
  
  The number to increment by, defaults to 1
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.inc
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:134

increment

increment(field: string, by?: number): EntityPartialUpdateBuilder<T>
Increments a field by a given value

Returns
Parameters
- field: string
  
  The field to increment
- Optional by: number
  
  The number to increment by, defaults to 1
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.increment
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:36

max

max(field: string, value: number): EntityPartialUpdateBuilder<T>
Sets the smallest possible value of a field

Returns
Parameters
- field: string
  
  The field to compare with
- value: number
  
  The smalles possible value
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.max
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:201

min

min(field: string, value: number): EntityPartialUpdateBuilder<T>
Sets the highest possible value of a field

Returns
Parameters
- field: string
  
  The field to compare with
- value: number
  
  The highest possible value
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.min
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:186

mul

mul(field: string, multiplicator: number): EntityPartialUpdateBuilder<T>
Multiplies a field by a given number

Returns
Parameters
- field: string
  
  The field to multiply
- multiplicator: number
  
  The number to multiply by
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.mul
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:156

multiply

multiply(field: string, multiplicator: number): EntityPartialUpdateBuilder<T>
Multiplies a field by a given number

Returns
Parameters
- field: string
  
  The field to multiply
- multiplicator: number
  
  The number to multiply by
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.multiply
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:54

or

or(path: string, bitmask: number): EntityPartialUpdateBuilder<T>
Performs a bitwise OR on a path

Returns
Parameters
- path: string
  
  The path to perform the operation on
- bitmask: number
  
  The bitmask taking part in the operation
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.or
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:336

pop

pop(field: string): EntityPartialUpdateBuilder<T>
Pops the last item out of a list

Returns
Parameters
- field: string
  
  The field to perform the operation on
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.pop
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:267

push

push(field: string, item: any): EntityPartialUpdateBuilder<T>
Pushes an item into a list

Returns
Parameters
- field: string
  
  The field to perform the operation on
- item: any
  
  The item to add
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.push
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:246

put

put(field: string, key: string | number | {
[key: string]: any;
}, value?: any): EntityPartialUpdateBuilder<T>
Puts an item from an array or map

Returns
Parameters
- field: string
  
  The field to perform the operation on
- key: string | number | {
  [key: string]: any;
  }
  
  The map key to put the value to or an object of arguments
- Optional value: any
  
  The value to put if a key was used
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.put
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:228

remove

remove(field: string, item: any): EntityPartialUpdateBuilder<T>
Removes an item from an array or map

Returns
Parameters
- field: string
  
  The field to perform the operation on
- item: any
  
  The item to add
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.remove
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:216

rename

rename(oldPath: string, newPath: string): EntityPartialUpdateBuilder<T>
Renames a field

Returns
Parameters
- oldPath: string
  
  The old field name
- newPath: string
  
  The new field name
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.rename
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:358

replace

replace(path: string, index: number, item: any): EntityPartialUpdateBuilder<T>
Replaces an item at a given index

Returns
Parameters
- path: string
  
  The path to perform the operation on
- index: number
  
  The index where the item will be replaced
- item: any
  
  The item to replace with
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.replace
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:300

set

set(field: string, value: any): EntityPartialUpdateBuilder<T>
Sets a field to a given value

Returns
Parameters
- field: string
  
  The field to set
- value: any
  
  The value to set to
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.set
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:112

shift

shift(field: string): EntityPartialUpdateBuilder<T>
Shifts the first item out of a list

Returns
Parameters
- field: string
  
  The field to perform the operation on
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.shift
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:277

toJSON

toJSON(): Json
Returns a JSON representation of this partial update

Returns

Returns Json
Inherited from PartialUpdateBuilder.toJSON
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:367

toNow

toNow(field: string): EntityPartialUpdateBuilder<T>
Sets a datetime field to the current moment

Method

Returns
Parameters
- field: string
  
  The field to perform the operation on
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.toNow
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:90

unshift

unshift(field: string, item: any): EntityPartialUpdateBuilder<T>
Unshifts an item into a list

Returns
Parameters
- field: string
  
  The field to perform the operation on
- item: any
  
  The item to add
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.unshift
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:257

xor

xor(path: string, bitmask: number): EntityPartialUpdateBuilder<T>
Performs a bitwise XOR on a path

Returns
Parameters
- path: string
  
  The path to perform the operation on
- bitmask: number
  
  The bitmask taking part in the operation
Returns EntityPartialUpdateBuilder<T>
Inherited from PartialUpdateBuilder.xor
- Defined in lib/partialupdate/PartialUpdateBuilder.ts:347

Class EntityPartialUpdateBuilder<T>

Type Parameters

T extends Entity

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends Entity<T>

Parameters

entity: T

operations: JsonMap

Returns EntityPartialUpdateBuilder<T>

Properties

Readonly entity

operations

Methods

add

Returns

Parameters

field: string

item: any

Returns EntityPartialUpdateBuilder<T>

Private addOperation

Returns

Parameters

path: string

operator: string

Optional value: any

Returns EntityPartialUpdateBuilder<T>

Private addOperations

Parameters

json: JsonMap

Returns void

and

Returns

Parameters

path: string

bitmask: number

Returns EntityPartialUpdateBuilder<T>

atLeast

Returns

Parameters

field: string

value: number

Returns EntityPartialUpdateBuilder<T>

atMost

Returns

Parameters

field: string

value: number

Returns EntityPartialUpdateBuilder<T>

currentDate

Returns

Parameters

field: string

Returns EntityPartialUpdateBuilder<T>

dec

Returns

Parameters

field: string

Optional by: number

Returns EntityPartialUpdateBuilder<T>

decrement

Returns

Parameters

field: string

Optional by: number

Returns EntityPartialUpdateBuilder<T>

div

Returns

Parameters

field: string

divisor: number

Returns EntityPartialUpdateBuilder<T>

divide

Returns

`Readonly` entity

`Private` addOperation

`Optional` value: any

`Private` addOperations

`Optional` by: number

`Optional` by: number

`Private` hasOperationOnPath

`Optional` by: number

`Optional` by: number