sails-hook-blueprints

Implements support for the blueprint API in Sails.

This is a hook for the Sails.js framework. You can override or disable it using your .sailsrc file or environment variables. See Concepts > Configuration for more information.

Dependencies

In order for this hook to load, the following other hooks must have already finished loading:

N/A

Dependents

If this hook is disabled, in order for Sails to load, the following core hooks must also be disabled:

N/A

Purpose

This hook's responsibilities are:

1. Register blueprint actions.
2. Bind a few kinds of shadow routes (blueprint routes) that point to controller actions if defined, falling back to blueprint actions otherwise.

Implicit defaults

See Reference > Configuration > sails.config.blueprints for a list of implicit default settings that this hook attaches to sails.config.

Methods

n/a

FAQ

Can I disable this hook?

Yes. To disable this hook, merge the following JSON into your app's .sailsrc file:

{
  "hooks": {
    "blueprints": false
  }
}

Can I override this hook to use my own default blueprint API?

Yes. To override this hook, define your replacement hook under your app's api/hooks/ directory. Or, to share your override with the world, publish it on NPM (e.g. @mynpmusername/sails-hook-blueprints or sails-hook-emberprints). Just be sure to include the following in your package.json:

"sails": {
  "isHook": true,
  "hookName": "blueprints"
}

See the package.json file in this repo for reference.

For more information on overriding core hooks, check out Extending Sails > Hooks.

Help

If you have further questions or are having trouble, click here.

Bugs  

To report a bug, click here.

Contributing

Please observe the guidelines and conventions laid out in the Sails project contribution guide when opening issues or submitting pull requests.

License

The Sails framework is free and open-source under the MIT License.