@codebolt/codeboltjs 1.1.68 → 1.1.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.codeboltconfig.yaml +0 -0
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/_internal_.Agent.html +43 -39
- package/docs/classes/_internal_.ClientRequest.html +57 -57
- package/docs/classes/_internal_.Codebolt.html +151 -117
- package/docs/classes/_internal_.CustomEventEmitter-1.html +30 -30
- package/docs/classes/_internal_.CustomEventEmitter.html +30 -30
- package/docs/classes/_internal_.Duplex.html +30 -30
- package/docs/classes/_internal_.EventEmitter-1.html +30 -30
- package/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html +34 -34
- package/docs/classes/_internal_.IncomingMessage.html +57 -55
- package/docs/classes/_internal_.KeyObject.html +10 -10
- package/docs/classes/_internal_.OutgoingMessage.html +41 -41
- package/docs/classes/_internal_.Readable.html +28 -28
- package/docs/classes/_internal_.ReadableBase.html +27 -27
- package/docs/classes/_internal_.Server-1.html +32 -32
- package/docs/classes/_internal_.Server-2.html +24 -24
- package/docs/classes/_internal_.Server-3.html +24 -24
- package/docs/classes/_internal_.Server.html +42 -42
- package/docs/classes/_internal_.ServerResponse.html +50 -50
- package/docs/classes/_internal_.Socket.html +28 -28
- package/docs/classes/_internal_.Stream.html +28 -28
- package/docs/classes/_internal_.TLSSocket.html +29 -29
- package/docs/classes/_internal_.URL.html +19 -19
- package/docs/classes/_internal_.URLSearchParams.html +15 -15
- package/docs/classes/_internal_.WebSocket-1.html +23 -23
- package/docs/classes/_internal_.WebSocket.Server.html +23 -23
- package/docs/classes/_internal_.Writable.html +24 -24
- package/docs/classes/_internal_.WritableBase.html +23 -23
- package/docs/classes/_internal_.X509Certificate.html +26 -26
- package/docs/classes/_internal_.internal-1.html +29 -29
- package/docs/classes/_internal_.internal.PassThrough.html +30 -30
- package/docs/classes/_internal_.internal.Transform.html +30 -30
- package/docs/enums/_internal_.logType.html +2 -2
- package/docs/functions/_internal_.internal.addAbortSignal.html +2 -2
- package/docs/functions/_internal_.internal.finished-1.html +1 -1
- package/docs/functions/_internal_.internal.pipeline-1.html +1 -1
- package/docs/interfaces/_internal_.AgentOptions.html +8 -8
- package/docs/interfaces/_internal_.AsymmetricKeyDetails.html +8 -8
- package/docs/interfaces/_internal_.Buffer.html +19 -19
- package/docs/interfaces/_internal_.CryptoKey.html +5 -5
- package/docs/interfaces/_internal_.DuplexOptions.html +1 -1
- package/docs/interfaces/_internal_.EventEmitter-2.html +17 -17
- package/docs/interfaces/_internal_.EventEmitter.Abortable.html +2 -2
- package/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html +2 -2
- package/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html +2 -2
- package/docs/interfaces/_internal_.ExtractTextResponse.html +3 -0
- package/docs/interfaces/_internal_.GetContentResponse.html +3 -0
- package/docs/interfaces/_internal_.InformationEvent.html +2 -2
- package/docs/interfaces/_internal_.JsonWebKey.html +2 -2
- package/docs/interfaces/_internal_.JwkKeyExportOptions.html +2 -2
- package/docs/interfaces/_internal_.KeyAlgorithm.html +2 -2
- package/docs/interfaces/_internal_.KeyExportOptions.html +2 -2
- package/docs/interfaces/_internal_.ListenOptions.html +1 -1
- package/docs/interfaces/_internal_.LookupAddress.html +3 -3
- package/docs/interfaces/_internal_.LookupOptions.html +12 -5
- package/docs/interfaces/_internal_.ReadWriteStream.html +16 -16
- package/docs/interfaces/_internal_.ReadableOptions.html +1 -1
- package/docs/interfaces/_internal_.ReadableStream-1.html +16 -16
- package/docs/interfaces/_internal_.Selection.html +6 -0
- package/docs/interfaces/_internal_.ServerOptions.html +7 -8
- package/docs/interfaces/_internal_.StaticEventEmitterOptions.html +15 -2
- package/docs/interfaces/_internal_.StreamOptions.html +1 -1
- package/docs/interfaces/_internal_.UserMessage.html +3 -0
- package/docs/interfaces/_internal_.UserRequest.html +7 -0
- package/docs/interfaces/_internal_.WebSocket.WebSocket.html +11 -11
- package/docs/interfaces/_internal_.WebSocket.WebSocketServer.html +11 -11
- package/docs/interfaces/_internal_.WebSocketAlias.html +11 -11
- package/docs/interfaces/_internal_.WritableOptions.html +1 -1
- package/docs/interfaces/_internal_.WritableStream.html +16 -16
- package/docs/interfaces/_internal_.X509CheckOptions.html +6 -6
- package/docs/interfaces/_internal_.internal.FinishedOptions.html +1 -1
- package/docs/interfaces/_internal_.internal.TransformOptions.html +1 -1
- package/docs/modules/_internal_.EventEmitter.html +1 -1
- package/docs/modules/_internal_.html +5 -2
- package/docs/types/_internal_.AnyRest.html +1 -1
- package/docs/types/_internal_.Args.html +1 -1
- package/docs/types/_internal_.BinaryLike.html +1 -1
- package/docs/types/_internal_.DefaultEventMap.html +1 -1
- package/docs/types/_internal_.EventMap.html +1 -1
- package/docs/types/_internal_.Key.html +1 -1
- package/docs/types/_internal_.Key2.html +1 -1
- package/docs/types/_internal_.KeyFormat.html +1 -1
- package/docs/types/_internal_.KeyObjectType.html +1 -1
- package/docs/types/_internal_.KeyType-1.html +1 -1
- package/docs/types/_internal_.KeyType.html +1 -1
- package/docs/types/_internal_.KeyUsage.html +1 -1
- package/docs/types/_internal_.Listener.html +1 -1
- package/docs/types/_internal_.RequestListener.html +1 -1
- package/docs/variables/default.html +1 -1
- package/index.d.ts +1 -1
- package/modules/codeutils.d.ts +1 -1
- package/modules/codeutils.js +64 -94
- package/package.json +1 -3
- package/src/modules/codeutils.ts +67 -67
- package/docs/interfaces/_internal_.CommandOutput.html +0 -3
- package/docs/interfaces/_internal_.GetJsTreeResponse.html +0 -3
|
@@ -7,7 +7,7 @@ passing keys as strings or <code>Buffer</code>s due to improved security feature
|
|
|
7
7
|
The receiver obtains a cloned <code>KeyObject</code>, and the <code>KeyObject</code> does not need to
|
|
8
8
|
be listed in the <code>transferList</code> argument.</p>
|
|
9
9
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v11.6.0</p>
|
|
10
|
-
</div></section><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
10
|
+
</div></section><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:571</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_internal_.KeyObject.html#constructor" class="tsd-index-link tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
11
11
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_internal_.KeyObject.html#asymmetricKeyDetails" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asymmetric<wbr/>Key<wbr/>Details?</span></a>
|
|
12
12
|
<a href="_internal_.KeyObject.html#asymmetricKeySize" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asymmetric<wbr/>Key<wbr/>Size?</span></a>
|
|
13
13
|
<a href="_internal_.KeyObject.html#asymmetricKeyType" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asymmetric<wbr/>Key<wbr/>Type?</span></a>
|
|
@@ -16,7 +16,7 @@ be listed in the <code>transferList</code> argument.</p>
|
|
|
16
16
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_internal_.KeyObject.html#equals" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a>
|
|
17
17
|
<a href="_internal_.KeyObject.html#export" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export</span></a>
|
|
18
18
|
<a href="_internal_.KeyObject.html#from" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a>
|
|
19
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_KeyObject" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Key<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a><a href="#constructor.new_KeyObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
19
|
+
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-is-private tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-private tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_KeyObject" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Key<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a><a href="#constructor.new_KeyObject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:572</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="asymmetricKeyDetails" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>asymmetric<wbr/>Key<wbr/>Details</span><a href="#asymmetricKeyDetails" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asymmetric<wbr/>Key<wbr/>Details</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_internal_.AsymmetricKeyDetails.html" class="tsd-signature-type tsd-kind-interface">AsymmetricKeyDetails</a></div><div class="tsd-comment tsd-typography"><p>This property exists only on asymmetric keys. Depending on the type of the key,
|
|
20
20
|
this object contains information about the key. None of the information obtained
|
|
21
21
|
through this property can be used to uniquely identify a key or to compromise
|
|
22
22
|
the security of the key.</p>
|
|
@@ -25,9 +25,9 @@ the <code>hashAlgorithm</code>, <code>mgf1HashAlgorithm</code>, and <code>saltLe
|
|
|
25
25
|
set.</p>
|
|
26
26
|
<p>Other key details might be exposed via this API using additional attributes.</p>
|
|
27
27
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.7.0</p>
|
|
28
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
28
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:630</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="asymmetricKeySize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>asymmetric<wbr/>Key<wbr/>Size</span><a href="#asymmetricKeySize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asymmetric<wbr/>Key<wbr/>Size</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>For asymmetric keys, this property represents the size of the embedded key in
|
|
29
29
|
bytes. This property is <code>undefined</code> for symmetric keys.</p>
|
|
30
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
30
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:616</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="asymmetricKeyType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>asymmetric<wbr/>Key<wbr/>Type</span><a href="#asymmetricKeyType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">asymmetric<wbr/>Key<wbr/>Type</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_internal_.KeyType.html" class="tsd-signature-type tsd-kind-type-alias">KeyType</a></div><div class="tsd-comment tsd-typography"><p>For asymmetric keys, this property represents the type of the key. Supported key
|
|
31
31
|
types are:</p>
|
|
32
32
|
<ul>
|
|
33
33
|
<li><code>'rsa'</code> (OID 1.2.840.113549.1.1.1)</li>
|
|
@@ -43,17 +43,17 @@ types are:</p>
|
|
|
43
43
|
<p>This property is <code>undefined</code> for unrecognized <code>KeyObject</code> types and symmetric
|
|
44
44
|
keys.</p>
|
|
45
45
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v11.6.0</p>
|
|
46
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
46
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:611</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="symmetricKeySize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>symmetric<wbr/>Key<wbr/>Size</span><a href="#symmetricKeySize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">symmetric<wbr/>Key<wbr/>Size</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>For secret keys, this property represents the size of the key in bytes. This
|
|
47
47
|
property is <code>undefined</code> for asymmetric keys.</p>
|
|
48
48
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v11.6.0</p>
|
|
49
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
49
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:669</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.KeyObjectType.html" class="tsd-signature-type tsd-kind-type-alias">KeyObjectType</a></div><div class="tsd-comment tsd-typography"><p>Depending on the type of this <code>KeyObject</code>, this property is either<code>'secret'</code> for secret (symmetric) keys, <code>'public'</code> for public (asymmetric) keys
|
|
50
50
|
or <code>'private'</code> for private (asymmetric) keys.</p>
|
|
51
51
|
</div><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v11.6.0</p>
|
|
52
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
52
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:675</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="equals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>equals</span><a href="#equals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="equals.equals-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">equals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">otherKeyObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#equals.equals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns <code>true</code> or <code>false</code> depending on whether the keys have exactly the same
|
|
53
53
|
type, value, and parameters. This method is not <a href="https://en.wikipedia.org/wiki/Timing_attack">constant time</a>.</p>
|
|
54
54
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">otherKeyObject</span>: <a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a></span><div class="tsd-comment tsd-typography"><p>A <code>KeyObject</code> with which to compare <code>keyObject</code>.</p>
|
|
55
55
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v17.7.0, v16.15.0</p>
|
|
56
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
56
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:663</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="export" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>export</span><a href="#export" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="export.export-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><a href="#export.export-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>For symmetric keys, the following encoding options can be used:</p>
|
|
57
57
|
<p>For public keys, the following encoding options can be used:</p>
|
|
58
58
|
<p>For private keys, the following encoding options can be used:</p>
|
|
59
59
|
<p>The result type depends on the selected encoding format, when PEM the
|
|
@@ -69,8 +69,8 @@ encryption mechanism, PEM-level encryption is not supported when encrypting
|
|
|
69
69
|
a PKCS#8 key. See <a href="https://www.rfc-editor.org/rfc/rfc5208.txt">RFC 5208</a> for PKCS#8 encryption and <a href="https://www.rfc-editor.org/rfc/rfc1421.txt">RFC 1421</a> for
|
|
70
70
|
PKCS#1 and SEC1 encryption.</p>
|
|
71
71
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/_internal_.KeyExportOptions.html" class="tsd-signature-type tsd-kind-interface">KeyExportOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"pem"</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v11.6.0</p>
|
|
72
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
72
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:654</li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="export.export-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><a href="#export.export-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/_internal_.KeyExportOptions.html" class="tsd-signature-type tsd-kind-interface">KeyExportOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"der"</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:655</li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="export.export-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.JsonWebKey.html" class="tsd-signature-type tsd-kind-interface">JsonWebKey</a><a href="#export.export-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/_internal_.JwkKeyExportOptions.html" class="tsd-signature-type tsd-kind-interface">JwkKeyExportOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_internal_.JsonWebKey.html" class="tsd-signature-type tsd-kind-interface">JsonWebKey</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:656</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="from.from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Example: Converting a <code>CryptoKey</code> instance to a <code>KeyObject</code>:</p>
|
|
73
73
|
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">KeyObject</span><span class="hl-1"> } = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-3">import</span><span class="hl-1">(</span><span class="hl-2">'node:crypto'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">subtle</span><span class="hl-1"> } = </span><span class="hl-7">globalThis</span><span class="hl-1">.</span><span class="hl-7">crypto</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">key</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-7">subtle</span><span class="hl-1">.</span><span class="hl-0">generateKey</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-7">name:</span><span class="hl-1"> </span><span class="hl-2">'HMAC'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">hash:</span><span class="hl-1"> </span><span class="hl-2">'SHA-256'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">length:</span><span class="hl-1"> </span><span class="hl-9">256</span><span class="hl-1">,</span><br/><span class="hl-1">}, </span><span class="hl-3">true</span><span class="hl-1">, [</span><span class="hl-2">'sign'</span><span class="hl-1">, </span><span class="hl-2">'verify'</span><span class="hl-1">]);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">keyObject</span><span class="hl-1"> = </span><span class="hl-7">KeyObject</span><span class="hl-1">.</span><span class="hl-0">from</span><span class="hl-1">(</span><span class="hl-7">key</span><span class="hl-1">);</span><br/><span class="hl-7">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-7">keyObject</span><span class="hl-1">.</span><span class="hl-7">symmetricKeySize</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints: 32 (symmetric key size in bytes)</span>
|
|
74
74
|
</code><button>Copy</button></pre>
|
|
75
75
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <a href="../interfaces/_internal_.CryptoKey.html" class="tsd-signature-type tsd-kind-interface">CryptoKey</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_internal_.KeyObject.html" class="tsd-signature-type tsd-kind-class">KeyObject</a></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v15.0.0</p>
|
|
76
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:
|
|
76
|
+
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/crypto.d.ts:592</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class="tsd-is-private tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#asymmetricKeyDetails" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asymmetric<wbr/>Key<wbr/>Details</span></a><a href="#asymmetricKeySize" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asymmetric<wbr/>Key<wbr/>Size</span></a><a href="#asymmetricKeyType" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asymmetric<wbr/>Key<wbr/>Type</span></a><a href="#symmetricKeySize" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>symmetric<wbr/>Key<wbr/>Size</span></a><a href="#type" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#equals" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a><a href="#export" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export</span></a><a href="#from" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@codebolt/codeboltjs</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|