Class LangDb

Hierarchy

default<any>
- LangDb

Constructors

constructor

new LangDb(db: IDataBase<any, any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any>): LangDb
Parameters
- db: IDataBase<any, any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
Returns LangDb
Overrides CoreDBPrefab<any>.constructor
- Defined in src/db/LangDb.ts:10

Properties

`Protected` channel

channel: string

db

db: any

lang

lang: default<Language>

logger

logger: null | default

translations

translations: default<Translation>

Methods

canUpdate

canUpdate(): Promise<boolean>
Returns Promise<boolean>
Inherited from CoreDBPrefab.canUpdate
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:20

configExist

configExist(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
Inherited from CoreDBPrefab.configExist
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:31

connect

connect(): Promise<boolean>
Returns Promise<boolean>
Inherited from CoreDBPrefab.connect
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:27

createEntity

createEntity<E>(config: EntityConfig<E>, entity: E): Promise<E>
Create new Entity object
Type Parameters
- E extends default<E>
Parameters
- config: EntityConfig<E>
- entity: E
Returns Promise<E>
Inherited from CoreDBPrefab.createEntity
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:40

debug

debug(...ags: unknown[]): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from CoreDBPrefab.debug
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:9

deleteEntityById

deleteEntityById(className: string, e_id: string): Promise<boolean>
Delete Entity object by ID
Parameters
- className: string
- e_id: string
Returns Promise<boolean>
Inherited from CoreDBPrefab.deleteEntityById
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:59

disconnect

disconnect(): Promise<boolean>
Returns Promise<boolean>
Inherited from CoreDBPrefab.disconnect
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:26

error

error(...ags: unknown[]): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from CoreDBPrefab.error
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:11

execScripts

execScripts(list: RawQuery[]): Promise<any[]>
Parameters
- list: RawQuery[]
Returns Promise<any[]>
Inherited from CoreDBPrefab.execScripts
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:28

findEntity

findEntity<E>(config: EntityConfig<E>, search: { [ P in string | number | symbol]?: E[P] }): Promise<null | E>
Get Entity object list
Type Parameters
- E extends default<E>
Parameters
- config: EntityConfig<E>
- search: { [ P in string | number | symbol]?: E[P] }
Returns Promise<null | E>
Inherited from CoreDBPrefab.findEntity
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:70

getCClient

getCClient<X>(): X
Type Parameters
- X extends ICoreCClient
Returns X
Inherited from CoreDBPrefab.getCClient
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:9

getCache

getCache(): any
Returns any
Inherited from CoreDBPrefab.getCache
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:79

getConfig

getConfig(key: string): Promise<undefined | ConfigType>
Parameters
- key: string
Returns Promise<undefined | ConfigType>
Inherited from CoreDBPrefab.getConfig
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:29

getConfigStore

getConfigStore(): IStore
Returns IStore
Inherited from CoreDBPrefab.getConfigStore
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:8

getCurrenDBVersion

getCurrenDBVersion(): Promise<string>
Returns Promise<string>
Inherited from CoreDBPrefab.getCurrenDBVersion
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:21

getEntityById

getEntityById<E>(config: EntityConfig<E>, id: string): Promise<null | E>
Get Entity object by ID
Type Parameters
- E extends default<E>
Parameters
- config: EntityConfig<E>
- id: string
Returns Promise<null | E>
Inherited from CoreDBPrefab.getEntityById
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:53

getEntityList

getEntityList<E>(query: QueryInterface<E>): Promise<E[]>
Get Entity object list
Type Parameters
- E extends default<E>
Parameters
- query: QueryInterface<E>
Returns Promise<E[]>
Inherited from CoreDBPrefab.getEntityList
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:64

getEntityMeta

getEntityMeta(): {
key: string;
meta: ColumnPropMap<any>;
}[]
Returns {
key: string;
meta: ColumnPropMap<any>;
}[]
Inherited from CoreDBPrefab.getEntityMeta
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:11

getEntityWrapper

getEntityWrapper<E>(className: string): undefined | default<E>
Type Parameters
- E extends default<E>
Parameters
- className: string
Returns undefined | default<E>
Inherited from CoreDBPrefab.getEntityWrapper
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:18

getKernel

getKernel(): ICoreKernel<any, ICoreAnyModule>
Returns ICoreKernel<any, ICoreAnyModule>
Inherited from CoreDBPrefab.getKernel
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:6

getModule

getModule(): ICoreKernelModule<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
Returns ICoreKernelModule<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
Inherited from CoreDBPrefab.getModule
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:7

getName

getName(): string
Returns string
Inherited from CoreDBPrefab.getName
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:15

getPrefabDB

getPrefabDB(): any
Returns any
Inherited from CoreDBPrefab.getPrefabDB
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:15

getRawDBObject

getRawDBObject(): Promise<unknown>
Returns Promise<unknown>
Inherited from CoreDBPrefab.getRawDBObject
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:33

info

info(...ags: unknown[]): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from CoreDBPrefab.info
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:10

initEntity

initEntity<E>(className: string, entity: E): Promise<boolean>
Init Entity object list
Type Parameters
- E extends default<E>
Parameters
- className: string
- entity: E
Returns Promise<boolean>
Inherited from CoreDBPrefab.initEntity
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:78

initNewDB

initNewDB(): Promise<void>
Returns Promise<void>
Inherited from CoreDBPrefab.initNewDB
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:34

initPrefabDB

initPrefabDB(): Promise<void>
Returns Promise<void>
Overrides CoreDBPrefab.initPrefabDB
- Defined in src/db/LangDb.ts:16

isConnected

isConnected(): boolean
Returns boolean
Inherited from CoreDBPrefab.isConnected
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:23

lError

lError(message: string): Error
Parameters
- message: string
Returns Error
Inherited from CoreDBPrefab.lError
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:14

log

log(...ags: unknown[]): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from CoreDBPrefab.log
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:8

registerEntity

registerEntity<E>(ent: E): default<E>
Type Parameters
- E extends default<E>
Parameters
- ent: E
Returns default<E>
Inherited from CoreDBPrefab.registerEntity
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:17

removeConfig

removeConfig(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
Inherited from CoreDBPrefab.removeConfig
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:32

setConfig

setConfig(key: string, value: string): Promise<boolean>
Parameters
- key: string
- value: string
Returns Promise<boolean>
Inherited from CoreDBPrefab.setConfig
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:30

setConnected

setConnected(): void
Returns void
Inherited from CoreDBPrefab.setConnected
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:24

setEntityCache

setEntityCache(status: boolean): void
Parameters
- status: boolean
Returns void
Inherited from CoreDBPrefab.setEntityCache
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:16

setLogger

setLogger(logger: default): void
Parameters
- logger: default
Returns void
Inherited from CoreDBPrefab.setLogger
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:7

setUpdateChain

setUpdateChain(...chain: IBaseDBUpdate[]): void
Parameters
- Rest ...chain: IBaseDBUpdate[]
Returns void
Inherited from CoreDBPrefab.setUpdateChain
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:19

start

start(): Promise<void>
Returns Promise<void>
Inherited from CoreDBPrefab.start
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:25

update

update(): Promise<boolean>
Returns Promise<boolean>
Inherited from CoreDBPrefab.update
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:22

updateEntity

updateEntity<E>(config: EntityConfig<E>, e_id: string, entity: Partial<EProperties<E>>): Promise<boolean>
Update Entity object
Type Parameters
- E extends default<E>
Parameters
- config: EntityConfig<E>
- e_id: string
- entity: Partial<EProperties<E>>
Returns Promise<boolean>
Inherited from CoreDBPrefab.updateEntity
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBPrefab.d.ts:47

verbose

verbose(...ags: unknown[]): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from CoreDBPrefab.verbose
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:13

warn

warn(...ags: unknown[]): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from CoreDBPrefab.warn
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:12

Generated using TypeDoc