docs: migrate guides to TSDoc references (#6100)

This commit is contained in:
Shahed Nasser
2024-01-22 19:38:35 +02:00
committed by GitHub
parent 85dad169bb
commit 4792c55226
980 changed files with 195537 additions and 160619 deletions

View File

@@ -50,8 +50,6 @@ transaction manager is created.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
### create
Creates an analytics config.
@@ -62,9 +60,7 @@ Creates an analytics config.
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;","optional":false,"defaultValue":"","description":"Creates an analytics config.","expandable":false,"children":[]}]} />
### delete
@@ -76,9 +72,7 @@ Deletes an analytics config.
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"Deletes an analytics config.","expandable":false,"children":[]}]} />
### retrieve
@@ -90,8 +84,6 @@ ___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### shouldRetryTransaction\_
#### Parameters
@@ -102,8 +94,6 @@ ___
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### update
Updates an analytics config. If the config does not exist, it will be created instead.
@@ -114,9 +104,7 @@ Updates an analytics config. If the config does not exist, it will be created in
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;","optional":false,"defaultValue":"","description":"Updates an analytics config. If the config does not exist, it will be created instead.","expandable":false,"children":[]}]} />
### withTransaction