Skip to content

Commit c6a7a1f

Browse files
committed
Update documentation for @elfsquad/configurator
1 parent 0d5990a commit c6a7a1f

2 files changed

Lines changed: 8 additions & 11 deletions

File tree

docs/configurator/libraries/methods/configuration.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export default [
2727
},
2828
{
2929
"methodName": "updateRequirement",
30-
"description": "Updates a requirement on the this configuration. This can be used to (de)select a feature or set a value on a feature.",
30+
"description": "Updates a requirement on this configuration. This can be used to (de)select a feature or set a value on a feature.",
3131
"example": {
3232
"content": "const nodeId = '00000000-0000-0000-0000-000000000000';\nconst value = 1;\nconst isSelection = true;\n\nawait configuration.updateRequirement(nodeId, isSelection, value);\n",
3333
"language": "typescript"

docs/configurator/libraries/methods/configuratorContext.ts

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
export default [
22
{
33
"methodName": "constructor",
4-
"description": "Initializes a new instance with the provided options.",
5-
"example": {
6-
"content": "import { ConfiguratorContext, AuthenticationMethod } from '@elfsquad/configurator';\n\nconst context = new ConfiguratorContext({\n authenticationMethod: AuthenticationMethod.ANONYMOUS,\n tenantId: 'your-tenant-id',\n});\n",
7-
"language": "typescript"
8-
},
4+
"description": "",
5+
"example": null,
96
"parameters": [
107
{
118
"name": "_options",
129
"type": "IConfiguratorOptions",
13-
"description": "The options that are used to configure the context.",
10+
"description": "",
1411
"required": true,
1512
"parameters": [
1613
{
@@ -99,7 +96,7 @@ export default [
9996
"name": "language",
10097
"type": "string",
10198
"description": "The language to start the configuration in.",
102-
"required": true,
99+
"required": false,
103100
"parameters": []
104101
},
105102
{
@@ -164,7 +161,7 @@ export default [
164161
"name": "language",
165162
"type": "string",
166163
"description": "The language is used for retrieving localized texts.",
167-
"required": true,
164+
"required": false,
168165
"parameters": []
169166
}
170167
],
@@ -517,7 +514,7 @@ export default [
517514
"name": "configurationIds",
518515
"type": "string[]",
519516
"description": "The configuration ids. If not provided, the root configuration id will be used.",
520-
"required": true,
517+
"required": false,
521518
"parameters": []
522519
}
523520
],
@@ -560,7 +557,7 @@ export default [
560557
},
561558
{
562559
"name": "object",
563-
"type": "any",
560+
"type": "unknown",
564561
"description": "",
565562
"required": true,
566563
"parameters": []

0 commit comments

Comments
 (0)