docs: hide path from the doc headers

panva · Oct 14, 2021 · 4f7f8a8 · 4f7f8a8
1 parent 64197f0
commit 4f7f8a8
Show file tree

Hide file tree

Showing 100 changed files with 13 additions and 198 deletions.
diff --git a/docs/classes/jwe_compact_encrypt.CompactEncrypt.md b/docs/classes/jwe_compact_encrypt.CompactEncrypt.md
@@ -1,7 +1,5 @@
 # Class: CompactEncrypt
 
-[jwe/compact/encrypt](../modules/jwe_compact_encrypt.md).CompactEncrypt
-
 The CompactEncrypt class is a utility for creating Compact JWE strings.
 
 **`example`** ESM import

diff --git a/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md b/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md
@@ -1,7 +1,5 @@
 # Class: FlattenedEncrypt
 
-[jwe/flattened/encrypt](../modules/jwe_flattened_encrypt.md).FlattenedEncrypt
-
 The FlattenedEncrypt class is a utility for creating Flattened JWE
 objects.
 

diff --git a/docs/classes/jws_compact_sign.CompactSign.md b/docs/classes/jws_compact_sign.CompactSign.md
@@ -1,7 +1,5 @@
 # Class: CompactSign
 
-[jws/compact/sign](../modules/jws_compact_sign.md).CompactSign
-
 The CompactSign class is a utility for creating Compact JWS strings.
 
 **`example`** ESM import

diff --git a/docs/classes/jws_flattened_sign.FlattenedSign.md b/docs/classes/jws_flattened_sign.FlattenedSign.md
@@ -1,7 +1,5 @@
 # Class: FlattenedSign
 
-[jws/flattened/sign](../modules/jws_flattened_sign.md).FlattenedSign
-
 The FlattenedSign class is a utility for creating Flattened JWS objects.
 
 **`example`** ESM import

diff --git a/docs/classes/jws_general_sign.GeneralSign.md b/docs/classes/jws_general_sign.GeneralSign.md
@@ -1,7 +1,5 @@
 # Class: GeneralSign
 
-[jws/general/sign](../modules/jws_general_sign.md).GeneralSign
-
 The GeneralSign class is a utility for creating General JWS objects.
 
 **`example`** ESM import

diff --git a/docs/classes/jwt_encrypt.EncryptJWT.md b/docs/classes/jwt_encrypt.EncryptJWT.md
@@ -1,7 +1,5 @@
 # Class: EncryptJWT
 
-[jwt/encrypt](../modules/jwt_encrypt.md).EncryptJWT
-
 The EncryptJWT class is a utility for creating Compact JWE formatted JWT strings.
 
 **`example`** ESM import

diff --git a/docs/classes/jwt_produce.ProduceJWT.md b/docs/classes/jwt_produce.ProduceJWT.md
@@ -1,7 +1,5 @@
 # Class: ProduceJWT
 
-[jwt/produce](../modules/jwt_produce.md).ProduceJWT
-
 Generic class for JWT producing.
 
 ## Table of contents

diff --git a/docs/classes/jwt_sign.SignJWT.md b/docs/classes/jwt_sign.SignJWT.md
@@ -1,7 +1,5 @@
 # Class: SignJWT
 
-[jwt/sign](../modules/jwt_sign.md).SignJWT
-
 The SignJWT class is a utility for creating Compact JWS formatted JWT strings.
 
 **`example`** ESM import

diff --git a/docs/classes/jwt_unsecured.UnsecuredJWT.md b/docs/classes/jwt_unsecured.UnsecuredJWT.md
@@ -1,7 +1,5 @@
 # Class: UnsecuredJWT
 
-[jwt/unsecured](../modules/jwt_unsecured.md).UnsecuredJWT
-
 The UnsecuredJWT class is a utility for dealing with `{ "alg": "none" }` Unsecured JWTs.
 
 **`example`** ESM import

diff --git a/docs/classes/util_errors.JOSEAlgNotAllowed.md b/docs/classes/util_errors.JOSEAlgNotAllowed.md
@@ -1,7 +1,5 @@
 # Class: JOSEAlgNotAllowed
 
-[util/errors](../modules/util_errors.md).JOSEAlgNotAllowed
-
 An error subclass thrown when a JOSE Algorithm is not allowed per developer preference.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JOSEError.md b/docs/classes/util_errors.JOSEError.md
@@ -1,7 +1,5 @@
 # Class: JOSEError
 
-[util/errors](../modules/util_errors.md).JOSEError
-
 A generic Error subclass that all other specific
 JOSE Error subclasses inherit from.
 

diff --git a/docs/classes/util_errors.JOSENotSupported.md b/docs/classes/util_errors.JOSENotSupported.md
@@ -1,7 +1,5 @@
 # Class: JOSENotSupported
 
-[util/errors](../modules/util_errors.md).JOSENotSupported
-
 An error subclass thrown when a particular feature or algorithm is not supported by this
 implementation or JOSE in general.
 

diff --git a/docs/classes/util_errors.JWEDecryptionFailed.md b/docs/classes/util_errors.JWEDecryptionFailed.md
@@ -1,7 +1,5 @@
 # Class: JWEDecryptionFailed
 
-[util/errors](../modules/util_errors.md).JWEDecryptionFailed
-
 An error subclass thrown when a JWE ciphertext decryption fails.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWEInvalid.md b/docs/classes/util_errors.JWEInvalid.md
@@ -1,7 +1,5 @@
 # Class: JWEInvalid
 
-[util/errors](../modules/util_errors.md).JWEInvalid
-
 An error subclass thrown when a JWE is invalid.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWKInvalid.md b/docs/classes/util_errors.JWKInvalid.md
@@ -1,7 +1,5 @@
 # Class: JWKInvalid
 
-[util/errors](../modules/util_errors.md).JWKInvalid
-
 An error subclass thrown when a JWK is invalid.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWKSInvalid.md b/docs/classes/util_errors.JWKSInvalid.md
@@ -1,7 +1,5 @@
 # Class: JWKSInvalid
 
-[util/errors](../modules/util_errors.md).JWKSInvalid
-
 An error subclass thrown when a JWKS is invalid.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWKSMultipleMatchingKeys.md b/docs/classes/util_errors.JWKSMultipleMatchingKeys.md
@@ -1,7 +1,5 @@
 # Class: JWKSMultipleMatchingKeys
 
-[util/errors](../modules/util_errors.md).JWKSMultipleMatchingKeys
-
 An error subclass thrown when multiple keys match from a JWKS.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWKSNoMatchingKey.md b/docs/classes/util_errors.JWKSNoMatchingKey.md
@@ -1,7 +1,5 @@
 # Class: JWKSNoMatchingKey
 
-[util/errors](../modules/util_errors.md).JWKSNoMatchingKey
-
 An error subclass thrown when no keys match from a JWKS.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWKSTimeout.md b/docs/classes/util_errors.JWKSTimeout.md
@@ -1,7 +1,5 @@
 # Class: JWKSTimeout
 
-[util/errors](../modules/util_errors.md).JWKSTimeout
-
 Timeout was reached when retrieving the JWKS response.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWSInvalid.md b/docs/classes/util_errors.JWSInvalid.md
@@ -1,7 +1,5 @@
 # Class: JWSInvalid
 
-[util/errors](../modules/util_errors.md).JWSInvalid
-
 An error subclass thrown when a JWS is invalid.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWSSignatureVerificationFailed.md b/docs/classes/util_errors.JWSSignatureVerificationFailed.md
@@ -1,7 +1,5 @@
 # Class: JWSSignatureVerificationFailed
 
-[util/errors](../modules/util_errors.md).JWSSignatureVerificationFailed
-
 An error subclass thrown when JWS signature verification fails.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWTClaimValidationFailed.md b/docs/classes/util_errors.JWTClaimValidationFailed.md
@@ -1,7 +1,5 @@
 # Class: JWTClaimValidationFailed
 
-[util/errors](../modules/util_errors.md).JWTClaimValidationFailed
-
 An error subclass thrown when a JWT Claim Set member validation fails.
 
 ## Table of contents

diff --git a/docs/classes/util_errors.JWTExpired.md b/docs/classes/util_errors.JWTExpired.md
@@ -1,7 +1,5 @@
 # Class: JWTExpired
 
-[util/errors](../modules/util_errors.md).JWTExpired
-
 An error subclass thrown when a JWT is expired.
 
 ## Table of contents
@@ -64,6 +62,8 @@ Reason code for the validation failure.
 
 • `Static` `get` **code**(): ``"ERR_JWT_EXPIRED"``
 
+A unique error code for the particular error subclass.
+
 #### Returns
 
 ``"ERR_JWT_EXPIRED"``
diff --git a/docs/classes/util_errors.JWTInvalid.md b/docs/classes/util_errors.JWTInvalid.md
@@ -1,7 +1,5 @@
 # Class: JWTInvalid
 
-[util/errors](../modules/util_errors.md).JWTInvalid
-
 An error subclass thrown when a JWT is invalid.
 
 ## Table of contents

diff --git a/docs/functions/jwe_compact_decrypt.compactDecrypt.md b/docs/functions/jwe_compact_decrypt.compactDecrypt.md
@@ -1,7 +1,5 @@
 # Function: compactDecrypt
 
-[jwe/compact/decrypt](../modules/jwe_compact_decrypt.md).compactDecrypt
-
 ▸ **compactDecrypt**(`jwe`, `key`, `options?`): `Promise`<[`CompactDecryptResult`](../interfaces/types.CompactDecryptResult.md)\>
 
 Decrypts a Compact JWE.

diff --git a/docs/functions/jwe_flattened_decrypt.flattenedDecrypt.md b/docs/functions/jwe_flattened_decrypt.flattenedDecrypt.md
@@ -1,7 +1,5 @@
 # Function: flattenedDecrypt
 
-[jwe/flattened/decrypt](../modules/jwe_flattened_decrypt.md).flattenedDecrypt
-
 ▸ **flattenedDecrypt**(`jwe`, `key`, `options?`): `Promise`<[`FlattenedDecryptResult`](../interfaces/types.FlattenedDecryptResult.md)\>
 
 Decrypts a Flattened JWE.

diff --git a/docs/functions/jwe_general_decrypt.generalDecrypt.md b/docs/functions/jwe_general_decrypt.generalDecrypt.md
@@ -1,7 +1,5 @@
 # Function: generalDecrypt
 
-[jwe/general/decrypt](../modules/jwe_general_decrypt.md).generalDecrypt
-
 ▸ **generalDecrypt**(`jwe`, `key`, `options?`): `Promise`<[`GeneralDecryptResult`](../interfaces/types.GeneralDecryptResult.md)\>
 
 Decrypts a General JWE.

diff --git a/docs/functions/jwk_embedded.EmbeddedJWK.md b/docs/functions/jwk_embedded.EmbeddedJWK.md
@@ -1,7 +1,5 @@
 # Function: EmbeddedJWK
 
-[jwk/embedded](../modules/jwk_embedded.md).EmbeddedJWK
-
 ▸ **EmbeddedJWK**(`protectedHeader`, `token`): `Promise`<[`KeyLike`](../types/types.KeyLike.md)\>
 
 EmbeddedJWK is an implementation of a GetKeyFunction intended to be used with the

diff --git a/docs/functions/jwk_from_key_like.fromKeyLike.md b/docs/functions/jwk_from_key_like.fromKeyLike.md
@@ -1,7 +1,5 @@
 # Function: fromKeyLike
 
-[jwk/from_key_like](../modules/jwk_from_key_like.md).fromKeyLike
-
 ▸ **fromKeyLike**(`key`): `Promise`<[`JWK`](../interfaces/types.JWK.md)\>
 
 **`deprecated`** use `jose/key/export`

diff --git a/docs/functions/jwk_parse.parseJwk.md b/docs/functions/jwk_parse.parseJwk.md
@@ -1,7 +1,5 @@
 # Function: parseJwk
 
-[jwk/parse](../modules/jwk_parse.md).parseJwk
-
 ▸ **parseJwk**(`jwk`, `alg?`, `octAsKeyObject?`): `Promise`<[`KeyLike`](../types/types.KeyLike.md) \| `Uint8Array`\>
 
 **`deprecated`** use `jose/key/import`

diff --git a/docs/functions/jwk_thumbprint.calculateThumbprint.md b/docs/functions/jwk_thumbprint.calculateThumbprint.md
@@ -1,7 +1,5 @@
 # Function: calculateThumbprint
 
-[jwk/thumbprint](../modules/jwk_thumbprint.md).calculateThumbprint
-
 ▸ **calculateThumbprint**(`jwk`, `digestAlgorithm?`): `Promise`<`string`\>
 
 Calculates a base64url-encoded JSON Web Key (JWK) Thumbprint as per

diff --git a/docs/functions/jwks_remote.createRemoteJWKSet.md b/docs/functions/jwks_remote.createRemoteJWKSet.md
@@ -1,7 +1,5 @@
 # Function: createRemoteJWKSet
 
-[jwks/remote](../modules/jwks_remote.md).createRemoteJWKSet
-
 ▸ **createRemoteJWKSet**(`url`, `options?`): [`GetKeyFunction`](../interfaces/types.GetKeyFunction.md)<[`JWSHeaderParameters`](../interfaces/types.JWSHeaderParameters.md), [`FlattenedJWSInput`](../interfaces/types.FlattenedJWSInput.md)\>
 
 Returns a function that resolves to a key object downloaded from a

diff --git a/docs/functions/jws_compact_verify.compactVerify.md b/docs/functions/jws_compact_verify.compactVerify.md
@@ -1,7 +1,5 @@
 # Function: compactVerify
 
-[jws/compact/verify](../modules/jws_compact_verify.md).compactVerify
-
 ▸ **compactVerify**(`jws`, `key`, `options?`): `Promise`<[`CompactVerifyResult`](../interfaces/types.CompactVerifyResult.md)\>
 
 Verifies the signature and format of and afterwards decodes the Compact JWS.

diff --git a/docs/functions/jws_flattened_verify.flattenedVerify.md b/docs/functions/jws_flattened_verify.flattenedVerify.md
@@ -1,7 +1,5 @@
 # Function: flattenedVerify
 
-[jws/flattened/verify](../modules/jws_flattened_verify.md).flattenedVerify
-
 ▸ **flattenedVerify**(`jws`, `key`, `options?`): `Promise`<[`FlattenedVerifyResult`](../interfaces/types.FlattenedVerifyResult.md)\>
 
 Verifies the signature and format of and afterwards decodes the Flattened JWS.

diff --git a/docs/functions/jws_general_verify.generalVerify.md b/docs/functions/jws_general_verify.generalVerify.md
@@ -1,7 +1,5 @@
 # Function: generalVerify
 
-[jws/general/verify](../modules/jws_general_verify.md).generalVerify
-
 ▸ **generalVerify**(`jws`, `key`, `options?`): `Promise`<[`GeneralVerifyResult`](../interfaces/types.GeneralVerifyResult.md)\>
 
 Verifies the signature and format of and afterwards decodes the General JWS.

diff --git a/docs/functions/jwt_decrypt.jwtDecrypt.md b/docs/functions/jwt_decrypt.jwtDecrypt.md
@@ -1,7 +1,5 @@
 # Function: jwtDecrypt
 
-[jwt/decrypt](../modules/jwt_decrypt.md).jwtDecrypt
-
 ▸ **jwtDecrypt**(`jwt`, `key`, `options?`): `Promise`<[`JWTDecryptResult`](../interfaces/types.JWTDecryptResult.md)\>
 
 Verifies the JWT format (to be a JWE Compact format), decrypts the ciphertext, validates the JWT Claims Set.

diff --git a/docs/functions/jwt_verify.jwtVerify.md b/docs/functions/jwt_verify.jwtVerify.md
@@ -1,7 +1,5 @@
 # Function: jwtVerify
 
-[jwt/verify](../modules/jwt_verify.md).jwtVerify
-
 ▸ **jwtVerify**(`jwt`, `key`, `options?`): `Promise`<[`JWTVerifyResult`](../interfaces/types.JWTVerifyResult.md)\>
 
 Verifies the JWT format (to be a JWS Compact format), verifies the JWS signature, validates the JWT Claims Set.

diff --git a/docs/functions/key_export.exportJWK.md b/docs/functions/key_export.exportJWK.md
@@ -1,7 +1,5 @@
 # Function: exportJWK
 
-[key/export](../modules/key_export.md).exportJWK
-
 ▸ **exportJWK**(`key`): `Promise`<[`JWK`](../interfaces/types.JWK.md)\>
 
 Exports a runtime-specific key representation (KeyLike) to a JWK.

diff --git a/docs/functions/key_export.exportPKCS8.md b/docs/functions/key_export.exportPKCS8.md
@@ -1,7 +1,5 @@
 # Function: exportPKCS8
 
-[key/export](../modules/key_export.md).exportPKCS8
-
 ▸ **exportPKCS8**(`key`): `Promise`<`string`\>
 
 Exports a runtime-specific private key representation (KeyObject or CryptoKey) to an PEM-encoded PKCS8 string format.

diff --git a/docs/functions/key_export.exportSPKI.md b/docs/functions/key_export.exportSPKI.md
@@ -1,7 +1,5 @@
 # Function: exportSPKI
 
-[key/export](../modules/key_export.md).exportSPKI
-
 ▸ **exportSPKI**(`key`): `Promise`<`string`\>
 
 Exports a runtime-specific public key representation (KeyObject or CryptoKey) to an PEM-encoded SPKI string format.

diff --git a/docs/functions/key_import.importJWK.md b/docs/functions/key_import.importJWK.md
@@ -1,7 +1,5 @@
 # Function: importJWK
 
-[key/import](../modules/key_import.md).importJWK
-
 ▸ **importJWK**(`jwk`, `alg?`, `octAsKeyObject?`): `Promise`<[`KeyLike`](../types/types.KeyLike.md) \| `Uint8Array`\>
 
 Imports a JWK to a runtime-specific key representation (KeyLike). Either

diff --git a/docs/functions/key_import.importPKCS8.md b/docs/functions/key_import.importPKCS8.md
@@ -1,7 +1,5 @@
 # Function: importPKCS8
 
-[key/import](../modules/key_import.md).importPKCS8
-
 ▸ **importPKCS8**(`pkcs8`, `alg`, `options?`): `Promise`<[`KeyLike`](../types/types.KeyLike.md)\>
 
 Imports an PEM-encoded PKCS8 string as a runtime-specific private key representation (KeyObject or CryptoKey).

diff --git a/docs/functions/key_import.importSPKI.md b/docs/functions/key_import.importSPKI.md
@@ -1,7 +1,5 @@
 # Function: importSPKI
 
-[key/import](../modules/key_import.md).importSPKI
-
 ▸ **importSPKI**(`spki`, `alg`, `options?`): `Promise`<[`KeyLike`](../types/types.KeyLike.md)\>
 
 Imports an PEM-encoded SPKI string as a runtime-specific public key representation (KeyObject or CryptoKey).

diff --git a/docs/functions/key_import.importX509.md b/docs/functions/key_import.importX509.md
@@ -1,7 +1,5 @@
 # Function: importX509
 
-[key/import](../modules/key_import.md).importX509
-
 ▸ **importX509**(`x509`, `alg`, `options?`): `Promise`<[`KeyLike`](../types/types.KeyLike.md)\>
 
 Imports the SPKI from an X.509 string certificate as a runtime-specific public key representation (KeyObject or CryptoKey).

diff --git a/docs/functions/util_base64url.decode.md b/docs/functions/util_base64url.decode.md
@@ -1,7 +1,5 @@
 # Function: decode
 
-[util/base64url](../modules/util_base64url.md).decode
-
 ▸ `Const` **decode**(`input`): `Uint8Array`
 
 #### Parameters

diff --git a/docs/functions/util_base64url.encode.md b/docs/functions/util_base64url.encode.md
@@ -1,7 +1,5 @@
 # Function: encode
 
-[util/base64url](../modules/util_base64url.md).encode
-
 ▸ `Const` **encode**(`input`): `string`
 
 #### Parameters

diff --git a/docs/functions/util_decode_protected_header.decodeProtectedHeader.md b/docs/functions/util_decode_protected_header.decodeProtectedHeader.md
@@ -1,7 +1,5 @@
 # Function: decodeProtectedHeader
 
-[util/decode_protected_header](../modules/util_decode_protected_header.md).decodeProtectedHeader
-
 ▸ **decodeProtectedHeader**(`token`): [`ProtectedHeaderParameters`](../types/util_decode_protected_header.ProtectedHeaderParameters.md)
 
 Decodes the Protected Header of a JWE/JWS/JWT token utilizing any JOSE serialization.

diff --git a/docs/functions/util_generate_key_pair.generateKeyPair.md b/docs/functions/util_generate_key_pair.generateKeyPair.md
@@ -1,7 +1,5 @@
 # Function: generateKeyPair
 
-[util/generate_key_pair](../modules/util_generate_key_pair.md).generateKeyPair
-
 ▸ **generateKeyPair**(`alg`, `options?`): `Promise`<[`GenerateKeyPairResult`](../interfaces/util_generate_key_pair.GenerateKeyPairResult.md)\>
 
 Generates a private and a public key for a given JWA algorithm identifier.