Class DatapackDeploymentSpecRegistry

Index

Constructors

Properties

container specs

Accessors

Methods

getSpecs register registerFunction register registerFunction

Constructors

constructor

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

Properties

`Private` `Readonly`container

container: Container

`Private` `Readonly`specs

specs: SpecRegistryEntry[] = []

Accessors

size

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

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

`Static`instance

get instance(): any
Get the current global DatapackDeploymentSpecRegistry instance registered in the root container

Returns any
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:20

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:46

register

register(
filter: string | DatapackFilter,
spec: DatapackDeploymentSpec | TypeConstructor<DatapackDeploymentSpec>,
): 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 | TypeConstructor<DatapackDeploymentSpec>
  Object matching the DatapackDeploymentSpec-shape
Returns void
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:89

registerFunction

registerFunction<T extends keyof DatapackDeploymentSpec>(
    datapackType: string,
    fn: T,
    executor: DatapackDeploymentSpec[T],
): 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:80

`Static`register

register(
    this: void,
    filter: string | DatapackFilter,
    spec: DatapackDeploymentSpec | TypeConstructor<DatapackDeploymentSpec>,
): 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 | TypeConstructor<DatapackDeploymentSpec>
  Object matching the DatapackDeploymentSpec-shape
Returns void
- Defined in packages/vlocity-deploy/src/datapackDeploymentSpecRegistry.ts:70

`Static`registerFunction

registerFunction<T extends keyof DatapackDeploymentSpec>(
    this: void,
    datapackType: string,
    fn: T,
    executor: DatapackDeploymentSpec[T],
): 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:61