Skip to content

Commit abdbeeb

Browse files
committed
update readme with attr example instantiation
1 parent 5cef7fa commit abdbeeb

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,30 @@ This will clone the platform repo and generate Typescript code in `lib/src/platf
6767
### Import Typescript code
6868

6969
```
70+
7071
import { GetAttributeRequest } from './lib/src/platform/policy/attributes/attributes_pb';
71-
const request = new GetAttributeRequest(<request data>);
72+
import { Attribute, AttributeRuleTypeEnum } from './lib/src/platform/policy/objects_pb';
73+
74+
const attrData = {
75+
name: "my-attr",
76+
rule: AttributeRuleTypeEnum.ALL_OF,
77+
namespace: {name: 'my-namespace'},
78+
values: [{value: 'my-value'}],
79+
active: true,
80+
extraField: 'this will be ignored' // only proto defined fields are respected
81+
}
82+
const attr = new Attribute(attrData);
83+
console.log(attr.toJson());
84+
85+
// {
86+
// namespace: { name: 'my-namespace' },
87+
// name: 'my-attr',
88+
// rule: 'ATTRIBUTE_RULE_TYPE_ENUM_ALL_OF',
89+
// values: [ { value: 'my-value' } ],
90+
// active: true
91+
// }
92+
93+
const req = new GetAttributeRequest({id: 'uuid-here'});
7294
```
7395

7496
This is an example to import a `GetAttributeRequest` to request attribute information.

0 commit comments

Comments
 (0)