From 0ed34005457d1879ce987aff6f20c06a7ab028e4 Mon Sep 17 00:00:00 2001 From: Andreas Madsen Date: Fri, 4 Nov 2016 21:04:43 +0100 Subject: [PATCH] warn about async wrap being an undocumented API --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6fe0b06..c2e3a7f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ### This is a fork of [CLS](https://github.com/othiym23/node-continuation-local-storage) using [AsyncWrap](https://github.com/nodejs/node-eps/blob/async-wrap-ep/XXX-asyncwrap-api.md) instead of [async-listener](https://github.com/othiym23/async-listener). ### -#### Thanks to [@trevnorris](https://github.com/trevnorris) for [AsyncWrap](https://github.com/nodejs/node-eps/blob/async-wrap-ep/XXX-asyncwrap-api.md) and all the async work in Node and [@AndreasMadsen](https://github.com/AndreasMadsen) for [async-hook](https://github.com/AndreasMadsen/async-hook). ### +**This module uses AsyncWrap which is an undocumented API, so please consider the risk before using it.** _Thanks to [@trevnorris](https://github.com/trevnorris) for [AsyncWrap](https://github.com/nodejs/node-eps/blob/async-wrap-ep/XXX-asyncwrap-api.md) and all the async work in Node and [@AndreasMadsen](https://github.com/AndreasMadsen) for [async-hook](https://github.com/AndreasMadsen/async-hook)._ Continuation-local storage works like thread-local storage in threaded programming, but is based on chains of Node-style callbacks instead of threads.