Class OINODbFactory

Static factory class for easily creating things based on data

Index

Constructors

Methods

createApi createDb createHtmlFromApiResult createHtmlFromData createHtmlFromObject createHtmlFromOinoId createParamsFromRequest createResponseFromApiResult createRows registerDb

Constructors

constructor

new OINODbFactory(): OINODbFactory
Returns OINODbFactory

Methods

`Static`createApi

createApi(db, params): Promise<OINODbApi>
Create API from parameters and calls initDatamodel on the datamodel.
Parameters
- db: OINODb
  databased used in API
- params: OINODbApiParams
  parameters of the API
Returns Promise<OINODbApi>
- Defined in db/src/OINODbFactory.ts:52

`Static`createDb

createDb(params): Promise<OINODb>
Create database from parameters from the registered classes.
Parameters
- params: OINODbParams
  database connection parameters
Returns Promise<OINODb>
- Defined in db/src/OINODbFactory.ts:34

`Static`createHtmlFromApiResult

createHtmlFromApiResult(apiResult, template, includeErrorMessages?, includeWarningMessages?, includeInfoMessages?, includeDebugMessages?): string
Creates HTML Response from API result.
Parameters
- apiResult: OINODbApiResult
  object
- template: string
  HTML template
- includeErrorMessages: boolean = false
  include debug messages in result
- includeWarningMessages: boolean = false
  include debug messages in result
- includeInfoMessages: boolean = false
  include debug messages in result
- includeDebugMessages: boolean = false
  include debug messages in result
Returns string
- Defined in db/src/OINODbFactory.ts:207

`Static`createHtmlFromData

createHtmlFromData(modelset, template): string
Creates HTML Response from API modelset.
Parameters
- modelset: OINODbModelSet
  OINO API dataset
- template: string
  HTML template
Returns string
- Defined in db/src/OINODbFactory.ts:138

`Static`createHtmlFromObject

createHtmlFromObject(object, template): string
Creates HTML Response from object properties.
Parameters
- object: any
  object
- template: string
  HTML template
Returns string
- Defined in db/src/OINODbFactory.ts:184

`Static`createHtmlFromOinoId

createHtmlFromOinoId(oinoId, template): string
Creates HTML Response from a row id.
Parameters
- oinoId: string
  OINO id
- template: string
  HTML template
Returns string
- Defined in db/src/OINODbFactory.ts:172

`Static`createParamsFromRequest

createParamsFromRequest(request): OINORequestParams
Creates a key-value-collection from Javascript URL parameters.
Parameters
- request: Request
  HTTP Request
Returns OINORequestParams
- Defined in db/src/OINODbFactory.ts:63

`Static`createResponseFromApiResult

createResponseFromApiResult(apiResult, requestParams, responseHeaders?): Response
Creates a HTTP Response from API results.
Parameters
- apiResult: OINODbApiResult
  API results
- requestParams: OINORequestParams
  API request parameters
- responseHeaders: Record<string, string> = {}
  Headers to include in the response
Returns Response
- Defined in db/src/OINODbFactory.ts:118

`Static`createRows

createRows(datamodel, data, requestParams): OINODataRow[]
Create data rows from request body based on the datamodel.
Parameters
- datamodel: OINODbDataModel
  datamodel of the api
- data: string
  data as a string
- requestParams: OINORequestParams
  parameters
Returns OINODataRow[]
- Defined in db/src/OINODbFactory.ts:549

`Static`registerDb

registerDb(dbName, dbTypeClass): void
Register a supported database class. Used to enable those that are installed in the factory instead of forcing everyone to install all database libraries.
Parameters
- dbName: string
  name of the database implementation class
- dbTypeClass: OINODbConstructor
  constructor for creating a database of that type
Returns void
- Defined in db/src/OINODbFactory.ts:23