[MMB-317], [MMB-318] — Remove the LockAttributes type
#214
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dpiatek
approved these changes
Oct 13, 2023
Resolves MMB-317:
> During the locking work we added an export for LockAttributes. This broke the CDN build because rollup will only create a Spaces global constructor if there is a single export from it’s entry file. Instead it exports a fake ES6 module:
>
> Spaces global === { default: Spaces constructor, LockAttributes }
>
> instead of:
>
> Spaces global === Spaces constructor
and resolves MMB-318:
> In docs, we show a way to get values from LockAttributes
> https://ably.com/docs/spaces/locking#subscribe in the subscriber. This
> is however incorrect, because attributes on the receiving side is never
> a Map, but an object.
I have chosen to simply remove the LockAttributes class and replace it
with Record<string, unknown>, which is what we use elsewhere for
representing arbitrary key-value pairs in the public API of the SDK.
lawrence-forooghian
force-pushed
the
remove-LockAttributes
branch
from
a3adcfb
to
fc26b7a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves MMB-317 and MMB-318.
I have chosen to simply remove the
LockAttributesclass and replace it withRecord<string, unknown>, which is what we use elsewhere for representing arbitrary key-value pairs in the public API of the SDK.See ably/docs#2023 for corresponding documentation update.