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

Remove type parameter from IntervalCollection's add method #17168

Closed
3 tasks
jzaffiro opened this issue Sep 1, 2023 · 1 comment
Closed
3 tasks

Remove type parameter from IntervalCollection's add method #17168

jzaffiro opened this issue Sep 1, 2023 · 1 comment
Assignees
Labels
api deprecation Changes to a deprecated API status: stale

Comments

@jzaffiro
Copy link
Contributor

jzaffiro commented Sep 1, 2023

Deprecated API

The deprecated API is the add method on IntervalCollection, called when adding a new interval to a given collection. The type parameter is being removed from this API.

Context

The type parameter of this API is being removed to prevent callers of add from specifying an IntervalType. The default type is IntervalType.SlideOnRemove, and all intervals will now be created with that type.

Approach

Simply call IntervalCollection.add without the interval type parameter, so a maximum of 4 parameters will be passed in.

Dependencies

None.

Compatibility Concerns

None.

Phases

  • Check in overloaded add method for the original signature as well as the updated signature.
  • Ensure that all partners calling this method do not pass in an interval type.
  • Remove the 5-parameter signature, and leave only the add implementation without the type parameter.

Expected Timeline

The API will likely be removed in the 2.0.0-internal.9.0.0 release (in 2 major releases).

Open Questions

None.

@jzaffiro jzaffiro added the api deprecation Changes to a deprecated API label Sep 1, 2023
@jzaffiro jzaffiro self-assigned this Sep 1, 2023
Copy link
Contributor

This issue has been automatically marked as stale because it has had no activity for 180 days. It will be closed if no further activity occurs within 8 days of this comment. Thank you for your contributions to Fluid Framework!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api deprecation Changes to a deprecated API status: stale
Projects
None yet
Development

No branches or pull requests

1 participant