Class ItemChanges<T>

Type Parameters

T extends object

Hierarchy

Changes<T>
- ItemChanges

Index

Constructors

Properties

$inc? $set? $unset? empty fieldNames item

Methods

clear detectEmpty getReturning has increase mergeSet replaceSet set unset

Constructors

constructor

new ItemChanges<T>(changes?: ChangesInterface<T>, item: T): ItemChanges<T>
Type Parameters
- T extends object
Parameters
- changes: ChangesInterface<T> = {}
- item: T
Returns ItemChanges<T>
Overrides Changes.constructor
- Defined in packages/type/src/changes.ts:109

Properties

`Optional` $inc

$inc?: Partial<Pick<T, NumberFields<T>>>

`Optional` $set

$set?: T | Partial<T>

`Optional` $unset

$unset?: {
[path: string]: number;
}

Type declaration

[path: string]: number

empty

empty: boolean = true

fieldNames

fieldNames: string[] = []

`Protected` item

item: T

Methods

clear

clear(): void
Returns void
Inherited from Changes.clear
- Defined in packages/type/src/changes.ts:42

`Protected` detectEmpty

detectEmpty(): void
Returns void
Inherited from Changes.detectEmpty
- Defined in packages/type/src/changes.ts:59

getReturning

getReturning(): string[]
Returns string[]
Inherited from Changes.getReturning
- Defined in packages/type/src/changes.ts:49

has

has(name: keyof T & string): boolean
Parameters
- name: keyof T & string
Returns boolean
Inherited from Changes.has
- Defined in packages/type/src/changes.ts:103

increase

increase(property: NumberFields<T>, increase?: number): void
Parameters
- property: NumberFields<T>
- increase: number = 1
Returns void
Overrides Changes.increase
- Defined in packages/type/src/changes.ts:116

mergeSet

mergeSet($set: T | Partial<T>): void
Parameters
- $set: T | Partial<T>
Returns void
Inherited from Changes.mergeSet
- Defined in packages/type/src/changes.ts:71

replaceSet

replaceSet($set: T | Partial<T>): void
Parameters
- $set: T | Partial<T>
Returns void
Inherited from Changes.replaceSet
- Defined in packages/type/src/changes.ts:63

set

set(property: keyof T & string, value: any): void
Parameters
- property: keyof T & string
- value: any
Returns void
Overrides Changes.set
- Defined in packages/type/src/changes.ts:121

unset

unset(property: keyof T & string, unset?: boolean): void
Parameters
- property: keyof T & string
- unset: boolean = true
Returns void
Overrides Changes.unset
- Defined in packages/type/src/changes.ts:126

Generated using TypeDoc