Skip to content

Commit

Permalink
fixup! Align param names with TSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
NSeydoux committed Dec 9, 2024
1 parent ace91b1 commit 07e4429
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/common/getters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ export function getCustomBooleans(
* const s = getCustomBoolean(accessRequest, new URL("https://example.org/ns/customBoolean"));
* ```
*
* @param accessCredential The Access Credential (Access Grant or Access request)
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the value of the custom field with the provided name if it is a boolean, undefined otherwise.
* @since unreleased
*/
Expand Down Expand Up @@ -611,7 +611,7 @@ function deserizalizeDouble(serialized: Literal): number | undefined {
* const d = getCustomDoubles(accessRequest, new URL("https://example.org/ns/customDouble"));
* ```
*
* @param accessCredential The Access Credential (Access Grant or Access request)
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the value of the custom field with the provided name if it is a boolean, undefined otherwise.
* @since unreleased
*/
Expand Down Expand Up @@ -645,7 +645,7 @@ export function getCustomDoubles(
* const d = getCustomDouble(accessRequest, new URL("https://example.org/ns/customDouble"));
* ```
*
* @param accessCredential The Access Credential (Access Grant or Access request)
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the value of the custom field with the provided name if it is a boolean, undefined otherwise.
* @since unreleased
*/
Expand Down Expand Up @@ -687,7 +687,7 @@ function deserizalizeInteger(serialized: Literal): number | undefined {
* const i = getCustomIntegers(accessRequest, new URL("https://example.org/ns/customInteger"));
* ```
*
* @param accessCredential The Access Credential (Access Grant or Access request)
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the value of the custom field with the provided name if it is a boolean, undefined otherwise.
* @since unreleased
*/
Expand Down Expand Up @@ -721,7 +721,7 @@ export function getCustomIntegers(
* const i = getCustomString(accessRequest, new URL("https://example.org/ns/customInteger"));
* ```
*
* @param accessCredential The Access Credential (Access Grant or Access request)
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the value of the custom field with the provided name if it is a boolean, undefined otherwise.
* @since unreleased
*/
Expand Down Expand Up @@ -755,7 +755,7 @@ export function getCustomInteger(
* const s = getCustomStrings(accessRequest, new URL("https://example.org/ns/customString"));
* ```
*
* @param accessCredential The Access Credential (Access Grant or Access request)
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the value of the custom field with the provided name if it is a string, undefined otherwise.
* @since unreleased
*/
Expand All @@ -781,7 +781,7 @@ export function getCustomStrings(vc: DatasetWithId, field: URL): string[] {
* const s = getCustomString(accessRequest, new URL("https://example.org/ns/customString"));
* ```
*
* @param accessCredential The Access Credential (Access Grant or Access request)
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the value of the custom field with the provided name if it is a string, undefined otherwise.
* @since unreleased
*/
Expand Down Expand Up @@ -843,7 +843,7 @@ const WELL_KNOWN_KEYS = [
* const i = customFields["https://example.org/ns/custominteger"];
* ```
*
* @param accessCredential The Access Credential (Access Grant or Access request)
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns an object keyed by the custom fields names, associated to their values.
* @since unreleased
*/
Expand Down

0 comments on commit 07e4429

Please sign in to comment.