Class DatapackWriter

Index

Constructors

Properties

definitions expander fallbackDefinitions fallbackExpander fileSystem

Methods

definitionScope expand generatedHeader getWritePlan projectFolder rootRecord write

Constructors

constructor

new DatapackWriter(
    fileSystem: FileSystem,
    definitions: DatapackExportDefinitionStore,
    logger?: Logger,
): DatapackWriter
Parameters
- fileSystem: FileSystem
- definitions: DatapackExportDefinitionStore
- logger: Logger = ...
Returns DatapackWriter
- Defined in packages/vlocity-deploy/src/datapackWriter.ts:37

Properties

`Private` `Readonly`definitions

definitions: DatapackExportDefinitionStore

`Private` `Readonly`expander

expander: DatapackExpander

`Private` `Readonly`fallbackDefinitions

fallbackDefinitions: DatapackExportDefinitionStore = ...

`Private` `Readonly`fallbackExpander

fallbackExpander: DatapackExpander

`Private` `Readonly`fileSystem

fileSystem: FileSystem

Methods

`Private`definitionScope

definitionScope(
definitions: DatapackExportDefinitionStore,
datapack: VlocityDatapack,
): { found: boolean; scope?: string }
Parameters
- definitions: DatapackExportDefinitionStore
- datapack: VlocityDatapack
Returns { found: boolean; scope?: string }
- Defined in packages/vlocity-deploy/src/datapackWriter.ts:108

`Private`expand

expand(datapack: VlocityDatapack): DatapackExpandResult
Parameters
- datapack: VlocityDatapack
Returns DatapackExpandResult
- Defined in packages/vlocity-deploy/src/datapackWriter.ts:87

`Private`generatedHeader

generatedHeader(
datapack: VlocityDatapack,
expanded: DatapackExpandResult,
): string
Parameters
- datapack: VlocityDatapack
- expanded: DatapackExpandResult
Returns string
- Defined in packages/vlocity-deploy/src/datapackWriter.ts:121

getWritePlan

getWritePlan(datapack: VlocityDatapack): DatapackWritePlan
Parameters
- datapack: VlocityDatapack
Returns DatapackWritePlan
- Defined in packages/vlocity-deploy/src/datapackWriter.ts:49

`Private`projectFolder

projectFolder(datapack: VlocityDatapack): string
Parameters
- datapack: VlocityDatapack
Returns string
- Defined in packages/vlocity-deploy/src/datapackWriter.ts:129

`Private`rootRecord

rootRecord(datapack: VlocityDatapack): VlocityDatapackSObject
Parameters
- datapack: VlocityDatapack
Returns VlocityDatapackSObject
- Defined in packages/vlocity-deploy/src/datapackWriter.ts:139

write

write(datapack: VlocityDatapack): Promise<void>
Parameters
- datapack: VlocityDatapack
Returns Promise<void>
- Defined in packages/vlocity-deploy/src/datapackWriter.ts:79