docs: document crypto.randomBytes()

nodejs · Sep 27, 2011 · abfcd1f · abfcd1f
1 parent 413d38c
commit abfcd1f
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown
@@ -238,3 +238,21 @@ Sets the Diffie-Hellman private key. Key encoding can be `'binary'`, `'hex'`, or
 Asynchronous PBKDF2 applies pseudorandom function HMAC-SHA1 to derive
 a key of given length from the given password, salt and iterations.
 The callback gets two arguments `(err, derivedKey)`.
+
+### randomBytes(size, [callback])
+
+Generates cryptographically strong pseudo-random data. Usage:
+
+    // async
+    crypto.randomBytes(256, function(ex, buf) {
+      if (ex) throw ex;
+      console.log('Have %d bytes of random data: %s', buf.length, buf);
+    });
+
+    // sync
+    try {
+      var buf = crypto.randomBytes(256);
+      console.log('Have %d bytes of random data: %s', buf.length, buf);
+    } catch (ex) {
+      // handle error
+    }