JoinRelationships

Class: JoinRelationships<Schema>

Type Parameters

Schema

Schema extends object

Constructors

Constructor

new JoinRelationships<Schema>(): JoinRelationships<Schema>

Returns

JoinRelationships<Schema>

Methods

clear()

clear(): void

Clear all join relationships

Returns

void

define()

define(name, path): void

Define a single join relationship

Parameters

name

string

path

JoinPath<Schema>

Returns

void

defineChain()

defineChain(name, paths): void

Define a chain of join relationships

Parameters

name

string

paths

JoinPath<Schema>[]

Returns

void

get()

get(name): undefined | JoinPath<Schema> | JoinPath<Schema>[]

Get a join relationship by name

Parameters

name

string

Returns

undefined | JoinPath<Schema> | JoinPath<Schema>[]

getDefinedRelationships()

getDefinedRelationships(): string[]

Get all defined relationship names

Returns

string[]

has()

has(name): boolean

Check if a join relationship exists

Parameters

name

string

Returns

boolean

remove()

remove(name): boolean

Remove a join relationship

Parameters

name

string

Returns

boolean