Class Database<T>

Readonlydebug

Readonlyname

dateFormat

• get dateFormat(): string

  Returns string

timeFormat

• get timeFormat(): string

  Returns string

timeStampFormat

• get timeStampFormat(): string

  Returns string

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

  Returns Promise<void>

clearLayoutCache

• clearLayoutCache(): void

  Returns void

close

• close(): Promise<void>

  Returns Promise<void>

connect

• connect(): Promise<void>

  Returns Promise<void>

execute

• execute<K extends keyof DatabaseOperationMap>(
      operation: DatabaseOperation<K>,
  ): Promise<{ binding: SessionBinding; value: DatabaseOperationResult<K> }>

  Type Parameters

  • K extends keyof DatabaseOperationMap

  Parameters

  • operation: DatabaseOperation<K>

  Returns Promise<{ binding: SessionBinding; value: DatabaseOperationResult<K> }>

fetchContainer

• fetchContainer(
      reference: string,
      binding: SessionBinding,
      signal?: AbortSignal,
  ): Promise<Response>

  Parameters

  • reference: string
  • binding: SessionBinding
  • Optionalsignal: AbortSignal

  Returns Promise<Response>

layout

• layout<R extends string | number | symbol>(name: R): Layout<T["layouts"][R]>

  Type Parameters

  • R extends string | number | symbol

  Parameters

  • name: R

  Returns Layout<T["layouts"][R]>

• layout<R extends LayoutInterface>(name: string): Layout<R>

  Type Parameters

  • R extends LayoutInterface

  Parameters

  • name: string

  Returns Layout<R>

listLayouts

• listLayouts(page?: number): Promise<Layout<LayoutInterface>[]>

  Parameters

  • page: number = 0

  Returns Promise<Layout<LayoutInterface>[]>

login

• login(): Promise<void>

  Returns Promise<void>

logout

• logout(): Promise<void>

  Returns Promise<void>

script

• script(name: string, parameter?: string): Script

  Parameters

  • name: string
  • parameter: string = ''

  Returns Script

Staticcreate

• create<T extends DatabaseStructure = DatabaseStructure>(
      options: DatabaseOptions,
  ): Database<T>

  Type Parameters

  • T extends DatabaseStructure = DatabaseStructure

  Parameters

  • options: DatabaseOptions

  Returns Database<T>