Hoodie Global Share Plugin
Make selected objects publically accessible via hoodie.global store methods.
Installation
hoodie install global-share
Usage
The Global Share Plugin extends all promises returned by hoodie.store
methods
with two additional functions: publish
and unpublish
.
// publish all my todoshoodiestore // unpublish specific notehoodiestore
All objects marked as public are accessible (read-only) via the
hoodie.global
API
// list all public taskshoodieglobal // update list of tasks on changehoodieglobal
Full Frontend API
add / remove own objects from the public global store
// publish / unpublish can be called on all promises// return by any hoodie.store method.promise = hoodiestorepromise = hoodiestorepromise = hoodiestorepromise = hoodiestorepromise = hoodiestorepromise = hoodiestorepromise = hoodiestorepromise = hoodiestore // it works the same on scoped storespromise = hoodiepromise = hoodie // publish / unpublish return own promises that only resolve// if the objects were published successfully on the serverpromise;
access objects from / listen to changes in the public global store
// hoodie.global has all read-only methods from hoodie.store,// with the same footprintpromise = hoodieglobalpromise = hoodieglobal // you can listen on changes as wellhoodieglobalhoodieglobalhoodieglobal
How it works internally
The plugin's worker
creates a new database hoodie-plugin-global-share
that all objects from all
user databases that are marked as public are replicated to.
Calling .publish()
on a store method in the frontend adds a $public: true
flag to the respecitve objects, that is used by the filtered replications from
user databases → hoodie-plugin-global-share
database.
Calling .unpublish()
uses the hoodie.task
API internally to start globalshareunpublish
task with object types/IDs to be unpublished. The task gets picked up by the worker
which then removes all objects with the passed types/IDs from the hoodie-plugin-global-share
database.
Contributing
We love contributors <3 If you need any help getting started, please don't hesitate to get in touch at any time.
For Questions/Bug reports specific to the Global Share Plugin:
https://github.com/hoodiehq/hoodie-plugin-global-share/issues/new
For more generic questions to Hoodie Architecture etc. https://github.com/hoodiehq/discussion/issues/new
If you want to send pull requests, please make sure to add according tests. Run tests with
grunt
License & Copyright
Copyright 2012-2014 https://github.com/hoodiehq/ and other contributors
Licensed under the Apache License 2.0.