Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
lambdalisue committed Aug 21, 2024
1 parent e7d16fc commit 320f5ee
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion as/optional.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export function asOptional<P extends Predicate<unknown>>(
/**
* Unannotate the annotated predicate function with {@linkcode asOptional}.
*
* Use this function to unannotate a predicate function of `predObj` in {@linkcode isObjectOf}.
* Use this function to unannotate a predicate function of `predObj` in {@linkcode [jsr:@core/unknownutil/is/object-of].isObjectOf}.
*
* Note that the annotated predicate function will return `true` if the type of `x` is `T`, indicating that
* this function is not just for annotation but it also changes the behavior of the predicate function.
Expand Down
4 changes: 2 additions & 2 deletions as/readonly.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
/**
* Annotate the given predicate function as readonly.
*
* Use this function to annotate a predicate function of `predObj` in {@linkcode isObjectOf}.
* Use this function to annotate a predicate function of `predObj` in {@linkcode https://jsr.io/@core/unknownutil/doc/is/object-of/~/isObjectOf|isObjectOf}.
*
* Use {@linkcode asUnreadonly} to remove the annotation.
* Use {@linkcode hasReadonly} to check if a predicate function has annotated with this function.
Expand Down Expand Up @@ -45,7 +45,7 @@ export function asReadonly<P extends Predicate<unknown>>(
/**
* Unannotate the annotated predicate function with {@linkcode asReadonly}.
*
* Use this function to unannotate a predicate function of `predObj` in {@linkcode isObjectOf}.
* Use this function to unannotate a predicate function of `predObj` in {@linkcode [jsr:@core/unknownutil/is/object-of].isObjectOf}.
*
* To enhance performance, users are advised to cache the return value of this function and mitigate the creation cost.
*
Expand Down

0 comments on commit 320f5ee

Please sign in to comment.