Interface ICoreEntityHandler<C>

Type Parameters

C extends ICoreCache | null = any

Hierarchy

ILogChannel
- ICoreEntityHandler
  - IDataBase

Index

Methods

createEntity debug deleteEntityById error findEntity getCache getEntityById getEntityList getEntityMeta getName info initEntity lError log updateEntity verbose warn

Methods

createEntity

createEntity<E>(config, entity): Promise<E>
Type Parameters
- E extends IEntity
Parameters
- config: EntityConfig<E>
- entity: EProperties<E>
Returns Promise<E>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:19

debug

debug(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from ILogChannel.debug
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:158

deleteEntityById

deleteEntityById(className, e_id): Promise<boolean>
Parameters
- className: string
- e_id: string
Returns Promise<boolean>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:22

error

error(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from ILogChannel.error
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:160

findEntity

findEntity<E>(config, search): Promise<null | E>
Type Parameters
- E extends IEntity
Parameters
- config: EntityConfig<E>
- search: {
  [P in string | number | symbol]?: E[P]
  }
Returns Promise<null | E>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:24

getCache

getCache(): null | C
Returns null | C
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:18

getEntityById

getEntityById<E>(config, e_id): Promise<null | E>
Type Parameters
- E extends IEntity
Parameters
- config: EntityConfig<E>
- e_id: string
Returns Promise<null | E>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:21

getEntityList

getEntityList<E>(query): Promise<E[]>
Type Parameters
- E extends IEntity
Parameters
- query: QueryInterface<E>
Returns Promise<E[]>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:23

getEntityMeta

getEntityMeta(): ICoreEntityMetaInterface[]
Returns ICoreEntityMetaInterface[]
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:17

getName

getName(): string
Returns string
Inherited from ILogChannel.getName
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:164

info

info(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from ILogChannel.info
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:159

initEntity

initEntity<E>(className, entity): Promise<boolean>
Type Parameters
- E extends IEntity
Parameters
- className: string
- entity: E
Returns Promise<boolean>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:27

lError

lError(message): Error
Parameters
- message: string
Returns Error
Inherited from ILogChannel.lError
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:163

log

log(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from ILogChannel.log
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:157

updateEntity

updateEntity<E>(config, e_id, entity): Promise<boolean>
Type Parameters
- E extends IEntity
Parameters
- config: EntityConfig<E>
- e_id: string
- entity: Partial<EProperties<E>>
Returns Promise<boolean>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:20

verbose

verbose(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from ILogChannel.verbose
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:162

warn

warn(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from ILogChannel.warn
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:161

Generated using TypeDoc