summaryrefslogtreecommitdiff
path: root/deps/npm/doc/api/npm-ping.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/api/npm-ping.md')
-rw-r--r--deps/npm/doc/api/npm-ping.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/deps/npm/doc/api/npm-ping.md b/deps/npm/doc/api/npm-ping.md
new file mode 100644
index 0000000000..4357fe2ba9
--- /dev/null
+++ b/deps/npm/doc/api/npm-ping.md
@@ -0,0 +1,14 @@
+npm-ping(3) -- Ping npm registry
+================================
+
+## SYNOPSIS
+
+ npm.registry.ping(registry, options, function (er, pong))
+
+## DESCRIPTION
+
+Attempts to connect to the given registry, returning a `pong`
+object with various metadata if it succeeds.
+
+This function is primarily useful for debugging connection issues
+to npm registries.