Skip to content

Commit

Permalink
Update @since annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
NSeydoux committed Dec 21, 2024
1 parent bf84a4c commit 2a37441
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions src/common/getters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ function deserializeBoolean(serialized: Literal): boolean | undefined {
*
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the custom boolean field with the provided name
* @since unreleased
* @since 3.2.0
*/
export function getCustomBoolean(
accessCredential: DatasetWithId,
Expand Down Expand Up @@ -573,7 +573,7 @@ function deserializeFloat(serialized: Literal): number | undefined {
*
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the custom float field with the provided name
* @since unreleased
* @since 3.2.0
*/
export function getCustomFloat(
accessCredential: DatasetWithId,
Expand Down Expand Up @@ -611,7 +611,7 @@ function deserializeInteger(serialized: Literal): number | undefined {
*
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the custom integer field with the provided name
* @since unreleased
* @since 3.2.0
*/
export function getCustomInteger(
accessCredential: DatasetWithId,
Expand Down Expand Up @@ -646,7 +646,7 @@ export function getCustomInteger(
*
* @param accessCredential The Access Credential (Access Grant or Access Request)
* @returns the custom string field with the provided name
* @since unreleased
* @since 3.2.0
*/
export function getCustomString(
accessCredential: DatasetWithId,
Expand Down Expand Up @@ -717,7 +717,7 @@ const WELL_KNOWN_FIELDS = [
*
* @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
* @since 3.2.0
*/
export function getCustomFields(
accessCredential: DatasetWithId,
Expand Down
4 changes: 2 additions & 2 deletions src/gConsent/query/query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ function toQueryUrl(endpoint: URL, filter: CredentialFilter): URL {
* @param filter The query filter
* @param options Query options
* @returns a paginated set of Access Credentials matching the given filter
* @since unreleased
* @since 3.2.0
*
* @example
* ```
Expand Down Expand Up @@ -274,7 +274,7 @@ export async function query(
* @param filter The query filter
* @param options Query options
* @returns an async iterator going through the result pages
* @since unreleased
* @since 3.2.0
*
* @example
* ```
Expand Down
2 changes: 1 addition & 1 deletion src/resource/deleteFile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import { fetchWithVc } from "../fetch";
* @param options Optional properties to customise the request behaviour.
* @returns A promise that resolves to a SolidDataset if successful, and that
* rejects otherwise.
* @since unreleased
* @since 2.4.0
*/
export async function deleteFile(
fileUrl: UrlString,
Expand Down
2 changes: 1 addition & 1 deletion src/resource/deleteSolidDataset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import { fetchWithVc } from "../fetch";
* @param options Optional properties to customise the request behaviour.
* @returns A promise that resolves to a SolidDataset if successful, and that
* rejects otherwise.
* @since unreleased
* @since 2.4.0
*/
export async function deleteSolidDataset(
datasetUrl: UrlString,
Expand Down

0 comments on commit 2a37441

Please sign in to comment.