ILinkModule

internal.internal.ILinkModule

Methods

__joinerConfig

__joinerConfig(): ModuleJoinerConfig

Returns

ModuleJoinerConfig

ModuleJoinerConfigOmit<JoinerServiceConfig, "serviceName" | "primaryKeys" | "relationships" | "extends"> & { databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: "date" | "time" | "datetime" | "bigint" | "blob" | "uint8array" | "array" | "enumArray" | "enum" | "json" | "integer" | "smallint" | "tinyint" | "mediumint" | "float" | "double" | "boolean" | "decimal" | "string" | "uuid" | "text" }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string | { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: ModuleJoinerRelationship ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: ModuleJoinerRelationship[] ; schema?: string ; serviceName?: string }Required

---

create

create(primaryKeyOrBulkData, foreignKeyData?, sharedContext?): Promise<unknown[]>

Parameters

primaryKeyOrBulkDatastring | string[] | [string | string[], string, Record<string, unknown\>?][]Required

foreignKeyDatastring

sharedContextContext

Returns

Promise<unknown[]>

PromisePromise<unknown[]>Required

---

delete

delete(data, sharedContext?): Promise<void>

Parameters

dataunknownRequired

sharedContextContext

Returns

Promise<void>

PromisePromise<void>Required

---

dismiss

dismiss(primaryKeyOrBulkData, foreignKeyData?, sharedContext?): Promise<unknown[]>

Parameters

primaryKeyOrBulkDatastring | string[] | [string | string[], string][]Required

foreignKeyDatastring

sharedContextContext

Returns

Promise<unknown[]>

PromisePromise<unknown[]>Required

---

list

list(filters?, config?, sharedContext?): Promise<unknown[]>

Parameters

filtersRecord<string, unknown>

configFindConfig<unknown>

sharedContextContext

Returns

Promise<unknown[]>

PromisePromise<unknown[]>Required

---

listAndCount

listAndCount(filters?, config?, sharedContext?): Promise<[unknown[], number]>

Parameters

filtersRecord<string, unknown>

configFindConfig<unknown>

sharedContextContext

Returns

Promise<[unknown[], number]>

PromisePromise<[unknown[], number]>Required

---

restore

restore(data, config?, sharedContext?): Promise<void | Record<string, unknown[]>>

Parameters

dataunknownRequired

configRestoreReturn

sharedContextContext

Returns

Promise<void | Record<string, unknown[]>>

PromisePromise<void | Record<string, unknown[]>>Required

---

softDelete

softDelete(data, config?, sharedContext?): Promise<void | Record<string, unknown[]>>

Parameters

dataunknownRequired

configSoftDeleteReturn

sharedContextContext

Returns

Promise<void | Record<string, unknown[]>>

PromisePromise<void | Record<string, unknown[]>>Required