@acoustic-content-sdk/tooling-contributions 中文文档教程

Question

工具函数来实现对特性模块的支持。

API Documentation

Home > @acoustic-content-sdk/tooling-contributions

tooling-contributions package

实现对功能模块的支持的工具函数。

Enumerations

Enumeration	Description
ArtifactMode	Artifact modes, the values need to match the option selections for the Page Contribution type 354743b2-f89a-482b-b447-2b5a2367c8bd

Functions

Function	Description
createNgDriverArtifacts(aHost, aReadDir, aSchema)	Generates the content items that describe a driver based on an Angular build output
createPackageArtifacts(aHost, aSchema, aLogSvc)	Generates the content items that describe a driver based on an Angular build output

Interfaces

Interface	Description
CreateNgDriverArtifactsSchema
CreatePackageFromArtifactsSchema

Variables

Variable	Description
VERSION	Version and build number of the package

Home > @acoustic-content-sdk/tooling-contributions > ArtifactMode

ArtifactMode enum

Artifact 模式，值需要与Page Contribution 类型的选项选择相匹配 354743b2-f89a-4822b4762b437b4b5 /code>

Signature:

export declare enum ArtifactMode 

Enumeration Members

Member	Value	Description
ALWAYS	"always"
LIVE	"live"
PREVIEW	"preview"

Home > @acoustic-content-sdk/tooling-contributions > createNgDriverArtifacts

createNgDriverArtifacts() function

根据 Angular 构建输出生成描述驱动程序的内容项

签名：

export declare function createNgDriverArtifacts(aHost: ReadTextFile, aReadDir: ReadDirectory, aSchema?: CreateNgDriverArtifactsSchema): Observable<FileDescriptor<Artifact | Buffer>>;

Parameters

Parameter	Type	Description
aHost	ReadTextFile	callback to read a text file
aReadDir	ReadDirectory
aSchema	CreateNgDriverArtifactsSchema	configuration

返回：

Observable< ;文件描述符<神器| Buffer>>

the sequence of artifacts

Home > @acoustic-content-sdk/tooling-contributions > createPackageArtifacts

createPackageArtifacts() function

根据 Angular 构建输出生成描述驱动程序的内容项

签名：

export declare function createPackageArtifacts(aHost: ReadTextFile, aSchema?: CreatePackageFromArtifactsSchema, aLogSvc?: LoggerService): Observable<FileDescriptor<any>>;

Parameters

Parameter	Type	Description
aHost	ReadTextFile	callback to read a text file
aSchema	CreatePackageFromArtifactsSchema	configuration
aLogSvc	LoggerService

返回：

Observable< ;FileDescriptor>

the sequence of artifacts

Home > @acoustic-content-sdk/tooling-contributions > CreateNgDriverArtifactsSchema

CreateNgDriverArtifactsSchema interface

Signature:

export interface CreateNgDriverArtifactsSchema 

Properties

Property	Type	Description
configuration	string	The name of the configuration to use
mode	string	mode
project	string	The name of the project.
tag	string	a comma separated list of tags

Home > ; @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema

CreatePackageFromArtifactsSchema interface

Signature:

export interface CreatePackageFromArtifactsSchema 

Properties

Property	Type	Description
data	string	Location of the data directory, defaults to 'data'. The package artifacts will be created in the parent folder of the data folder
files$	Observable<FileDescriptor<any>>	optionally the explicit list of files to include
license	string	optinally the license, defaults to MIT
tag	string	a comma separated list of tags

Home > ; @acoustic-content-sdk/tooling-contributions > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

首页 > @acoustic-content-sdk/tooling-contributions > 创建NgDriverArtifactsSchema > configuration

CreateNgDriverArtifactsSchema.configuration property

The name of the configuration to use

Signature:

configuration?: string;

首页 > @acoustic-content-sdk/tooling-contributions > 创建NgDriverArtifactsSchema > mode

CreateNgDriverArtifactsSchema.mode property

mode

Signature:

mode?: string;

Home > @acoustic-content-sdk/tooling-contributions > 创建NgDriverArtifactsSchema > 项目 项目

CreateNgDriverArtifactsSchema.project property

的名称。

Signature:

project?: string;

Home > @acoustic-content-sdk/tooling-contributions > 创建NgDriverArtifactsSchema > tag

CreateNgDriverArtifactsSchema.tag property

a comma separated list of tags

Signature:

tag?: string;

首页 > @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema > data

CreatePackageFromArtifactsSchema.data property

数据目录的位置，默认为“数据”。 The package artifacts will be created in the parent folder of the data folder

Signature:

data?: string;

Home > ; @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema > files$

CreatePackageFromArtifactsSchema.files$ property

optionally the explicit list of files to include

Signature:

files$?: Observable<FileDescriptor<any>>;

主页 > @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema > license

CreatePackageFromArtifactsSchema.license property

optinally the license, defaults to MIT

Signature:

license?: string;

首页 > @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema > 标签

CreatePackageFromArtifactsSchema.tag property

逗号分隔的标签列表

签名：

tag?: string;