Skip to content
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.

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

CC-31652 Introduced datasource.dependable and datasource.trigger services. #2282

Merged

Conversation

danilmoro3
Copy link
Contributor

@danilmoro3 danilmoro3 added tech review needed PR needs tech review new PR contains a new document labels Oct 30, 2023
@danilmoro3 danilmoro3 self-assigned this Oct 30, 2023
FRITS-Kh
FRITS-Kh previously approved these changes Nov 6, 2023
@danilmoro3 danilmoro3 added TW review needed PR needs Technical writer's review and removed tech review needed PR needs tech review labels Nov 6, 2023
@andriitserkovnyi andriitserkovnyi self-assigned this Jan 9, 2024
| - | - |
|type | A datasource type. |
|event | An event type triggered by element. |
|debounce | Delays the emission of values the next datasource (default is `300ms`). |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you clarify the description? Looks like something is missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What exactly? Description looks clear

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't get how the next datasource relates to the preceding part of the sentence

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

datasource is an angular service and not exactly data source

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still don't get it, but I'll try to guess:

Suggested change
|debounce | Delays the emission of values the next datasource (default is `300ms`). |
|debounce | Delays the emission of values of the next datasource (default is `300ms`). |


The main module lets you register any `datasource.trigger` by key using the `withEvents()` static method. It assigns the object of datasources to `DatasourceEventTypesToken` under the hood.

The `resolve()` method gets the trigger element using the `DatasourceTriggerElement` abstract class (token), finds a specific service from `DatasourceEventTypesToken` by `config.event` (from the argument) and returns observable with data (based on the data returned from trigger element) by `Datasource.resolve()`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Split this into several sentences and try to remove the braces

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case context will be missed


## Interfaces

Interfaces for the Datasource Trigger configuration and types:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Types of what?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interfaces and types for the Datasource Trigger configuration:

@andriitserkovnyi andriitserkovnyi merged commit 46205b6 into master Jan 16, 2024
10 of 13 checks passed
@andriitserkovnyi andriitserkovnyi deleted the feature/cc-31652-fe-new-services-documentation branch January 16, 2024 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new PR contains a new document TW review needed PR needs Technical writer's review
Development

Successfully merging this pull request may close these issues.

3 participants