Skip to main content
Version: 4.5

Interface: ManyToManyOptions<T, O>#

core.ManyToManyOptions

Type parameters#

Name
T
O

Hierarchy#

Properties#

cascade#

Optional cascade: Cascade[]

Inherited from: ReferenceOptions.cascade

Defined in: packages/core/src/decorators/Property.ts:67


columnType#

Optional columnType: string

Inherited from: ReferenceOptions.columnType

Defined in: packages/core/src/decorators/Property.ts:42


comment#

Optional comment: string

Inherited from: ReferenceOptions.comment

Defined in: packages/core/src/decorators/Property.ts:62


customType#

Optional customType: Type<any, any>

Inherited from: ReferenceOptions.customType

Defined in: packages/core/src/decorators/Property.ts:41


default#

Optional default: null | string | number | boolean | string[] | number[]

Inherited from: ReferenceOptions.default

Defined in: packages/core/src/decorators/Property.ts:47


defaultRaw#

Optional defaultRaw: string

Inherited from: ReferenceOptions.defaultRaw

Defined in: packages/core/src/decorators/Property.ts:48


eager#

Optional eager: boolean

Inherited from: ReferenceOptions.eager

Defined in: packages/core/src/decorators/Property.ts:68


entity#

Optional entity: string | () => EntityName<T>

Inherited from: ReferenceOptions.entity

Defined in: packages/core/src/decorators/Property.ts:66


fieldName#

Optional fieldName: string

Inherited from: ReferenceOptions.fieldName

Defined in: packages/core/src/decorators/Property.ts:39


fieldNames#

Optional fieldNames: string[]

Inherited from: ReferenceOptions.fieldNames

Defined in: packages/core/src/decorators/Property.ts:40


fixedOrder#

Optional fixedOrder: boolean

Defined in: packages/core/src/decorators/ManyToMany.ts:28


fixedOrderColumn#

Optional fixedOrderColumn: string

Defined in: packages/core/src/decorators/ManyToMany.ts:29


formula#

Optional formula: string | (alias: string) => string

Inherited from: ReferenceOptions.formula

Defined in: packages/core/src/decorators/Property.ts:49


hidden#

Optional hidden: boolean

Inherited from: ReferenceOptions.hidden

Defined in: packages/core/src/decorators/Property.ts:53


index#

Optional index: string | boolean

Inherited from: ReferenceOptions.index

Defined in: packages/core/src/decorators/Property.ts:55


inverseJoinColumn#

Optional inverseJoinColumn: string

Defined in: packages/core/src/decorators/ManyToMany.ts:33


inverseJoinColumns#

Optional inverseJoinColumns: string[]

Defined in: packages/core/src/decorators/ManyToMany.ts:34


inversedBy#

Optional inversedBy: string & keyof T | (e: T) => any

Defined in: packages/core/src/decorators/ManyToMany.ts:25


joinColumn#

Optional joinColumn: string

Defined in: packages/core/src/decorators/ManyToMany.ts:31


joinColumns#

Optional joinColumns: string[]

Defined in: packages/core/src/decorators/ManyToMany.ts:32


lazy#

Optional lazy: boolean

Inherited from: ReferenceOptions.lazy

Defined in: packages/core/src/decorators/Property.ts:57


length#

Optional length: number

Inherited from: ReferenceOptions.length

Defined in: packages/core/src/decorators/Property.ts:44


mappedBy#

Optional mappedBy: string & keyof T | (e: T) => any

Defined in: packages/core/src/decorators/ManyToMany.ts:26


name#

Optional name: string

Inherited from: ReferenceOptions.name

Defined in: packages/core/src/decorators/Property.ts:38


nullable#

Optional nullable: boolean

Inherited from: ReferenceOptions.nullable

Defined in: packages/core/src/decorators/Property.ts:50


onCreate#

Optional onCreate: (entity: O) => any

Type declaration:#

▸ (entity: O): any

Parameters:#

NameType
entityO

Returns: any

Defined in: packages/core/src/decorators/Property.ts:45

Inherited from: ReferenceOptions.onCreate

Defined in: packages/core/src/decorators/Property.ts:45


onUpdate#

Optional onUpdate: (entity: O) => any

Type declaration:#

▸ (entity: O): any

Parameters:#

NameType
entityO

Returns: any

Defined in: packages/core/src/decorators/Property.ts:46

Inherited from: ReferenceOptions.onUpdate

Defined in: packages/core/src/decorators/Property.ts:46


orderBy#

Optional orderBy: object

Type declaration:#

Defined in: packages/core/src/decorators/ManyToMany.ts:27


owner#

Optional owner: boolean

Defined in: packages/core/src/decorators/ManyToMany.ts:24


persist#

Optional persist: boolean

Inherited from: ReferenceOptions.persist

Defined in: packages/core/src/decorators/Property.ts:52


pivotTable#

Optional pivotTable: string

Defined in: packages/core/src/decorators/ManyToMany.ts:30


primary#

Optional primary: boolean

Inherited from: ReferenceOptions.primary

Defined in: packages/core/src/decorators/Property.ts:58


referenceColumnName#

Optional referenceColumnName: string

Defined in: packages/core/src/decorators/ManyToMany.ts:35


serializedName#

Optional serializedName: string

Inherited from: ReferenceOptions.serializedName

Defined in: packages/core/src/decorators/Property.ts:61


serializedPrimaryKey#

Optional serializedPrimaryKey: boolean

Inherited from: ReferenceOptions.serializedPrimaryKey

Defined in: packages/core/src/decorators/Property.ts:59


serializer#

Optional serializer: (value: any) => any

Type declaration:#

▸ (value: any): any

Parameters:#

NameType
valueany

Returns: any

Defined in: packages/core/src/decorators/Property.ts:60

Inherited from: ReferenceOptions.serializer

Defined in: packages/core/src/decorators/Property.ts:60


strategy#

Optional strategy: LoadStrategy

Inherited from: ReferenceOptions.strategy

Defined in: packages/core/src/decorators/Property.ts:69


type#

Optional type: unknown

Inherited from: ReferenceOptions.type

Defined in: packages/core/src/decorators/Property.ts:43


unique#

Optional unique: string | boolean

Inherited from: ReferenceOptions.unique

Defined in: packages/core/src/decorators/Property.ts:56


unsigned#

Optional unsigned: boolean

Inherited from: ReferenceOptions.unsigned

Defined in: packages/core/src/decorators/Property.ts:51


version#

Optional version: boolean

Inherited from: ReferenceOptions.version

Defined in: packages/core/src/decorators/Property.ts:54

Last updated on by Renovate Bot