| 1 | /** @module config */
|
| 2 | import { ConfigParams } from './ConfigParams';
|
| 3 | /**
|
| 4 | * A helper class that allows to extract component name from configuration parameters.
|
| 5 | * The name can be defined in "id", "name" parameters or inside a component descriptor.
|
| 6 | *
|
| 7 | * ### Example ###
|
| 8 | *
|
| 9 | * let config = ConfigParams.fromTuples(
|
| 10 | * "descriptor", "myservice:connector:aws:connector1:1.0",
|
| 11 | * "param1", "ABC",
|
| 12 | * "param2", 123
|
| 13 | * );
|
| 14 | *
|
| 15 | * let name = NameResolver.resolve(config); // Result: connector1
|
| 16 | */
|
| 17 | export declare class NameResolver {
|
| 18 | /**
|
| 19 | * Resolves a component name from configuration parameters.
|
| 20 | * The name can be stored in "id", "name" fields or inside a component descriptor.
|
| 21 | * If name cannot be determined it returns a defaultName.
|
| 22 | *
|
| 23 | * @param config configuration parameters that may contain a component name.
|
| 24 | * @param defaultName (optional) a default component name.
|
| 25 | * @returns resolved name or default name if the name cannot be determined.
|
| 26 | */
|
| 27 | static resolve(config: ConfigParams, defaultName?: string): string;
|
| 28 | }
|