Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthDb

Hierarchy

  • default<CoreDBCon<any, any>>
    • AuthDb

Index

Constructors

Properties

Methods

Constructors

constructor

  • new AuthDb(dbCon: default<any, any>): AuthDb

Properties

authUser

authUser: default<default>

Protected channel

channel: string

db

db: default<any, any>

groupMap

groupMap: default<default>

groups

groups: default<default>

logger

logger: null | default

permission

permission: default<default>

userMap

userMap: default<default>

Methods

canUpdate

  • canUpdate(): Promise<boolean>

  • Returns Promise<boolean>

configExist

  • configExist(key: string): Promise<boolean>

  • Parameters

    • key: string

    Returns Promise<boolean>

connect

  • connect(): Promise<boolean>

  • Returns Promise<boolean>

createEntity

  • createEntity<E>(config: EntityConfig<E>, entity: E): Promise<E>

  • Create new Entity object

    Type parameters

    • E: default<E>

    Parameters

    • config: EntityConfig<E>
    • entity: E

    Returns Promise<E>

debug

  • debug(...ags: unknown[]): void

  • Parameters

    • Rest ...ags: unknown[]

    Returns void

deleteEntityById

  • deleteEntityById(className: string, e_id: string): Promise<boolean>

  • Delete Entity object by ID

    Parameters

    • className: string
    • e_id: string

    Returns Promise<boolean>

disconnect

  • disconnect(): Promise<boolean>

  • Returns Promise<boolean>

error

  • error(...ags: unknown[]): void

  • Parameters

    • Rest ...ags: unknown[]

    Returns void

execScripts

  • execScripts(list: RawQuery[]): Promise<default<any, any>[]>

  • Parameters

    • list: RawQuery[]

    Returns Promise<default<any, any>[]>

findEntity

  • findEntity<E>(config: EntityConfig<E>, search: { [ P in string | number | symbol]?: E[P] }): Promise<null | E>

  • Get Entity object list

    Type parameters

    • E: default<E>

    Parameters

    • config: EntityConfig<E>
    • search: { [ P in string | number | symbol]?: E[P] }

    Returns Promise<null | E>

getCache

  • getCache<E>(): null | E

  • Type parameters

    • E: ICoreCache

    Returns null | E

getConfig

  • getConfig(key: string): Promise<undefined | ConfigType>

  • Parameters

    • key: string

    Returns Promise<undefined | ConfigType>

getCurrenDBVersion

  • getCurrenDBVersion(): Promise<string>

  • Returns Promise<string>

getEntityById

  • getEntityById<E>(config: EntityConfig<E>, id: string): Promise<null | E>

  • Get Entity object by ID

    Type parameters

    • E: default<E>

    Parameters

    • config: EntityConfig<E>
    • id: string

    Returns Promise<null | E>

getEntityList

  • getEntityList<E>(query: QueryInterface<E>): Promise<E[]>

  • Get Entity object list

    Type parameters

    • E: default<E>

    Parameters

    • query: QueryInterface<E>

    Returns Promise<E[]>

getEntityMeta

  • getEntityMeta(): { key: string; meta: ColumnPropMap<any> }[]

  • Returns { key: string; meta: ColumnPropMap<any> }[]

getEntityWrapper

  • getEntityWrapper<E>(className: string): undefined | default<E>

  • Type parameters

    • E: default<E>

    Parameters

    • className: string

    Returns undefined | default<E>

getGroupPermissions

  • getGroupPermissions(id: string): Promise<default[]>

getKernel

  • getKernel(): ICoreKernel<any>

  • Returns ICoreKernel<any>

getModule

  • getModule<M>(): M

  • Type parameters

    • M: ICoreKernelModule<any, any, any, any, any, M>

    Returns M

getName

  • getName(): string

  • Returns string

getPrefabDB

  • getPrefabDB(): default<any, any>

  • Returns default<any, any>

getRawDBObject

  • getRawDBObject(): Promise<unknown>

  • Returns Promise<unknown>

getUserByName

  • getUserByName(name: string): Promise<null | default>

getUserGroups

  • getUserGroups(userId: string): Promise<default[]>

getUserPermissionsById

  • getUserPermissionsById(userId: string): Promise<default[]>

info

  • info(...ags: unknown[]): void

  • Parameters

    • Rest ...ags: unknown[]

    Returns void

initEntity

  • initEntity<E>(className: string, entity: E): Promise<boolean>

  • Init Entity object list

    Type parameters

    • E: default<E>

    Parameters

    • className: string
    • entity: E

    Returns Promise<boolean>

initNewDB

  • initNewDB(): Promise<void>

  • Returns Promise<void>

initPrefabDB

  • initPrefabDB(): Promise<void>

isConnected

  • isConnected(): boolean

  • Returns boolean

lError

  • lError(message: string): Error

  • Parameters

    • message: string

    Returns Error

log

  • log(...ags: unknown[]): void

  • Parameters

    • Rest ...ags: unknown[]

    Returns void

registerEntity

  • registerEntity<E>(ent: E): default<E>

  • Type parameters

    • E: default<E>

    Parameters

    • ent: E

    Returns default<E>

removeConfig

  • removeConfig(key: string): Promise<void>

  • Parameters

    • key: string

    Returns Promise<void>

setConfig

  • setConfig(key: string, value: string): Promise<boolean>

  • Parameters

    • key: string
    • value: string

    Returns Promise<boolean>

setConnected

  • setConnected(): void

  • Returns void

setEntityCache

  • setEntityCache(status: boolean): void

  • Parameters

    • status: boolean

    Returns void

setLogger

  • setLogger(logger: default): void

  • Parameters

    • logger: default

    Returns void

setUpdateChain

  • setUpdateChain(...chain: IBaseDBUpdate[]): void

  • Parameters

    • Rest ...chain: IBaseDBUpdate[]

    Returns void

start

  • start(): Promise<void>

  • Returns Promise<void>

update

  • update(): Promise<boolean>

  • Returns Promise<boolean>

updateEntity

  • updateEntity<E>(config: EntityConfig<E>, e_id: string, entity: Partial<EProperties<E>>): Promise<boolean>

  • Update Entity object

    Type parameters

    • E: default<E>

    Parameters

    • config: EntityConfig<E>
    • e_id: string
    • entity: Partial<EProperties<E>>

    Returns Promise<boolean>

verbose

  • verbose(...ags: unknown[]): void

  • Parameters

    • Rest ...ags: unknown[]

    Returns void

warn

  • warn(...ags: unknown[]): void

  • Parameters

    • Rest ...ags: unknown[]

    Returns void

Generated using TypeDoc