doc: add tls.parseCertString()

Refs: nodejs#14193
XadillaX · Jul 13, 2017 · d61d561 · d61d561
1 parent 8d1f3da
commit d61d561
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/doc/api/tls.md b/doc/api/tls.md
@@ -1149,6 +1149,37 @@ For example:
 console.log(tls.getCiphers()); // ['AES128-SHA', 'AES256-SHA', ...]
 ```
 
+## tls.parseCertString(str)
+<!-- YAML
+added: v0.3.3
+-->
+
+* `str` {string} A Cert string that joins each key-value pair with `'\n'`.
+
+Returns the parsed object. eg.
+
+```js
+tls.parseCertString(`C=US
+ST=CA
+L=SF
+O=Joyent
+OU=Node.js
+CN=ca1
+[email protected]`);
+```
+
+This will return
+
+```js
+{ C: 'US',
+  ST: 'CA',
+  L: 'SF',
+  O: 'Joyent',
+  OU: 'Node.js',
+  CN: 'ca1',
+  emailAddress: '[email protected]' }
+```
+
 ## tls.DEFAULT_ECDH_CURVE
 <!-- YAML
 added: v0.11.13