node/doc/api
Michael Dawson ce13797dca
doc: fix doc for napi_get_typedarray_info
The data pointer returned for the typedarray has
already been adjusted by the offset so it does not
point to the start of the buffer, instead id points
to the start of the first element.

I think we probably would have liked it to point to the
start of the buffer, but we can't change as that would be
a breaking change.

Update the doc to match the implementation.

PR-URL: https://github.com/nodejs/node/pull/20747
Fixes: https://github.com/nodejs/node-addon-api/issues/244
Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-05-29 14:02:29 +02:00
..
_toc.md trace_events: adds a new trace_events api 2018-04-17 10:47:41 -07:00
addons.md doc: fix stability text for n-api 2018-05-12 17:52:06 +02:00
all.md doc: prepare for v8/V8 linting in doc text 2017-11-22 08:24:46 -08:00
assert.md 2018-05-23, Version 10.2.0 (Current) 2018-05-23 17:06:43 -04:00
async_hooks.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
buffer.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
child_process.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
cli.md src,doc: add doc of --prof flag to help command 2018-05-25 14:00:33 +02:00
cluster.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
console.md doc: match console.count()/countReset() signatures 2018-05-08 18:26:16 -07:00
crypto.md 2018-05-23, Version 10.2.0 (Current) 2018-05-23 17:06:43 -04:00
debugger.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
deprecations.md doc: edit text about revoking deprecations 2018-05-08 18:26:16 -07:00
dgram.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
dns.md doc: fix typo in dns docs 2018-05-14 19:20:41 +02:00
documentation.md doc, tools: unify stability signatures 2018-05-12 17:29:57 +02:00
domain.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
errors.md doc: fix some nits in hardcoded manpage links 2018-05-22 14:28:05 -04:00
esm.md esm: provide named exports for builtin libs 2018-05-12 17:52:01 +02:00
events.md doc: clarify this in event listeners 2018-05-08 18:26:16 -07:00
fs.md doc: fix outdated link FSEvents 2018-05-25 22:43:58 +02:00
globals.md 2018-04-24, Version 10.0.0 (Current) 2018-04-23 12:19:02 -07:00
http.md 2018-05-08, Version 10.1.0 (Current) 2018-05-08 18:28:04 -07:00
http2.md http2: fix several serious bugs 2018-05-23 17:05:38 -04:00
https.md https: defines maxHeadersCount in the constructor 2018-05-08 18:26:16 -07:00
index.md
inspector.md doc: remove redundant empty lines 2018-05-04 11:54:32 -04:00
intl.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
modules.md doc: add global node_modules to require.resolve() 2018-05-12 17:52:13 +02:00
n-api.md doc: fix doc for napi_get_typedarray_info 2018-05-29 14:02:29 +02:00
net.md net: allow IPC servers be accessible by all 2018-05-25 14:01:21 +02:00
os.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
path.md doc: fix various nits 2018-04-04 13:45:39 +03:00
perf_hooks.md doc: remove redundant empty lines 2018-05-04 11:54:32 -04:00
process.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
punycode.md doc: add and unify even more return values 2018-04-16 16:05:53 -07:00
querystring.md doc: remove redundant empty lines 2018-05-04 11:54:32 -04:00
readline.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
repl.md doc: document using domain in REPL 2018-05-08 18:26:16 -07:00
stream.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
string_decoder.md doc: unify section structures 2018-04-16 16:16:08 -07:00
synopsis.md doc: add missing periods or colons 2018-05-04 12:48:38 -04:00
timers.md 2018-05-23, Version 10.2.0 (Current) 2018-05-23 17:06:43 -04:00
tls.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
tracing.md vm,trace_events: add node.vm.script trace events category 2018-05-22 14:09:48 -04:00
tty.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
url.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00
util.md doc: add util.types.isModuleNamespaceObject() 2018-05-12 17:51:25 +02:00
v8.md doc: add missing YAML keyword in v8.md metadata 2018-04-16 16:12:56 -07:00
vm.md doc: update VM section text 2018-05-12 17:29:58 +02:00
zlib.md doc: add more missing backticks 2018-05-08 14:22:25 -07:00