Class OINODbApi

constructor

• new OINODbApi(db, params): OINODbApi

• Constructor of API object. NOTE! OINODb.initDatamodel must be called if created manually instead of the factory.

  Parameters

  • db: OINODb

    database for the API
  • params: OINODbApiParams

    parameters for the API

  Returns OINODbApi

Readonly datamodel

Readonly db

Readonly hashid

Readonly params

doBatchUpdate

• doBatchUpdate(method, data, params?): Promise<OINODbApiResult>

• Method for handlind a HTTP REST request with GET, POST, PUT, DELETE corresponding to SQL select, insert, update and delete.

  Parameters

  • method: string

    HTTP verb (uppercase)
  • data: any

    HTTP body data as either serialized string or unserialized JS object / OINODataRow-array
  • params: OINODbApiRequestParams = API_EMPTY_PARAMS

    HTTP URL parameters as key-value-pairs

  Returns Promise<OINODbApiResult>

doRequest

• doRequest(method, id, data, params?): Promise<OINODbApiResult>

• Method for handlind a HTTP REST request with GET, POST, PUT, DELETE corresponding to SQL select, insert, update and delete.

  Parameters

  • method: string

    HTTP verb (uppercase)
  • id: string

    URL id of the REST request
  • data: any

    HTTP body data as either serialized string or unserialized JS object / OINODataRow-array
  • params: OINODbApiRequestParams = API_EMPTY_PARAMS

    HTTP URL parameters as key-value-pairs

  Returns Promise<OINODbApiResult>

isFieldIncluded

• isFieldIncluded(fieldName): boolean

• Method to check if a field is included in the API params.

  Parameters

  • fieldName: string

    name of the field

  Returns boolean

setDebugOnError

• setDebugOnError(debugOnError): void

• Enable or disable debug output on errors.

  Parameters

  • debugOnError: boolean

    true to enable debug output on errors, false to disable

  Returns void