Skip to content

Commit d754a2a

Browse files
committed
Merge branch 'restore-decorator-support_contribute-9.0' into restore-decorator-support_contribute-main
2 parents 7952510 + 0e06eee commit d754a2a

5 files changed

Lines changed: 256 additions & 145 deletions

File tree

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
import { DecoratorParam } from './decorator-param.interface';
22

33
/**
4-
* The configuration of dynamic component decorators. This is used to generate the registry files.
4+
* The configuration for a dynamic component decorator. This is used to generate the registry files.
55
*/
66
export interface DecoratorConfig {
7+
/**
8+
* Name of the decorator
9+
*/
710
name: string;
11+
12+
/**
13+
* List of DecoratorParams
14+
*/
815
params: DecoratorParam[];
916
}
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* The configuration of a parameter from a decorator
2+
* The configuration for a decorator parameter.
33
*/
44
export interface DecoratorParam {
55
/**
@@ -8,14 +8,19 @@ export interface DecoratorParam {
88
name: string;
99

1010
/**
11-
* The default value if any of the decorator param
11+
* The default value of the decorator param
12+
*
13+
* (Optional)
1214
*/
1315
default?: string;
1416

1517
/**
16-
* The property of the provided value that should be used instead to generate the Map. So, for example, if the
17-
* decorator value is a {@link ResourceType}, you may want to use the `ResourceType.value` instead of the whole
18-
* {@link ResourceType} object. In this case the {@link DecoratorParam#property} would be `value`.
18+
* The property of the provided parameter value that should be used instead of the value itself.
19+
*
20+
* For example, if the parameter value is {@link ResourceType} 'BITSTREAM', you'll want to use 'BITSTREAM.value'
21+
* instead of the whole {@link ResourceType} object. In this case the {@link DecoratorParam#property} is `value`.
22+
*
23+
* (Optional)
1924
*/
2025
property?: string;
2126
}

0 commit comments

Comments
 (0)