internals | @dvelop-sdk

Index

Functions Task

Functions Http

Task Functions

_completeTaskFactory

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

- Defined in packages/task/src/tasks/complete-task/complete-task.ts:19
Factory for the completeTask-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the completeTask-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: CompleteTaskParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: CompleteTaskParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: CompleteTaskParams
      Returns T
Returns (context: DvelopContext, params: CompleteTaskParams) => Promise<T>
- - (context: DvelopContext, params: CompleteTaskParams): Promise<T>
  - Factory for the completeTask-function. See Advanced Topics for more information.
    
    internal
    category
    Task
    
    Parameters
    - context: DvelopContext
    - params: CompleteTaskParams
    Returns Promise<T>

_createTaskDefaultTransformFunction

_createTaskDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext, __: CreateTaskParams): string

- Defined in packages/task/src/tasks/create-task/create-task.ts:92
Default transform-function provided to the createTask-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
- __: CreateTaskParams
Returns string

_createTaskFactory

_createTaskFactory<T>(httpRequestFunction: (context: DvelopContext, config: DvelopHttpRequestConfig<any>) => Promise<DvelopHttpResponse<any>>, transformFunction: (response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateTaskParams) => T, uuidGeneratorFunction?: () => string): (context: DvelopContext, params: CreateTaskParams) => Promise<T>

- Defined in packages/task/src/tasks/create-task/create-task.ts:102
Factory for the createTask-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the createTask-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: CreateTaskParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: CreateTaskParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: CreateTaskParams
      Returns T
- Optional uuidGeneratorFunction: () => string
  - - (): string
    - Returns string
Returns (context: DvelopContext, params: CreateTaskParams) => Promise<T>
- - (context: DvelopContext, params: CreateTaskParams): Promise<T>
  - Factory for the createTask-function. See Advanced Topics for more information.
    
    internal
    category
    Task
    
    Parameters
    - context: DvelopContext
    - params: CreateTaskParams
    Returns Promise<T>

_deleteTaskFactory

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

- Defined in packages/task/src/tasks/delete-task/delete-task.ts:19
Factory for the deleteTask-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the deleteTask-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: DeleteTaskParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: DeleteTaskParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: DeleteTaskParams
      Returns T
Returns (context: DvelopContext, params: DeleteTaskParams) => Promise<T>
- - (context: DvelopContext, params: DeleteTaskParams): Promise<T>
  - Factory for the deleteTask-function. See Advanced Topics for more information.
    
    internal
    category
    Task
    
    Parameters
    - context: DvelopContext
    - params: DeleteTaskParams
    Returns Promise<T>

_getTaskCountDefaultTransformFunction

_getTaskCountDefaultTransformFunction(response: DvelopHttpResponse<any>, _: DvelopContext): number

- Defined in packages/task/src/tasks/get-task-count/get-task-count.ts:9
Default transform-function provided to the getTaskCount-function. See Advanced Topics for more information.

internal
Parameters
- response: DvelopHttpResponse<any>
- _: DvelopContext
Returns number

_getTaskCountFactory

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

- Defined in packages/task/src/tasks/get-task-count/get-task-count.ts:19
Factory for the getTaskCount-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the getTaskCount-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) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      Returns T
Returns (context: DvelopContext) => Promise<T>
- - (context: DvelopContext): Promise<T>
  - Factory for the getTaskCount-function. See Advanced Topics for more information.
    
    internal
    category
    Task
    
    Parameters
    - context: DvelopContext
    Returns Promise<T>

_updateTaskFactory

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

- Defined in packages/task/src/tasks/update-task/update-task.ts:94
Factory for the updateTask-function. See Advanced Topics for more information.

internal
Type parameters
- T
  
  Return type of the updateTask-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: UpdateTaskParams) => T
  - - (response: DvelopHttpResponse<any>, context: DvelopContext, params: UpdateTaskParams): T
    - Parameters
      - response: DvelopHttpResponse<any>
      - context: DvelopContext
      - params: UpdateTaskParams
      Returns T
Returns (context: DvelopContext, params: UpdateTaskParams) => Promise<T>
- - (context: DvelopContext, params: UpdateTaskParams): Promise<T>
  - Factory for the updateTask-function. See Advanced Topics for more information.
    
    internal
    category
    Task
    
    Parameters
    - context: DvelopContext
    - params: UpdateTaskParams
    Returns Promise<T>

Http Functions

_defaultHttpRequestFunction

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

- Defined in packages/task/src/utils/http.ts:104
Default httpRequestFunction used in task-package.

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

_defaultHttpRequestFunctionFactory

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

- Defined in packages/task/src/utils/http.ts:61
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

Functions Task

Functions Http

Task Functions

_completeTaskFactory

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: CompleteTaskParams) => T

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: CompleteTaskParams

Returns T

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

Parameters

context: DvelopContext

params: CompleteTaskParams

Returns Promise<T>

_createTaskDefaultTransformFunction

Parameters

response: DvelopHttpResponse<any>

_: DvelopContext

__: CreateTaskParams

Returns string

_createTaskFactory

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: CreateTaskParams) => T

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: CreateTaskParams

Returns T

Optional uuidGeneratorFunction: () => string

Returns string

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

Parameters

context: DvelopContext

params: CreateTaskParams

Returns Promise<T>

_deleteTaskFactory

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: DeleteTaskParams) => T

Parameters

response: DvelopHttpResponse<any>

context: DvelopContext

params: DeleteTaskParams

Returns T

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

Parameters

context: DvelopContext

params: DeleteTaskParams

Returns Promise<T>

_getTaskCountDefaultTransformFunction

Parameters

response: DvelopHttpResponse<any>

_: DvelopContext

Returns number

_getTaskCountFactory

Type parameters

T