• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16export interface NameGeneratorOptions {
17  // common
18  reservedNames?: Set<string>;
19
20  // hex name generator
21  hexLength?: number;
22  hexWithPrefixSuffix?: boolean;
23
24  // dictionary name generator
25  dictionaryList?: string[];
26
27  // underline name generator
28  underlineMaxLength?: number;
29}
30
31/**
32 * @desc interface for name generator, use factory model
33 */
34export interface INameGenerator {
35  /**
36   * @desc get name from generator.
37   * @return unique name generated
38   */
39  getName(): string;
40
41  /**
42   * @desc reset name generator
43   */
44  reset(): void;
45}
46