Class BelongsToOneRelation<Parent, Related, RelatedClass>

Type Parameters

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

Hierarchy

SingleModelRelation<Parent, Related, RelatedClass>
- BelongsToOneRelation

Index

Constructors

constructor

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

Inherited from SingleModelRelation.constructor
- Defined in src/models/relations/SingleModelRelation.ts:17
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
- Optional foreignKeyName: string
- Optional localKeyName: string
Returns BelongsToOneRelation<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

relatedClass

relatedClass: RelatedClass

Static inverseRelationClasses

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

Accessors

loaded

get loaded(): boolean

Inherited from SingleModelRelation.loaded
- Defined in src/models/relations/Relation.ts:44
Returns boolean

Methods

addRelated

addRelated(related: Related): void

Inherited from SingleModelRelation.addRelated
- Defined in src/models/relations/SingleModelRelation.ts:52
Parameters
- related: Related
Returns void

attach

attach(model?: Related): Related
attach(attributes: Attributes): Related

Inherited from SingleModelRelation.attach
- Defined in src/models/relations/SingleModelRelation.ts:31
Parameters
- Optional model: Related
Returns Related
Inherited from SingleModelRelation.attach
- Defined in src/models/relations/SingleModelRelation.ts:32
Parameters
- attributes: Attributes
Returns Related

clone

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

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

disable

disable(): void

Inherited from SingleModelRelation.disable
- Defined in src/models/relations/Relation.ts:56
Returns void

enable

enable(): void

Inherited from SingleModelRelation.enable
- Defined in src/models/relations/Relation.ts:52
Returns void

getLoadedModels

getLoadedModels(): Related[]

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

getModels

getModels(): Promise<Related[]>

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

initializeInverseRelations

initializeInverseRelations(model: Related): void

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

isEmpty

isEmpty(): null | boolean

Overrides SingleModelRelation.isEmpty
- Defined in src/models/relations/BelongsToOneRelation.ts:11
Returns null | boolean

isInverseOf

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

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

isRelated

isRelated(related: Related): boolean

Inherited from SingleModelRelation.isRelated
- Defined in src/models/relations/SingleModelRelation.ts:56
Parameters
- related: Related
Returns boolean

load

load(): Promise<null | Related>

Overrides SingleModelRelation.load
- Defined in src/models/relations/BelongsToOneRelation.ts:15
Returns Promise<null | Related>

onDelete

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

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

resolve

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

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

Returns Promise<null | Related | Related[]>

setForeignAttributes

setForeignAttributes(related: Related): void

Overrides SingleModelRelation.setForeignAttributes
- Defined in src/models/relations/BelongsToOneRelation.ts:29
Parameters
- related: Related
Returns void

static

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

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

unload

unload(): void

Inherited from SingleModelRelation.unload
- Defined in src/models/relations/Relation.ts:88
Returns void

Generated using TypeDoc