Teraslice CLI: `Helpers Asset Src Asset Src`
helpers/asset-src.AssetSrc
Table of contents
Constructors
Properties
- assetFile
- assetPackageJson
- bundle
- bundleTarget
- debug
- devMode
- name
- outputFileName
- overwrite
- packageJson
- srcDir
- version
Accessors
Methods
Constructors
constructor
• new AssetSrc(srcDir
, devMode?
, debug?
, bundle?
, bundleTarget?
, overwrite?
): AssetSrc
Parameters
Name | Type | Default value |
---|---|---|
srcDir | string | undefined |
devMode | boolean | false |
debug | boolean | false |
bundle | boolean | true |
bundleTarget | string | 'node18' |
overwrite | boolean | false |
Returns
Defined in
teraslice-cli/src/helpers/asset-src.ts:55
Properties
assetFile
• assetFile: string
Defined in
teraslice-cli/src/helpers/asset-src.ts:42
assetPackageJson
• assetPackageJson: any
Defined in
teraslice-cli/src/helpers/asset-src.ts:44
bundle
• Optional
bundle: boolean
Defined in
teraslice-cli/src/helpers/asset-src.ts:47
bundleTarget
• Optional
bundleTarget: string
Defined in
teraslice-cli/src/helpers/asset-src.ts:48
debug
• debug: boolean
Defined in
teraslice-cli/src/helpers/asset-src.ts:50
devMode
• devMode: boolean
= false
Defined in
teraslice-cli/src/helpers/asset-src.ts:53
name
• name: string
Defined in
teraslice-cli/src/helpers/asset-src.ts:45
outputFileName
• outputFileName: string
Defined in
teraslice-cli/src/helpers/asset-src.ts:49
overwrite
• overwrite: boolean
Defined in
teraslice-cli/src/helpers/asset-src.ts:51
packageJson
• packageJson: any
Defined in
teraslice-cli/src/helpers/asset-src.ts:43
srcDir
• srcDir: string
Param
Path to a valid asset source directory, must
must contain asset/asset.json
and asset/package.json
files.
Defined in
teraslice-cli/src/helpers/asset-src.ts:41
version
• version: string
Defined in
teraslice-cli/src/helpers/asset-src.ts:46
Accessors
buildDir
• get
buildDir(): string
Returns
string
Path to the output directory for the finished asset zipfile
Defined in
teraslice-cli/src/helpers/asset-src.ts:89
zipFileName
• get
zipFileName(): string
Returns
string
Defined in
teraslice-cli/src/helpers/asset-src.ts:93
Methods
build
▸ build(): Promise
<ZipResults
>
Returns
Promise
<ZipResults
>
Defined in
teraslice-cli/src/helpers/asset-src.ts:154
generateRegistry
▸ generateRegistry(): Promise
<AssetRegistry
>
generates the registry object that is used to generate the index.js asset registry
Returns
Promise
<AssetRegistry
>
Defined in
teraslice-cli/src/helpers/asset-src.ts:130
operatorFiles
▸ operatorFiles(): Promise
<string
[]>
operatorFiles finds all of the Teraslice operator files, including: api.js fetcher.js processor.js schema.js slicer.js
Returns
Promise
<string
[]>
array of paths to all of the operator files
Defined in
teraslice-cli/src/helpers/asset-src.ts:121
zip
▸ zip(tmpAssetDir
, outputFileName
): Promise
<ZipResults
>
zip - Creates properly named zip archive of asset from tmpAssetDir
Parameters
Name | Type | Description |
---|---|---|
tmpAssetDir | string | Path to the temporary asset source directory |
outputFileName | string |
Returns
Promise
<ZipResults
>
ZipResults