Skip to content

Commit ab76b14

Browse files
committed
doc: clarify format and return types in tls.getCACertificates()
1 parent 10e9225 commit ab76b14

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

doc/api/tls.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2326,14 +2326,17 @@ changes:
23262326
If an object, it may contain:
23272327
* `type` {string} The type of CA certificates to return. One of `"default"`, `"system"`, `"bundled"`, or `"extra"`.
23282328
**Default:** `"default"`.
2329-
* `format` {string} The format of returned certificates. One of `"string"`, `"buffer"`, or `"x509"`.
2330-
**Default:** `"string"`.
2331-
* `"string"`: Returns an array of PEM-encoded certificate strings.
2332-
* `"buffer"`: Returns an array of certificate data as `Buffer` objects in DER format.
2329+
* `format` {string} The format of returned certificates. One of `"pem"`, `"der"`, or `"x509"`.
2330+
**Default:** `"pem"`.
2331+
* `"pem"` (alias: `"string"`): Returns an array of PEM-encoded certificate strings.
2332+
* `"der"` (alias: `"buffer"`): Returns an array of certificate data as `Buffer` objects in DER format.
23332333
* `"x509"`: Returns an array of [`X509Certificate`][x509certificate] instances.
23342334

23352335
* Returns: {Array}
2336-
An array of certificate data in the specified format (Buffer or X509Certificate).
2336+
An array of certificate data in the specified format:
2337+
* PEM strings when `format` is `"pem"` (or `"string"`).
2338+
* `Buffer` objects containing DER data when `format` is `"der"` (or `"buffer"`).
2339+
* [`X509Certificate`][x509certificate] instances when `format` is `"x509"`.
23372340

23382341
* `"default"`: return the CA certificates that will be used by the Node.js TLS clients by default.
23392342
* When [`--use-bundled-ca`][] is enabled (default), or [`--use-openssl-ca`][] is not enabled,

0 commit comments

Comments
 (0)