Skip to content

Commit

Permalink
docs: update JWK docs
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed Sep 14, 2024
1 parent 708a010 commit 3f7b08d
Show file tree
Hide file tree
Showing 16 changed files with 260 additions and 248 deletions.
22 changes: 11 additions & 11 deletions docs/interfaces/types.CompactJWEHeaderParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,87 +31,87 @@ Recognized Compact JWE Header Parameters, any other Header Members may also be p

**alg**: `string`

JWE "alg" (Algorithm) Header Parameter.
JWE "alg" (Algorithm) Header Parameter

___

### enc

**enc**: `string`

JWE "enc" (Encryption Algorithm) Header Parameter.
JWE "enc" (Encryption Algorithm) Header Parameter

___

### crit

`Optional` **crit**: `string`[]

JWE "crit" (Critical) Header Parameter.
JWE "crit" (Critical) Header Parameter

___

### cty

`Optional` **cty**: `string`

"cty" (Content Type) Header Parameter.
"cty" (Content Type) Header Parameter

___

### jku

`Optional` **jku**: `string`

"jku" (JWK Set URL) Header Parameter.
"jku" (JWK Set URL) Header Parameter

___

### jwk

`Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"kty"`` \| ``"crv"`` \| ``"e"`` \| ``"n"``\>

"jwk" (JSON Web Key) Header Parameter.
"jwk" (JSON Web Key) Header Parameter

___

### kid

`Optional` **kid**: `string`

"kid" (Key ID) Header Parameter.
"kid" (Key ID) Header Parameter

___

### typ

`Optional` **typ**: `string`

"typ" (Type) Header Parameter.
"typ" (Type) Header Parameter

___

### x5c

`Optional` **x5c**: `string`[]

"x5c" (X.509 Certificate Chain) Header Parameter.
"x5c" (X.509 Certificate Chain) Header Parameter

___

### x5t

`Optional` **x5t**: `string`

"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter.
"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter

___

### x5u

`Optional` **x5u**: `string`

"x5u" (X.509 URL) Header Parameter.
"x5u" (X.509 URL) Header Parameter

___

Expand Down
20 changes: 10 additions & 10 deletions docs/interfaces/types.CompactJWSHeaderParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Recognized Compact JWS Header Parameters, any other Header Members may also be p

**alg**: `string`

JWS "alg" (Algorithm) Header Parameter.
JWS "alg" (Algorithm) Header Parameter

___

Expand All @@ -47,68 +47,68 @@ ___

`Optional` **crit**: `string`[]

JWS "crit" (Critical) Header Parameter.
JWS "crit" (Critical) Header Parameter

___

### cty

`Optional` **cty**: `string`

"cty" (Content Type) Header Parameter.
"cty" (Content Type) Header Parameter

___

### jku

`Optional` **jku**: `string`

"jku" (JWK Set URL) Header Parameter.
"jku" (JWK Set URL) Header Parameter

___

### jwk

`Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"kty"`` \| ``"crv"`` \| ``"e"`` \| ``"n"``\>

"jwk" (JSON Web Key) Header Parameter.
"jwk" (JSON Web Key) Header Parameter

___

### kid

`Optional` **kid**: `string`

"kid" (Key ID) Header Parameter.
"kid" (Key ID) Header Parameter

___

### typ

`Optional` **typ**: `string`

"typ" (Type) Header Parameter.
"typ" (Type) Header Parameter

___

### x5c

`Optional` **x5c**: `string`[]

"x5c" (X.509 Certificate Chain) Header Parameter.
"x5c" (X.509 Certificate Chain) Header Parameter

___

### x5t

`Optional` **x5t**: `string`

"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter.
"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter

___

### x5u

`Optional` **x5u**: `string`

"x5u" (X.509 URL) Header Parameter.
"x5u" (X.509 URL) Header Parameter
22 changes: 11 additions & 11 deletions docs/interfaces/types.JWEHeaderParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,87 +31,87 @@ Recognized JWE Header Parameters, any other Header members may also be present.

`Optional` **alg**: `string`

JWE "alg" (Algorithm) Header Parameter.
JWE "alg" (Algorithm) Header Parameter

___

### crit

`Optional` **crit**: `string`[]

JWE "crit" (Critical) Header Parameter.
JWE "crit" (Critical) Header Parameter

___

### cty

`Optional` **cty**: `string`

"cty" (Content Type) Header Parameter.
"cty" (Content Type) Header Parameter

___

### enc

`Optional` **enc**: `string`

JWE "enc" (Encryption Algorithm) Header Parameter.
JWE "enc" (Encryption Algorithm) Header Parameter

___

### jku

`Optional` **jku**: `string`

"jku" (JWK Set URL) Header Parameter.
"jku" (JWK Set URL) Header Parameter

___

### jwk

`Optional` **jwk**: [`Pick`]( https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys )\<[`JWK`](types.JWK.md), ``"x"`` \| ``"y"`` \| ``"kty"`` \| ``"crv"`` \| ``"e"`` \| ``"n"``\>

"jwk" (JSON Web Key) Header Parameter.
"jwk" (JSON Web Key) Header Parameter

___

### kid

`Optional` **kid**: `string`

"kid" (Key ID) Header Parameter.
"kid" (Key ID) Header Parameter

___

### typ

`Optional` **typ**: `string`

"typ" (Type) Header Parameter.
"typ" (Type) Header Parameter

___

### x5c

`Optional` **x5c**: `string`[]

"x5c" (X.509 Certificate Chain) Header Parameter.
"x5c" (X.509 Certificate Chain) Header Parameter

___

### x5t

`Optional` **x5t**: `string`

"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter.
"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter

___

### x5u

`Optional` **x5u**: `string`

"x5u" (X.509 URL) Header Parameter.
"x5u" (X.509 URL) Header Parameter

___

Expand Down
Loading

0 comments on commit 3f7b08d

Please sign in to comment.