Class EpSdkVersionTask`Abstract`

Hierarchy

EpSdkTask
- EpSdkVersionTask

Constructors

constructor

new EpSdkVersionTask(epSdkVersionTask_Config: IEpSdkVersionTask_Config): EpSdkVersionTask
Parameters
- epSdkVersionTask_Config: IEpSdkVersionTask_Config
Returns EpSdkVersionTask
Overrides EpSdkTask.constructor
- Defined in packages/ep-sdk/src/tasks/EpSdkVersionTask.ts:44

Properties

`Protected` epSdkTask_Config

epSdkTask_Config: IEpSdkTask_Config

`Protected` epSdkTask_TransactionLog

epSdkTask_TransactionLog: EpSdkTask_TransactionLog

`Protected` versionStrategy

versionStrategy: EEpSdk_VersionTaskStrategy = EEpSdk_VersionTaskStrategy.BUMP_PATCH

`Protected` versionString

versionString: string = '1.0.0'

`Protected` `Optional` xContextId

xContextId?: string

Methods

`Protected` `Abstract` createFunc

createFunc(): Promise<IEpSdkTask_CreateFuncReturn>
Returns Promise<IEpSdkTask_CreateFuncReturn>
Inherited from EpSdkTask.createFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:184

`Protected` createNextVersionWithStrategyValidation

createNextVersionWithStrategyValidation(__namedParameters: {
existingObjectVersionString: string;
}): string
Parameters
- __namedParameters: {
  existingObjectVersionString: string;
  }
  - existingObjectVersionString: string
Returns string
- Defined in packages/ep-sdk/src/tasks/EpSdkVersionTask.ts:58

`Protected` createReturn4UpdateFunc

createReturn4UpdateFunc(__namedParameters: {
epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
}): IEpSdkTask_ExecuteReturn
Parameters
- __namedParameters: {
  epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
  }
  - epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn
Returns IEpSdkTask_ExecuteReturn
Inherited from EpSdkTask.createReturn4UpdateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:224

`Protected` create_IEpSdkTask_IsUpdateRequiredFuncReturn

create_IEpSdkTask_IsUpdateRequiredFuncReturn(__namedParameters: {
existingObject: any;
requestedObject: any;
}): IEpSdkTask_IsUpdateRequiredFuncReturn
Parameters
- __namedParameters: {
  existingObject: any;
  requestedObject: any;
  }
  - existingObject: any
  - requestedObject: any
Returns IEpSdkTask_IsUpdateRequiredFuncReturn
Inherited from EpSdkTask.create_IEpSdkTask_IsUpdateRequiredFuncReturn
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:119

`Protected` deepCompareObjects

deepCompareObjects(__namedParameters: {
existingObject: any;
requestedObject: any;
}): IEpSdkDeepCompareResult
Parameters
- __namedParameters: {
  existingObject: any;
  requestedObject: any;
  }
  - existingObject: any
  - requestedObject: any
Returns IEpSdkDeepCompareResult
Inherited from EpSdkTask.deepCompareObjects
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:106

`Protected` deleteFunc

deleteFunc(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_DeleteFuncReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_DeleteFuncReturn>
Overrides EpSdkTask.deleteFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkVersionTask.ts:109

execute

execute(xContextId?: string): Promise<IEpSdkTask_ExecuteReturn>
Parameters
- Optional xContextId: string
Returns Promise<IEpSdkTask_ExecuteReturn>
Inherited from EpSdkTask.execute
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:316

`Protected` getUpdateFuncAction

getUpdateFuncAction(wouldFailOnExactVersionRequirement?: boolean): EEpSdkTask_Action
Parameters
- Optional wouldFailOnExactVersionRequirement: boolean
Returns EEpSdkTask_Action
Overrides EpSdkTask.getUpdateFuncAction
- Defined in packages/ep-sdk/src/tasks/EpSdkVersionTask.ts:96

`Protected` initializeTask

initializeTask(): Promise<void>
Allows for async init of task

Returns Promise<void>
Inherited from EpSdkTask.initializeTask
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:308

`Protected` isCheckmode

isCheckmode(): boolean
Returns boolean
Inherited from EpSdkTask.isCheckmode
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:97

`Protected` `Abstract` isUpdateRequiredFunc

isUpdateRequiredFunc(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Inherited from EpSdkTask.isUpdateRequiredFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:174

`Protected` prepareCompareObject4Output

prepareCompareObject4Output(obj: any): any
Parameters
- obj: any
Returns any
Inherited from EpSdkTask.prepareCompareObject4Output
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:102

`Protected` `Abstract` transform_EpSdkTask_Config

transform_EpSdkTask_Config(epSdkTask_Config: IEpSdkTask_Config): IEpSdkTask_Config
Parameters
- epSdkTask_Config: IEpSdkTask_Config
Returns IEpSdkTask_Config
Overrides EpSdkTask.transform_EpSdkTask_Config
- Defined in packages/ep-sdk/src/tasks/EpSdkVersionTask.ts:42

`Protected` truncate

truncate(str: string, maxLength: number): string
Parameters
- str: string
- maxLength: number
Returns string
Inherited from EpSdkTask.truncate
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:140

`Protected` `Abstract` updateFunc

updateFunc(epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn): Promise<IEpSdkTask_UpdateFuncReturn>
Parameters
- epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn
Returns Promise<IEpSdkTask_UpdateFuncReturn>
Inherited from EpSdkTask.updateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:196

`Protected` validateTaskConfig

validateTaskConfig(): Promise<void>
Returns Promise<void>
Overrides EpSdkTask.validateTaskConfig
- Defined in packages/ep-sdk/src/tasks/EpSdkVersionTask.ts:50

Class EpSdkVersionTaskAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

epSdkVersionTask_Config: IEpSdkVersionTask_Config

Returns EpSdkVersionTask

Properties

Protected epSdkTask_Config

Protected epSdkTask_TransactionLog

Protected versionStrategy

Protected versionString

Protected Optional xContextId

Methods

Protected Abstract createFunc

Returns Promise<IEpSdkTask_CreateFuncReturn>

Protected createNextVersionWithStrategyValidation

Parameters

__namedParameters: { existingObjectVersionString: string; }

existingObjectVersionString: string

Returns string

Protected createReturn4UpdateFunc

Parameters

__namedParameters: { epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn; }

epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn

Returns IEpSdkTask_ExecuteReturn

Protected create_IEpSdkTask_IsUpdateRequiredFuncReturn

Parameters

__namedParameters: { existingObject: any; requestedObject: any; }

existingObject: any

requestedObject: any

Returns IEpSdkTask_IsUpdateRequiredFuncReturn

Protected deepCompareObjects

Parameters

__namedParameters: { existingObject: any; requestedObject: any; }

existingObject: any

requestedObject: any

Returns IEpSdkDeepCompareResult

Protected deleteFunc

Parameters

epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn

Returns Promise<IEpSdkTask_DeleteFuncReturn>

execute

Parameters

Optional xContextId: string

Returns Promise<IEpSdkTask_ExecuteReturn>

Protected getCreateFuncAction

Returns EEpSdkTask_Action

Protected Abstract getDefaultEpObjectKeys

Returns IEpSdkTask_EpObjectKeys

Protected getDeleteFuncAction

Returns EEpSdkTask_Action

Protected Abstract getEpObjectKeys

Parameters

epObject: any

Returns IEpSdkTask_EpObjectKeys

Protected Abstract getFunc

Parameters

epSdkTask_Keys: IEpSdkTask_Keys

Returns Promise<IEpSdkTask_GetFuncReturn>

Protected Abstract getTaskKeys

Returns IEpSdkTask_Keys

Protected getUpdateFuncAction

Parameters

Optional wouldFailOnExactVersionRequirement: boolean

Returns EEpSdkTask_Action

Protected initializeTask

Returns Promise<void>

Protected isCheckmode

Returns boolean

Protected Abstract isUpdateRequiredFunc

Parameters

epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn

Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>

Protected prepareCompareObject4Output

Parameters

Class EpSdkVersionTask`Abstract`

`Protected` epSdkTask_Config

`Protected` epSdkTask_TransactionLog

`Protected` versionStrategy

`Protected` versionString

`Protected` `Optional` xContextId

`Protected` `Abstract` createFunc

`Protected` createNextVersionWithStrategyValidation

__namedParameters: {
existingObjectVersionString: string;
}

`Protected` createReturn4UpdateFunc

__namedParameters: {
epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
}

`Protected` create_IEpSdkTask_IsUpdateRequiredFuncReturn

__namedParameters: {
existingObject: any;
requestedObject: any;
}

`Protected` deepCompareObjects

__namedParameters: {
existingObject: any;
requestedObject: any;
}

`Protected` deleteFunc

`Optional` xContextId: string

`Protected` getCreateFuncAction

`Protected` `Abstract` getDefaultEpObjectKeys

`Protected` getDeleteFuncAction

`Protected` `Abstract` getEpObjectKeys

`Protected` `Abstract` getFunc

`Protected` `Abstract` getTaskKeys

`Protected` getUpdateFuncAction

`Optional` wouldFailOnExactVersionRequirement: boolean

`Protected` initializeTask

`Protected` isCheckmode

`Protected` `Abstract` isUpdateRequiredFunc

`Protected` prepareCompareObject4Output

`Protected` `Abstract` transform_EpSdkTask_Config

`Protected` truncate

`Protected` `Abstract` updateFunc

`Protected` validateTaskConfig