Class DatapackDeploymentSpecRegistry

Hierarchy

DatapackDeploymentSpecRegistry

Index

Constructors

Properties

container specs getUniqueKey globalInstance globalInstanceCreated

Accessors

Methods

getSpecs register registerFunction register registerFunction

Constructors

constructor

new DatapackDeploymentSpecRegistry(container): DatapackDeploymentSpecRegistry
Parameters
- container: Container
Returns DatapackDeploymentSpecRegistry
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:41

Properties

`Private` `Readonly` container

container: Container

`Private` `Readonly` specs

specs: SpecRegistryEntry[] = []

`Static` `Private` getUniqueKey

getUniqueKey: (() => number)

Type declaration

- (): number
- Returns number

`Static` globalInstance

globalInstance: DatapackDeploymentSpecRegistry

Get the current global DatapackDeploymentSpecRegistry instance registered in the root container

`Static` globalInstanceCreated

globalInstanceCreated: boolean

Accessors

size

get size(): number
Get the number of specs registered in this registry.

Returns number
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:47

Methods

getSpecs

getSpecs(): Generator<{
filter: DatapackFilter;
spec: DatapackDeploymentSpec;
}, void, unknown>
Standard iterator to iterate over the specs in this registry and the global registry.

Returns Generator<{
filter: DatapackFilter;
spec: DatapackDeploymentSpec;
}, void, unknown>
Iterable
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:55

register

register(filter, spec): void
Register a spec with 1 or more hooks to be executed in for the datapacks of the specified type in this deployment.
Parameters
- filter: string | DatapackFilter
  
  filter that determines when this datapack is applied
- spec: DatapackDeploymentSpec | ServiceCtor<DatapackDeploymentSpec>
  
  Object matching the DatapackDeploymentSpec-shape
Returns void
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:102

registerFunction

registerFunction<T>(datapackType, fn, executor): void
Register an individual spec function to be executed in for the datapacks of the specified type in this deployment.
Type Parameters
- T extends keyof DatapackDeploymentSpec
Parameters
- datapackType: string
  
  type of the Datapack
- fn: T
  
  name of the hook function
- executor: DatapackDeploymentSpec[T]
  
  function executed
Returns void
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:93

`Static` register

register(this, filter, spec): void
Register a spec with 1 or more hooks to be executed in for the datapacks of the specified type in this deployment.
Parameters
- this: void
- filter: string | DatapackFilter
  
  filter that determines when this datapack is applied
- spec: DatapackDeploymentSpec | ServiceCtor<DatapackDeploymentSpec>
  
  Object matching the DatapackDeploymentSpec-shape
Returns void
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:83

`Static` registerFunction

registerFunction<T>(this, datapackType, fn, executor): void
Register an individual spec function to be executed in for the datapacks of the specified type in this deployment.
Type Parameters
- T extends keyof DatapackDeploymentSpec
Parameters
- this: void
- datapackType: string
  
  type of the Datapack
- fn: T
  
  name of the hook function
- executor: DatapackDeploymentSpec[T]
  
  function executed
Returns void
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:74