Skip to content

Commit

Permalink
Add big fat warning to README
Browse files Browse the repository at this point in the history
Recommend against using this module.
  • Loading branch information
bajtos committed Aug 1, 2016
1 parent 28e99e5 commit 62f6871
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,19 @@
Current context for LoopBack applications, based on
node-continuation-local-storage.

## WARNING

The module node-continuation-local-storage is known to have many problems,
see e.g. [issue #59](https://github.com/othiym23/node-continuation-local-storage/issues/59).
As a result, loopback-context does not work in many situations, as can be
seen from issues reported in LoopBack's
[issue tracker](https://github.com/strongloop/loopback/issues?utf8=%E2%9C%93&q=is%3Aissue%20getCurrentcontext).

**We recommend AGAINST using this module.**

If you are running on Node v6, you can try the new alternative
[cls-hooked](https://github.com/Jeff-Lewis/cls-hooked).

## Usage

1) Add `per-request` middleware to your
Expand Down Expand Up @@ -31,4 +44,6 @@ MyModel.myMethod = function(cb) {
});
```

See also https://docs.strongloop.com/display/APIC/Using+current+context
See the official LoopBack
[documentation](https://docs.strongloop.com/display/APIC/Using+current+context)
for more details.

0 comments on commit 62f6871

Please sign in to comment.