Improving documentation for realm
#6508
Merged
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
kraenhansen
force-pushed
the
kh/improved-docs-2
branch
from
f9464c6
to
8a338bc
Compare
kneth
approved these changes
Feb 27, 2024
|
This failure seems unrelated. |
elle-j
reviewed
Feb 28, 2024
| export type ObjectChangeCallback<T> = ( | ||
| /** | ||
| * The object that changed. | ||
| */ object: RealmObject<T> & T, |
There was a problem hiding this comment.
Suggested change
| */ object: RealmObject<T> & T, | |
| */ | |
| object: RealmObject<T> & T, |
| insertions: number[]; | ||
| /** | ||
| * The indices in the collection where objects were modified. |
There was a problem hiding this comment.
Suggested change
| * The indices in the collection where objects were modified. | |
| * The indices in the collection where objects were deleted. |
| deletions: number[]; | ||
| /** | ||
| * The indices in the collection where objects were modified. |
There was a problem hiding this comment.
Suggested change
| * The indices in the collection where objects were modified. | |
| * The indices in the new state of the collection where objects were modified. |
| newModifications: number[]; | ||
| /** | ||
| * The indices in the collection where objects were deleted. |
There was a problem hiding this comment.
Suggested change
| * The indices in the collection where objects were deleted. | |
| * The indices in the old state of the collection where objects were modified. |
| export type CollectionChangeCallback<T = unknown, EntryType extends [unknown, unknown] = [unknown, unknown]> = ( | ||
| /** | ||
| * The collection instance that changed, |
There was a problem hiding this comment.
Suggested change
| * The collection instance that changed, | |
| * The collection instance that changed. |
| @@ -1271,6 +1317,10 @@ export namespace Realm { | |||
| export import ObjectClass = internal.RealmObjectConstructor; | |||
| /** @deprecated Will be removed in v13.0.0. Please use {@link internal.PropertyTypeName} */ | |||
| export import PropertyType = internal.PropertyTypeName; | |||
| /** @deprecated Use the another {@link internal.ClientResetMode} than {@link internal.ClientResetMode.Manual}. */ | |||
There was a problem hiding this comment.
To show slightly friendlier names for users you can show just the part excluding internal. (e.g. as such: previous comment. (Just readding it because I don't know if you saw the other reply 👍 )
There was a problem hiding this comment.
I wasn't sure why you suggested that - but now it makes perfect sense. Thanks!
| @@ -1,12 +1,12 @@ | |||
| { | |||
| "entryPoints": ["src/index.ts"], | |||
| "tsconfig": "./tsconfig.json", | |||
| "entryPoints": ["dist/public-types/index.d.ts"], | |||
kraenhansen
added a commit
that referenced
this pull request
Feb 28, 2024
|
I've just pushed an update with your feedback: 6e60915 |
kraenhansen
added a commit
that referenced
this pull request
Feb 28, 2024
bimusiek
pushed a commit
to bimusiek/realm-js
that referenced
this pull request
Mar 14, 2024
* Improving typedoc config * Adding missing exports * Update deprecated-global.ts
bimusiek
pushed a commit
to bimusiek/realm-js
that referenced
this pull request
Mar 14, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What, How & Why?
After #6492 we're able to generate more clean documentation.
NOTE: This PR also introduce exports of a couple of types that we haven't historically exported, but was referenced by other public APIs.