Skip to content

Commit

Permalink
docs: update various comments and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed Sep 15, 2024
1 parent d78f090 commit 9c3f1ed
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/interfaces/GenerateKeyPairOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Support from the community to continue maintaining and improving this module is

`optional` **crv**: `"Ed25519"` \| `"Ed448"`

(EdDSA algorithms only) The EdDSA sub-type. Default is `Ed25519`.
(EdDSA algorithm only) The EdDSA sub-type. Default is `Ed25519`.

***

Expand Down
4 changes: 2 additions & 2 deletions docs/variables/customFetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Support from the community to continue maintaining and improving this module is
`const` **customFetch**: unique `symbol`

When configured on an interface that extends [HttpRequestOptions](../interfaces/HttpRequestOptions.md), this applies to `options`
parameter for functions that trigger HTTP requests, this replaces the use of global fetch. As a
fetch replacement the arguments and expected return are the same as fetch.
parameter for functions that may trigger HTTP requests, this replaces the use of global fetch. As
a fetch replacement the arguments and expected return are the same as fetch.

In theory any module that claims to be compatible with the Fetch API can be used but your mileage
may vary. No workarounds to allow use of non-conform [Response](https://developer.mozilla.org/docs/Web/API/Response)s will be considered.
Expand Down
2 changes: 1 addition & 1 deletion docs/variables/jwksCache.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ their code's invocations. Use in runtimes where an in memory cache between reque
is not desirable.

When configured on an interface that extends [JWKSCacheOptions](../interfaces/JWKSCacheOptions.md), this applies to `options`
parameter for functions that trigger HTTP requests for the
parameter for functions that may trigger HTTP requests to
[`as.jwks_uri`](../interfaces/AuthorizationServer.md#jwks_uri), this allows the passed in object to:

- Serve as an initial value for the JSON Web Key Set that the module would otherwise need to
Expand Down
8 changes: 4 additions & 4 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,8 @@ export const clockTolerance: unique symbol = Symbol()

/**
* When configured on an interface that extends {@link HttpRequestOptions}, this applies to `options`
* parameter for functions that trigger HTTP requests, this replaces the use of global fetch. As a
* fetch replacement the arguments and expected return are the same as fetch.
* parameter for functions that may trigger HTTP requests, this replaces the use of global fetch. As
* a fetch replacement the arguments and expected return are the same as fetch.
*
* In theory any module that claims to be compatible with the Fetch API can be used but your mileage
* may vary. No workarounds to allow use of non-conform {@link !Response}s will be considered.
Expand Down Expand Up @@ -337,7 +337,7 @@ export const customFetch: unique symbol = Symbol()
* is not desirable.
*
* When configured on an interface that extends {@link JWKSCacheOptions}, this applies to `options`
* parameter for functions that trigger HTTP requests for the
* parameter for functions that may trigger HTTP requests to
* {@link AuthorizationServer.jwks_uri `as.jwks_uri`}, this allows the passed in object to:
*
* - Serve as an initial value for the JSON Web Key Set that the module would otherwise need to
Expand Down Expand Up @@ -4370,7 +4370,7 @@ export interface GenerateKeyPairOptions {
modulusLength?: number

/**
* (EdDSA algorithms only) The EdDSA sub-type. Default is `Ed25519`.
* (EdDSA algorithm only) The EdDSA sub-type. Default is `Ed25519`.
*/
crv?: 'Ed25519' | 'Ed448'
}
Expand Down

0 comments on commit 9c3f1ed

Please sign in to comment.