Constructor

# new UserRelation(data)

creates new user-user relation data holder

Parameters:

Name	Type	Description
`data`	`object`

View Source classes/userRelation.ts, line 9

Classes

UserRelation

Methods

# async static fromDatabase(data, ctx) → {Promise.<UserRelation>}

Parameters:

Name	Type	Description
`data`	`DBUserRelation` \| `DBUserRelationAuthor` \| `DBUserRelationFull` \| `DBUserRelationTarget`
`ctx`	`RequestContext`

View Source classes/userRelation.ts, line 170

Returns:

Type: Promise.<UserRelation>

# async static load(target, ctx) → {Promise.<UserRelation>}

Loads user relation

Parameters:

Name	Type	Description
`target`	`User`
`ctx`	`RequestContextWithClient`

View Source classes/userRelation.ts, line 179

Returns:

Type: Promise.<UserRelation>

# async static upsert(target, type, ctx) → {Promise.<UserRelation>}

Creates or updates a relation

Parameters:

Name	Type	Description
`target`	`User`
`type`	`UserRelationType`
`ctx`	`RequestContextWithClient`

View Source classes/userRelation.ts, line 191

Throws:

if client is not set

Type: Error

Returns:

Type: Promise.<UserRelation>

# async delete() → {Promise.<void>}

Deletes user relation

View Source classes/userRelation.ts, line 205

Returns:

Type: Promise.<void>

# toJSON() → {Object}

Creates a JSON-compatible object

View Source classes/userRelation.ts, line 211

Returns:

Type: Object

# async update() → {Promise.<void>}

Updates user relation

View Source classes/userRelation.ts, line 198

Returns:

Type: Promise.<void>

Animasher docs

# new UserRelation(data)

Parameters:

Classes

Methods

# async static fromDatabase(data, ctx) → {Promise.<UserRelation>}

Parameters:

# async static load(target, ctx) → {Promise.<UserRelation>}

Parameters:

# async static upsert(target, type, ctx) → {Promise.<UserRelation>}

Parameters:

# async delete() → {Promise.<void>}

# toJSON() → {Object}

# async update() → {Promise.<void>}