-
Notifications
You must be signed in to change notification settings - Fork 36
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
Refactor public api #80
Merged
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
This the public facing API: - `targaryen.create(rules: object|Ruleset, data: object|DataNode, now: null|number): Database`; - `Database.as(auth: null|object): Database`; - `Database.read(path: string, now: null|number): Result`; - `Database.write(path: string, value: any, priority: any, now: null|number): Result`; - `Database.write(path: string, patch: object, now: null|number): Result`; targaryen also provides `targaryen.util` to help writing testing framework plugin.
Util doesn’t need to be access directly: - it’s available as `targaryen.util` - No circular dependencies; plugins can import access them via `targaryen.util`;
Also rename database common variable name from `data` to `db`.
dinoboff
force-pushed
the
refactor-public-api
branch
from
November 7, 2016 11:43
112412d
to
c7385f4
Compare
I added basic usage of the CLI and plugins; I don’t to give the impression the API is the main way to test rules.
dinoboff
force-pushed
the
refactor-public-api
branch
from
November 8, 2016 11:23
2a3d382
to
c0e8df7
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.
Add
targaryen.database(rules, data, now)
This is the public facing API:
targaryen.database(rules: object|Ruleset, data: object|DataNode, now: null|number): Database
;Database.as(auth: null|object): Database
;Database.read(path: string, now: null|number): Result
;Database.write(path: string, value: any, priority: any, now: null|number): Result
;Database.update(path: string, patch: object, now: null|number): Result
.Example:
targaryen also provides
targaryen.util
to help write testing framework plugin.Result
main properties arepath
,newValue
,auth
,database
andnewDatabase
.Low level constructors (Ruleset and DataSnapshot) or functions (like pathMerger) are not accessible directly anymore.