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

Add documentation about autosubscribe field in models #7171

Open
smitit173 opened this issue Aug 23, 2021 · 2 comments
Open

Add documentation about autosubscribe field in models #7171

smitit173 opened this issue Aug 23, 2021 · 2 comments

Comments

@smitit173
Copy link

Need more documentation on autosubscribe field in models. Didn't find any relevant documentation around it

@sailsbot
Copy link

@smitit173 Thanks for posting! We'll take a look as soon as possible.

In the mean time, there are a few ways you can help speed things along:

  • look for a workaround. (Even if it's just temporary, sharing your solution can save someone else a lot of time and effort.)
  • tell us why this issue is important to you and your team. What are you trying to accomplish? (Submissions with a little bit of human context tend to be easier to understand and faster to resolve.)
  • make sure you've provided clear instructions on how to reproduce the bug from a clean install.
  • double-check that you've provided all of the requested version and dependency information. (Some of this info might seem irrelevant at first, like which database adapter you're using, but we ask that you include it anyway. Oftentimes an issue is caused by a confluence of unexpected factors, and it can save everybody a ton of time to know all the details up front.)
  • read the code of conduct.
  • if appropriate, ask your business to sponsor your issue. (Open source is our passion, and our core maintainers volunteer many of their nights and weekends working on Sails. But you only get so many nights and weekends in life, and stuff gets done a lot faster when you can work on it during normal daylight hours.)
  • let us know if you are using a 3rd party plugin; whether that's a database adapter, a non-standard view engine, or any other dependency maintained by someone other than our core team. (Besides the name of the 3rd party package, it helps to include the exact version you're using. If you're unsure, check out this list of all the core packages we maintain.)

Please remember: never post in a public forum if you believe you've found a genuine security vulnerability. Instead, disclose it responsibly.

For help with questions about Sails, click here.

@eashaw
Copy link
Member

eashaw commented Sep 3, 2021

Hi @smitit173, autosubscribe is an undocumented feature that we don't recommend using.

Resourceful pubsub was added to Sails to provide low-code real time functionality out of the box specifically via the blueprint API.
As Sails matured and supported larger and higher stakes productions apps, we separated RPS from the blueprint API as a way of easing people making the transition from blueprints to custom actions.

If you're writing your own backend code, we recommend that you avoid using autosubscribe and use the documented methods and approach found here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants