Web SDK documentation
  1. Injectables
  2. BrandingVersionService

File

branding/shared/data/branding-version.service.ts

Description

Service for creating and manipulating branding versions.

Index

Properties
Methods

Methods

bumpBrandingIteration
bumpBrandingIteration(version: string)

Bumps the iteration of a branding version.

Errors are thrown if the version is not in the expected format.

Parameters :
Name Type Optional Description
version string No

The branding version to bump.
Returns : `${string}-${number}`

The bumped branding version.

Errors are thrown if the version is not in the expected format.
createInitialBrandingVersion
createInitialBrandingVersion(name: T)
Type parameters :
  • T

Creates the initial branding version for a given name.

Parameters :
Name Type Optional Description
name T No

The name of the branding.
Returns : `${T}-1`

The initial branding version.
splitBrandingIntoNameAndIteration
splitBrandingIntoNameAndIteration(version: string)

Splits a branding version into its name and iteration.

Errors are thrown if the version is not in the expected format.

Parameters :
Name Type Optional Description
version string No

The branding version to split.
Returns : literal type

The name and iteration of the branding version.

Errors are thrown if the version is not in the expected format.

Properties

Static Readonly nameAndIterationSeparator
Type : string
Default value : '-'

results matching ""

    No results matching ""