@acoustic-content-sdk/schematics-version

Documentation

API Documentation

Home > @acoustic-content-sdk/schematics-version

schematics-version package

Schematic to add a feature module to an application.

Functions

Function	Description
generateVersionSchematic(options)	Adds consistent version information

Interfaces

Interface	Description
GenerateVersionSchema

Variables

Variable	Description
ARTIFACT_MODES
VERSION	Version and build number of the package

Home > @acoustic-content-sdk/schematics-version > generateVersionSchematic

generateVersionSchematic() function

Adds consistent version information

Signature:

export declare function generateVersionSchematic(options: GenerateVersionSchema): Rule;

Parameters

Parameter	Type	Description
options	GenerateVersionSchema	the schematics object used to describe the version

Returns:

Rule

the schematics rule that executes the transform

Home > @acoustic-content-sdk/schematics-version > GenerateVersionSchema

GenerateVersionSchema interface

Signature:

export interface GenerateVersionSchema 

Properties

Property	Type	Description
project	string	The project name, falls back to the default project
version	string	The version information, falls back to the npm_package_version environment variable or to the value in package.json

Home > @acoustic-content-sdk/schematics-version > ARTIFACT_MODES

ARTIFACT_MODES variable

Signature:

ARTIFACT_MODES: ArtifactMode[]

Home > @acoustic-content-sdk/schematics-version > VERSION

VERSION variable

Version and build number of the package

Signature:

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

Home > @acoustic-content-sdk/schematics-version > GenerateVersionSchema > project

GenerateVersionSchema.project property

The project name, falls back to the default project

Signature:

project?: string;

Home > @acoustic-content-sdk/schematics-version > GenerateVersionSchema > version

GenerateVersionSchema.version property

The version information, falls back to the npm_package_version environment variable or to the value in package.json

Signature:

version?: string;