Class: HasOneRelation<Parent, Related, RelatedClass>
Defined in: packages/soukai/src/models/relations/HasOneRelation.ts:6
Extends
SingleModelRelation
<Parent
,Related
,RelatedClass
>
Type Parameters
Parent
Related
RelatedClass
RelatedClass
extends ModelConstructor
<Related
> = ModelConstructor
<Related
>
Constructors
Constructor
new HasOneRelation<
Parent
,Related
,RelatedClass
>(parent
,relatedClass
,foreignKeyName?
,localKeyName?
):HasOneRelation
<Parent
,Related
,RelatedClass
>
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:16
Parameters
parent
Parent
relatedClass
RelatedClass
foreignKeyName?
string
localKeyName?
string
Returns
HasOneRelation
<Parent
, Related
, RelatedClass
>
Inherited from
SingleModelRelation
.constructor
Properties
_related?
protected
optional
_related:null
|Related
|Related
[]
Defined in: packages/soukai/src/models/relations/Relation.ts:32
Inherited from
deleteStrategy
deleteStrategy:
RelationDeleteStrategy
=null
Defined in: packages/soukai/src/models/relations/Relation.ts:31
Inherited from
SingleModelRelation
.deleteStrategy
enabled
enabled:
boolean
=true
Defined in: packages/soukai/src/models/relations/Relation.ts:30
Inherited from
foreignKeyName
foreignKeyName:
string
Defined in: packages/soukai/src/models/relations/Relation.ts:28
Inherited from
SingleModelRelation
.foreignKeyName
localKeyName
localKeyName:
string
Defined in: packages/soukai/src/models/relations/Relation.ts:29
Inherited from
SingleModelRelation
.localKeyName
name
name:
string
Defined in: packages/soukai/src/models/relations/Relation.ts:25
Inherited from
parent
parent:
Parent
Defined in: packages/soukai/src/models/relations/Relation.ts:26
Inherited from
relatedClass
relatedClass:
RelatedClass
Defined in: packages/soukai/src/models/relations/Relation.ts:27
Inherited from
SingleModelRelation
.relatedClass
inverseBelongsToRelationClasses
static
inverseBelongsToRelationClasses:Constructor
<Relation
<Model
,Model
,ModelConstructor
<Model
>>>[] =[]
Defined in: packages/soukai/src/models/relations/Relation.ts:23
Inherited from
SingleModelRelation
.inverseBelongsToRelationClasses
inverseHasRelationClasses
static
inverseHasRelationClasses:Constructor
<Relation
<Model
,Model
,ModelConstructor
<Model
>>>[] =[]
Defined in: packages/soukai/src/models/relations/Relation.ts:22
Inherited from
SingleModelRelation
.inverseHasRelationClasses
Accessors
loaded
Get Signature
get loaded():
boolean
Defined in: packages/soukai/src/models/relations/Relation.ts:41
Returns
boolean
Inherited from
related
Get Signature
get related():
undefined
|null
|Related
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:25
Returns
undefined
| null
| Related
Set Signature
set related(
related
):void
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:29
Parameters
related
undefined
| null
| Related
Returns
void
Inherited from
Methods
addRelated()
addRelated(
related
):void
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:58
Parameters
related
Related
Returns
void
Inherited from
SingleModelRelation
.addRelated
attach()
Call Signature
attach(
model?
):Related
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:36
Parameters
model?
Related
Returns
Related
Inherited from
Call Signature
attach(
attributes
):Related
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:37
Parameters
attributes
Returns
Related
Inherited from
clearForeignAttributes()
clearForeignAttributes(
related
):void
Defined in: packages/soukai/src/models/relations/HasOneRelation.ts:46
Parameters
related
Related
Returns
void
Overrides
SingleModelRelation
.clearForeignAttributes
clearInverseRelations()
clearInverseRelations(
model
):void
Defined in: packages/soukai/src/models/relations/Relation.ts:147
Parameters
model
Related
Returns
void
Inherited from
SingleModelRelation
.clearInverseRelations
clone()
clone(
options
):this
Defined in: packages/soukai/src/models/relations/Relation.ts:108
Parameters
options
Partial
= {}
Returns
this
Inherited from
disable()
disable():
void
Defined in: packages/soukai/src/models/relations/Relation.ts:64
Returns
void
Inherited from
enable()
enable():
void
Defined in: packages/soukai/src/models/relations/Relation.ts:60
Returns
void
Inherited from
getLoadedModels()
getLoadedModels():
Related
[]
Defined in: packages/soukai/src/models/relations/Relation.ts:94
Returns
Related
[]
Inherited from
SingleModelRelation
.getLoadedModels
getModels()
getModels():
Promise
<Related
[]>
Defined in: packages/soukai/src/models/relations/Relation.ts:86
Returns
Promise
<Related
[]>
Inherited from
initializeInverseRelations()
initializeInverseRelations(
model
):void
Defined in: packages/soukai/src/models/relations/Relation.ts:134
Parameters
model
Related
Returns
void
Inherited from
SingleModelRelation
.initializeInverseRelations
isEmpty()
isEmpty():
null
|boolean
Defined in: packages/soukai/src/models/relations/Relation.ts:82
Returns
null
| boolean
Inherited from
isInverseOf()
isInverseOf(
other
):boolean
Defined in: packages/soukai/src/models/relations/Relation.ts:160
Parameters
other
Returns
boolean
Inherited from
SingleModelRelation
.isInverseOf
isRelated()
isRelated(
related
):boolean
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:74
Parameters
related
Related
Returns
boolean
Inherited from
load()
load():
Promise
<null
|Related
>
Defined in: packages/soukai/src/models/relations/HasOneRelation.ts:12
Returns
Promise
<null
| Related
>
Overrides
onDelete()
onDelete(
strategy
):this
Defined in: packages/soukai/src/models/relations/Relation.ts:102
Parameters
strategy
Returns
this
Inherited from
onRelatedUpdated()
protected
onRelatedUpdated(oldValue
,newValue
):void
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:81
Parameters
oldValue
Nullable
<Model
>
newValue
Nullable
<Model
>
Returns
void
Inherited from
SingleModelRelation
.onRelatedUpdated
removeRelated()
removeRelated(
related
):void
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:66
Parameters
related
Related
Returns
void
Inherited from
SingleModelRelation
.removeRelated
resolve()
resolve():
Promise
<null
|Related
|Related
[]>
Defined in: packages/soukai/src/models/relations/Relation.ts:78
Returns
Promise
<null
| Related
| Related
[]>
Deprecated
This method has been renamed to load
.
Inherited from
setForeignAttributes()
setForeignAttributes(
related
):void
Defined in: packages/soukai/src/models/relations/HasOneRelation.ts:24
Parameters
related
Related
Returns
void
Overrides
SingleModelRelation
.setForeignAttributes
static()
static():
RelationConstructor
<HasOneRelation
<Parent
,Related
,RelatedClass
>>
Defined in: packages/soukai/src/models/relations/Relation.ts:56
Returns
RelationConstructor
<HasOneRelation
<Parent
, Related
, RelatedClass
>>
Inherited from
unload()
unload():
void
Defined in: packages/soukai/src/models/relations/Relation.ts:98
Returns
void