Skip to content

Commit 09e650c

Browse files
refactor(isInstance): change parameter name and update jsdoc
1 parent d4ddc54 commit 09e650c

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

src/is/lib/is-instance.func.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import { IsInstance } from '../type/is-instance.type';
99
import { ResultCallback } from '../../type/result-callback.type';
1010
/**
1111
* Checks if any `value` is an `object` of a generic `Obj` type and an `instance` of `Constructor` type.
12-
* @param value Any `value` to compare with the `constructor`.
12+
* @param value Any `value` to be an instance of the `constructor`.
1313
* @param constructor A class or function that specifies the type of the `constructor`.
14-
* @param callback `ResultCallback` function to handle result before returns.
14+
* @param callback A `ResultCallback` function to handle the result before returns.
1515
* @returns A `boolean` indicating whether or not the `value` is an instance of a generic `Obj`.
1616
*/
1717
export const isInstance: IsInstance =

src/is/type/is-instance.type.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
import { Constructor } from '../../type/constructor.type';
22
import { ResultCallback } from '../../type/result-callback.type';
3-
export type IsInstance = <Obj>(value: any, instance: Constructor<Obj>, callback?: ResultCallback) => value is Obj;
3+
export type IsInstance = <Obj>(value: any, constructor: Constructor<Obj>, callback?: ResultCallback) => value is Obj;

0 commit comments

Comments
 (0)