feat: omitServerProps helper function #277
Open
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
EvanHahn
approved these changes
Dec 3, 2024
There was a problem hiding this comment.
- I was initially surprised to see that the word "server" meant "managed by the backend"...maybe there's a better name for this?
- I admit I don't fully understand the motivation for this change but I trust that y'all have discussed it and have a good reason.
- Do we have a plan to deprecate
valueOf?
| export function omitServerProps<TDoc extends MapeoCommon>( | ||
| doc: TDoc & { forks?: string[] } | ||
| ) { | ||
| return excludeKeys(doc, keysToExclude) |
There was a problem hiding this comment.
Can we use our existing omit helper (and maybe remove the new filter-obj dependency)?
| @@ -79,6 +82,10 @@ export function parseVersionId(versionId: string): VersionIdObject { | |||
| return { coreDiscoveryKey, index } | |||
| } | |||
|
|
|||
| /** | |||
| * Get the value of a document, excluding server-managed properties. | |||
There was a problem hiding this comment.
I think this comment is a little unclear because it makes it look like it should do the same thing as the other function.
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.
I needed a more flexible version of
valueOffor removing server-managed props from a Mapeo Doc. In the front-end we are modifying some props such as replacing refs with actual docs, but we still need to be able to strip server properties when editing.I decided to create a separate function since this is subtly different from
valueOf, and the namevalueOfisn't great anyway.