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

Adapter Docs #930

Merged
merged 2 commits into from
May 18, 2017
Merged

Adapter Docs #930

merged 2 commits into from
May 18, 2017

Conversation

alazier
Copy link
Contributor

@alazier alazier commented Mar 20, 2017

@alazier
Copy link
Contributor Author

alazier commented Mar 20, 2017

For some reason Instruction doesn't show up as TypeDefinition under Adatper. Any idea how to fix this @kristiandupont ?

Copy link
Contributor

@kristiandupont kristiandupont left a comment

Choose a reason for hiding this comment

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

A few comments but generally looks good.

I don't know why the Instruction doesn't appear under Adapter, but I am not sure jsdoc even supports nested items like that?



/**
* Class for creating custom Data Connectors. Only available in the Enterprise Edition.
Copy link
Contributor

Choose a reason for hiding this comment

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

Only available in the Enterprise Edition.

We should probably add a custom tag for this, but we can do this for now.

* @param {string} local_path - the local path where realm files are stored
* @param {string} server_url - the sync server to listen to
* @param {SyncUser} admin_user - an admin user obtained by calling `new Realm.Sync.User.adminUser`
* @param {string} regex - a regular expression used to determine which cahnged Realms should be monitored -
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: cahnged. Also, this could probably explain what the regex is matching on. Is it the relative path?

class Adapter {
/**
* Create a new Adapter to moitor and process changes made across multiple Realms
* @param {string} local_path - the local path where realm files are stored
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this where the synced realms that are being monitored will be stored? Or is it for some metadata realm? Does this mean that my server running the adapter should potentially have storage available comparable to my actual database server (or, in case they're the same, twice the space necessary for the data)?

@kristiandupont
Copy link
Contributor

Oh, but one more thing: is there a particular reason why we keep everyting sync-related in one file?It seems like it would be nicer to separate it.

@kristiandupont kristiandupont merged commit 9258d95 into master May 18, 2017
@kristiandupont kristiandupont deleted the al/adapter-docs branch May 18, 2017 11:40
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants