Skip to content

Commit

Permalink
docs: update other alias function
Browse files Browse the repository at this point in the history
  • Loading branch information
ppeeou committed Nov 25, 2024
1 parent 095ef55 commit ba03a78
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion src/head.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ type HeadReturnType<T> = T extends readonly [a: infer H, ...rest: any[]]
: never;

/**
* Returns the first element of Iterable/AsyncIterable. (head)
* Returns the first element of Iterable/AsyncIterable.
*
* There is another alias function called `first`.
*
* @example
* ```ts
Expand Down
4 changes: 3 additions & 1 deletion src/includes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ import some from "./some";
import type ReturnValueType from "./types/ReturnValueType";

/**
* Checks if the specified value is equal. (contains)
* Checks if the specified value is equal.
*
* There is another alias function called `contains`.
*
* @example
* ```ts
Expand Down

0 comments on commit ba03a78

Please sign in to comment.