Skip to content

Update @elfsquad/configurator documentation #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
johannesheesterman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update @elfsquad/configurator documentation #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/configurator/libraries/methods/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default [
},
{
"methodName": "updateRequirement",
"description": "Updates a requirement on the this configuration. This can be used to (de)select a feature or set a value on a feature.",
"description": "Updates a requirement on this configuration. This can be used to (de)select a feature or set a value on a feature.",
"example": {
"content": "const nodeId = '00000000-0000-0000-0000-000000000000';\nconst value = 1;\nconst isSelection = true;\n\nawait configuration.updateRequirement(nodeId, isSelection, value);\n",
"language": "typescript"
Expand Down
17 changes: 7 additions & 10 deletions docs/configurator/libraries/methods/configuratorContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
export default [
{
"methodName": "constructor",
"description": "Initializes a new instance with the provided options.",
"example": {
"content": "import { ConfiguratorContext, AuthenticationMethod } from '@elfsquad/configurator';\n\nconst context = new ConfiguratorContext({\n authenticationMethod: AuthenticationMethod.ANONYMOUS,\n tenantId: 'your-tenant-id',\n});\n",
"language": "typescript"
},
"description": "",
"example": null,
"parameters": [
{
"name": "_options",
"type": "IConfiguratorOptions",
"description": "The options that are used to configure the context.",
"description": "",
"required": true,
"parameters": [
{
Expand Down Expand Up @@ -99,7 +96,7 @@ export default [
"name": "language",
"type": "string",
"description": "The language to start the configuration in.",
"required": true,
"required": false,
"parameters": []
},
{
Expand Down Expand Up @@ -164,7 +161,7 @@ export default [
"name": "language",
"type": "string",
"description": "The language is used for retrieving localized texts.",
"required": true,
"required": false,
"parameters": []
}
],
Expand Down Expand Up @@ -517,7 +514,7 @@ export default [
"name": "configurationIds",
"type": "string[]",
"description": "The configuration ids. If not provided, the root configuration id will be used.",
"required": true,
"required": false,
"parameters": []
}
],
Expand Down Expand Up @@ -560,7 +557,7 @@ export default [
},
{
"name": "object",
"type": "any",
"type": "unknown",
"description": "",
"required": true,
"parameters": []
Expand Down