Class UniqueNameGenerator

Holds state on already used names and provides new names if there are naming conflicts.

Constructors

new UniqueNameGenerator(
indexSeparator?: string,
usedNames?: readonly string[],
): UniqueNameGenerator
Creates an instance of UniqueNameGenerator.
Parameters
- OptionalindexSeparator: string
  The separator to be used when adding an index.
- OptionalusedNames: readonly string[]
  Sets the already used names considered in the finding process.
Returns UniqueNameGenerator
- Defined in packages/util/dist/unique-name-generator.d.ts:14

generateAndSaveUniqueNamesWithSuffixes(
    name: string,
    suffixes: string[],
    caseSensitive?: boolean,
): string[]
Generate unique names by appending an index separated by the indexSeparator if necessary, while respecting the given suffixes. If the name is already unique nothing is appended. The generated names are added to the used names. Each given suffix is appended to the unique name in the result. The resulting names are also checked for uniqueness. All names in the result have the same number suffix.
Parameters
- name: string
  The name to get a unique name from.
- suffixes: string[]
  Additional name of suffixes to be considered for the finding process, as well as the output.
- OptionalcaseSensitive: boolean
  Whether to check the already used names in a case sensitive manner.
Returns string[]
A list of unique names. The length of this array is one plus the number of suffixes provided. The first entry corresponds to the given name.
Example
```
if `MyName` and `MyName_1MySuffix` is already taken, `[MyName_2, MyName_2MySuffix]` will be generated by default.
```
- Defined in packages/util/dist/unique-name-generator.d.ts:63

generateUniqueNamesWithSuffixes(
    name: string,
    suffixes: string[],
    caseSensitive?: boolean,
): string[]
Generate unique names by appending an index separated by the indexSeparator if necessary, while respecting the given suffixes. If the name is already unique nothing is appended. Each given suffix is appended to the unique name in the result. The resulting names are also checked for uniqueness. All names in the result have the same number suffix.
Parameters
- name: string
  The name to get a unique name from.
- suffixes: string[]
  Additional name of suffixes to be considered for the finding process, as well as the output.
- OptionalcaseSensitive: boolean
  Whether to check the already used names in a case sensitive manner.
Returns string[]
A list of unique names. The length of this array is one plus the number of suffixes provided. The first entry corresponds to the given name.
Example
```
if `MyName` and `MyName_1MySuffix` is already taken, `[MyName_2, MyName_2MySuffix]` will be generated by default.
```
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
- Defined in packages/util/dist/unique-name-generator.d.ts:49