internals | @dvelop-sdk

Index

Interfaces Error

BusinessObjectsErrorDto

Functions Entity

Functions Http

Entity Functions

_createBoEntityFactory

_createBoEntityFactory<E, R>(httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>), transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateBoEntityParams<E>) => R)): ((context: DvelopContext, params: CreateBoEntityParams<E>) => Promise<R>)

- Defined in packages/business-objects/src/entities/create-entity/create-entity.ts:25
Factory for createBoEntity-function. See Advanced Topics for more information.

internal
Type Parameters
- E
  
  Type for Entity to be created.
- R
  
  Return type of the createBoEntity-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateBoEntityParams<E>) => R)
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateBoEntityParams<E>): R
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: CreateBoEntityParams<E>
      Returns R
Returns ((context: DvelopContext, params: CreateBoEntityParams<E>) => Promise<R>)
- - (context: DvelopContext, params: CreateBoEntityParams<E>): Promise<R>
  - Factory for createBoEntity-function. See Advanced Topics for more information.
    
    internal
    category
    Entity
    
    Parameters
    - context: DvelopContext
    - params: CreateBoEntityParams<E>
    Returns Promise<R>

_deleteBoEntityFactory

_deleteBoEntityFactory<T>(httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>), transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: DeleteBoEntityParams) => T)): ((context: DvelopContext, params: DeleteBoEntityParams) => Promise<T>)

- Defined in packages/business-objects/src/entities/delete-entity/delete-entity.ts:25
Factory for deleteBoEntity-function. See Advanced Topics for more information.

internal
Type Parameters
- T
Parameters
- httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: DeleteBoEntityParams) => T)
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: DeleteBoEntityParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: DeleteBoEntityParams
      Returns T
Returns ((context: DvelopContext, params: DeleteBoEntityParams) => Promise<T>)
- - (context: DvelopContext, params: DeleteBoEntityParams): Promise<T>
  - Factory for deleteBoEntity-function. See Advanced Topics for more information.
    
    internal
    category
    Entity
    
    Parameters
    - context: DvelopContext
    - params: DeleteBoEntityParams
    Returns Promise<T>

_getBoEntitiesDefaultTransformFunctionFactory

_getBoEntitiesDefaultTransformFunctionFactory<E>(httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)): ((response: HttpResponse, context: DvelopContext, params: GetBoEntitiesParams) => GetBoEntitiesResultPage<E>)

- Defined in packages/business-objects/src/entities/get-entities/get-entities.ts:32
Default transform-function provided to the getBoEntities-function. See Advanced Topics for more information.

internal
Type Parameters
- E
  
  Return type
Parameters
- httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
Returns ((response: HttpResponse, context: DvelopContext, params: GetBoEntitiesParams) => GetBoEntitiesResultPage<E>)
- - (response: HttpResponse, context: DvelopContext, params: GetBoEntitiesParams): GetBoEntitiesResultPage<E>
  - Default transform-function provided to the getBoEntities-function. See Advanced Topics for more information.
    
    internal
    category
    Entity
    
    Parameters
    - response: HttpResponse
    - context: DvelopContext
    - params: GetBoEntitiesParams
    Returns GetBoEntitiesResultPage<E>

_getBoEntitiesFactory

_getBoEntitiesFactory<E>(httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>), transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: GetBoEntitiesParams) => GetBoEntitiesResultPage<E>)): ((context: DvelopContext, params: GetBoEntitiesParams) => Promise<GetBoEntitiesResultPage<E>>)

- Defined in packages/business-objects/src/entities/get-entities/get-entities.ts:59
Factory for getBoEntities-function. See Advanced Topics for more information.

internal
Type Parameters
- E
  
  Return type of the getBoEntities-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: GetBoEntitiesParams) => GetBoEntitiesResultPage<E>)
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetBoEntitiesParams): GetBoEntitiesResultPage<E>
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: GetBoEntitiesParams
      Returns GetBoEntitiesResultPage<E>
Returns ((context: DvelopContext, params: GetBoEntitiesParams) => Promise<GetBoEntitiesResultPage<E>>)
- - (context: DvelopContext, params: GetBoEntitiesParams): Promise<GetBoEntitiesResultPage<E>>
  - Factory for getBoEntities-function. See Advanced Topics for more information.
    
    internal
    category
    Entity
    
    Parameters
    - context: DvelopContext
    - params: GetBoEntitiesParams
    Returns Promise<GetBoEntitiesResultPage<E>>

_getBoEntityDefaultTransformFunction

_getBoEntityDefaultTransformFunction<E>(response: DvelopHttpResponse<any>, _: DvelopContext, __: GetBoEntityParams): E

- Defined in packages/business-objects/src/entities/get-entity/get-entity.ts:25
Default transform-function provided to the getBoEntity-function. See Advanced Topics for more information.

internal
Type Parameters
- E = any
  
  Return type
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
- __: GetBoEntityParams
Returns E

_getBoEntityFactory

_getBoEntityFactory<E>(httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>), transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: GetBoEntityParams) => E)): ((context: DvelopContext, params: GetBoEntityParams) => Promise<E>)

- Defined in packages/business-objects/src/entities/get-entity/get-entity.ts:39
Factory for getBoEntity-function. See Advanced Topics for more information.

internal
Type Parameters
- E
  
  Return type of the getBoEntity-function. A corresponding transformFunction has to be supplied.
Parameters
- httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: GetBoEntityParams) => E)
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: GetBoEntityParams): E
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: GetBoEntityParams
      Returns E
Returns ((context: DvelopContext, params: GetBoEntityParams) => Promise<E>)
- - (context: DvelopContext, params: GetBoEntityParams): Promise<E>
  - Factory for getBoEntity-function. See Advanced Topics for more information.
    
    internal
    category
    Entity
    
    Parameters
    - context: DvelopContext
    - params: GetBoEntityParams
    Returns Promise<E>

_updateBoEntityFactory

_updateBoEntityFactory<E, R>(httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>), transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateBoEntityParams<E>) => R)): ((context: DvelopContext, params: UpdateBoEntityParams) => Promise<R>)

- Defined in packages/business-objects/src/entities/update-entity/update-entity.ts:28
Factory for updateBoEntity-function. See Advanced Topics for more information.

internal
Type Parameters
- E
  
  Return type of the updateBoEntity-function. A corresponding transformFunction has to be supplied.
- R
Parameters
- httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)
  - - (context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse<any>>
    - Parameters
      - context: DvelopContext
      - config: DvelopHttpRequestConfig<any>
      Returns Promise<DvelopHttpResponse<any>>
- transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateBoEntityParams<E>) => R)
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateBoEntityParams<E>): R
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: UpdateBoEntityParams<E>
      Returns R
Returns ((context: DvelopContext, params: UpdateBoEntityParams) => Promise<R>)
- - (context: DvelopContext, params: UpdateBoEntityParams): Promise<R>
  - Factory for updateBoEntity-function. See Advanced Topics for more information.
    
    internal
    category
    Entity
    
    Parameters
    - context: DvelopContext
    - params: UpdateBoEntityParams
    Returns Promise<R>

Http Functions

_defaultHttpRequestFunction

_defaultHttpRequestFunction(context: DvelopContext, config: DvelopHttpRequestConfig<any>): Promise<DvelopHttpResponse>

- Defined in packages/business-objects/src/utils/http.ts:128
Default httpRequestFunction used in dms-package. See Advanced Topics for more information.

internal
Parameters
- context: DvelopContext
- config: DvelopHttpRequestConfig<any>
Returns Promise<DvelopHttpResponse>

_defaultHttpRequestFunctionFactory

_defaultHttpRequestFunctionFactory(httpClient: DvelopHttpClient): ((context: DvelopContext, config: DvelopHttpRequestConfig) => Promise<DvelopHttpResponse>)

- Defined in packages/business-objects/src/utils/http.ts:81
Factory used to create the default httpRequestFunction. See Advanced Topics for more information.

internal
Parameters
- httpClient: DvelopHttpClient
Returns ((context: DvelopContext, config: DvelopHttpRequestConfig) => Promise<DvelopHttpResponse>)
- - (context: DvelopContext, config: DvelopHttpRequestConfig): Promise<DvelopHttpResponse>
  - Factory used to create the default httpRequestFunction. See Advanced Topics for more information.
    
    internal
    category
    Http
    
    Parameters
    - context: DvelopContext
    - config: DvelopHttpRequestConfig
    Returns Promise<DvelopHttpResponse>

Index

Interfaces Error

Functions Entity

Functions Http

Entity Functions

_createBoEntityFactory

Type Parameters

E

R

Parameters

httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)

Parameters

context: DvelopContext

config: DvelopHttpRequestConfig<any>

Returns Promise<DvelopHttpResponse<any>>

transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateBoEntityParams<E>) => R)

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: CreateBoEntityParams<E>

Returns R

Returns ((context: DvelopContext, params: CreateBoEntityParams<E>) => Promise<R>)

Parameters

context: DvelopContext

params: CreateBoEntityParams<E>

Returns Promise<R>

_deleteBoEntityFactory

Type Parameters

T

Parameters

httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)

Parameters

context: DvelopContext

config: DvelopHttpRequestConfig<any>

Returns Promise<DvelopHttpResponse<any>>

transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: DeleteBoEntityParams) => T)

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: DeleteBoEntityParams

Returns T

Returns ((context: DvelopContext, params: DeleteBoEntityParams) => Promise<T>)

Parameters

context: DvelopContext

params: DeleteBoEntityParams

Returns Promise<T>

_getBoEntitiesDefaultTransformFunctionFactory

Type Parameters

E

Parameters

httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)

Parameters

context: DvelopContext

config: DvelopHttpRequestConfig<any>

Returns Promise<DvelopHttpResponse<any>>

Returns ((response: HttpResponse, context: DvelopContext, params: GetBoEntitiesParams) => GetBoEntitiesResultPage<E>)

Parameters

response: HttpResponse

context: DvelopContext

params: GetBoEntitiesParams

Returns GetBoEntitiesResultPage<E>

_getBoEntitiesFactory

Type Parameters

E

Parameters

httpRequestFunction: ((context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>)

Parameters

context: DvelopContext

config: DvelopHttpRequestConfig<any>

Returns Promise<DvelopHttpResponse<any>>

transformFunction: ((response: DvelopHttpResponse<any>, context: DvelopContext, params: GetBoEntitiesParams) => GetBoEntitiesResultPage<E>)

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: GetBoEntitiesParams

Returns GetBoEntitiesResultPage<E>

Returns ((context: DvelopContext, params: GetBoEntitiesParams) => Promise<GetBoEntitiesResultPage<E>>)

Parameters

context: DvelopContext

params: GetBoEntitiesParams