Class Relation<Parent, Related, RelatedClass> Abstract

Type Parameters

Parent extends Model = Model
Related extends Model = Model
RelatedClass extends ModelConstructor<Related> = ModelConstructor<Related>

Hierarchy

Relation
- MultiModelRelation
- SingleModelRelation

Index

Constructors

constructor

Properties

Accessors

loaded

Methods

Constructors

constructor

new Relation<Parent, Related, RelatedClass>(parent: Parent, relatedClass: RelatedClass, foreignKeyName: string, localKeyName?: string): Relation<Parent, Related, RelatedClass>

- Defined in src/models/relations/Relation.ts:32
Type Parameters
- Parent extends Model<Parent> = Model
- Related extends Model<Related> = Model
- RelatedClass extends Constructor<Related, RelatedClass> & typeof Model = ModelConstructor<Related>
Parameters
- parent: Parent
- relatedClass: RelatedClass
- foreignKeyName: string
- Optional localKeyName: string
Returns Relation<Parent, Related, RelatedClass>

Properties

deleteStrategy

deleteStrategy: RelationDeleteStrategy = null

enabled

enabled: boolean = true

foreignKeyName

foreignKeyName: string

localKeyName

localKeyName: string

name

name: string

parent

parent: Parent

Optional related

related?: null | Related | Related[]

relatedClass

relatedClass: RelatedClass

Static inverseRelationClasses

inverseRelationClasses: Constructor<Relation<Model, Model, ModelConstructor<Model>>>[] = []

Accessors

loaded

get loaded(): boolean

- Defined in src/models/relations/Relation.ts:44
Returns boolean

Methods

Abstract addRelated

addRelated(related: Related): void

- Defined in src/models/relations/Relation.ts:62
Parameters
- related: Related
Returns void

clone

clone(options?: Partial<{ clones: WeakMap<Model, Model>; constructors: WeakMap<typeof Model, typeof Model> }>): Relation<Parent, Related, RelatedClass>

- Defined in src/models/relations/Relation.ts:98
Parameters
- options: Partial<{ clones: WeakMap<Model, Model>; constructors: WeakMap<typeof Model, typeof Model> }> = {}
Returns Relation<Parent, Related, RelatedClass>

disable

disable(): void

- Defined in src/models/relations/Relation.ts:56
Returns void

enable

enable(): void

- Defined in src/models/relations/Relation.ts:52
Returns void

getLoadedModels

getLoadedModels(): Related[]

- Defined in src/models/relations/Relation.ts:84
Returns Related[]

getModels

getModels(): Promise<Related[]>

- Defined in src/models/relations/Relation.ts:76
Returns Promise<Related[]>

initializeInverseRelations

initializeInverseRelations(model: Related): void

- Defined in src/models/relations/Relation.ts:123
Parameters
- model: Related
Returns void

isEmpty

isEmpty(): null | boolean

- Defined in src/models/relations/Relation.ts:72
Returns null | boolean

isInverseOf

isInverseOf(relation: Relation<Model, Model, ModelConstructor<Model>>): boolean

- Defined in src/models/relations/Relation.ts:136
Parameters
- relation: Relation<Model, Model, ModelConstructor<Model>>
Returns boolean

Abstract isRelated

isRelated(model: Related): boolean

- Defined in src/models/relations/Relation.ts:63
Parameters
- model: Related
Returns boolean

Abstract load

load(): Promise<null | Related | Related[]>

- Defined in src/models/relations/Relation.ts:60
Returns Promise<null | Related | Related[]>

onDelete

onDelete(strategy: RelationDeleteStrategy): Relation<Parent, Related, RelatedClass>

- Defined in src/models/relations/Relation.ts:92
Parameters
- strategy: RelationDeleteStrategy
Returns Relation<Parent, Related, RelatedClass>

resolve

resolve(): Promise<null | Related | Related[]>

- Defined in src/models/relations/Relation.ts:68
deprecated
This method has been renamed to load.

Returns Promise<null | Related | Related[]>

Abstract setForeignAttributes

setForeignAttributes(related: Related): void

- Defined in src/models/relations/Relation.ts:61
Parameters
- related: Related
Returns void

static

static(): RelationConstructor<Relation<Parent, Related, RelatedClass>>

- Defined in src/models/relations/Relation.ts:48
Returns RelationConstructor<Relation<Parent, Related, RelatedClass>>

unload

unload(): void

- Defined in src/models/relations/Relation.ts:88
Returns void

Generated using TypeDoc